mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-01-13 08:40:42 +08:00
Update 2021-02-16T15:54:54.534Z
This commit is contained in:
Matthew Little
@@ -1,17 +0,0 @@
|
||||
{
|
||||
"limit": 20,
|
||||
"offset": 0,
|
||||
"total": 0,
|
||||
"results": [
|
||||
{
|
||||
"event_index": 0,
|
||||
"event_type": "stx_asset",
|
||||
"asset": {
|
||||
"asset_event_type": "transfer",
|
||||
"sender": "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
|
||||
"recipient": "ST2TJRHDHMYBQ417HFB0BDX430TQA5PXRX6495G1V",
|
||||
"amount": "500000"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns address assets","title":"AddressAssetsListResponse","type":"object","required":["results","limit","offset","total"],"properties":{"limit":{"type":"integer","maximum":30},"offset":{"type":"integer"},"total":{"type":"integer"},"results":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEvent","oneOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventSmartContractLog","description":"Only present in `smart_contract` and `contract_call` tx types.","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","contract_log"],"properties":{"event_type":{"type":"string","enum":["smart_contract_log"]},"contract_log":{"type":"object","additionalProperties":false,"required":["contract_id","topic","value"],"properties":{"contract_id":{"type":"string"},"topic":{"type":"string"},"value":{"type":"object","additionalProperties":false,"required":["hex","repr"],"properties":{"hex":{"type":"string"},"repr":{"type":"string"}}}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventStxLock","description":"Only present in `smart_contract` and `contract_call` tx types.","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","stx_lock_event"],"properties":{"event_type":{"type":"string","enum":["stx_lock"]},"stx_lock_event":{"type":"object","additionalProperties":false,"required":["locked_amount","unlock_height","locked_address"],"properties":{"locked_amount":{"type":"string"},"unlock_height":{"type":"integer"},"locked_address":{"type":"string"}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventStxAsset","description":"Only present in `smart_contract` and `contract_call` tx types.","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","asset"],"properties":{"event_type":{"type":"string","enum":["stx_asset"]},"asset":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventAsset","additionalProperties":false,"properties":{"asset_event_type":{"$schema":"http://json-schema.org/draft-07/schema#","title":"TransactionEventAssetType","type":"string","enum":["transfer","mint","burn"]},"asset_id":{"type":"string"},"sender":{"type":"string"},"recipient":{"type":"string"},"amount":{"type":"string"},"value":{"type":"string"}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventFungibleAsset","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","asset"],"properties":{"event_type":{"type":"string","enum":["fungible_token_asset"]},"asset":{"type":"object","additionalProperties":false,"required":["asset_event_type","asset_id","sender","recipient","amount"],"properties":{"asset_event_type":{"type":"string"},"asset_id":{"type":"string"},"sender":{"type":"string"},"recipient":{"type":"string"},"amount":{"type":"string"}}}}}]},{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"TransactionEventNonFungibleAsset","allOf":[{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["event_index"],"properties":{"event_index":{"type":"integer"}}},{"type":"object","required":["event_type","asset"],"properties":{"event_type":{"type":"string","enum":["non_fungible_token_asset"]},"asset":{"type":"object","additionalProperties":false,"required":["asset_event_type","asset_id","sender","recipient","value"],"properties":{"asset_event_type":{"type":"string"},"asset_id":{"type":"string"},"sender":{"type":"string"},"recipient":{"type":"string"},"value":{"type":"object","additionalProperties":false,"required":["hex","repr"],"properties":{"hex":{"type":"string"},"repr":{"type":"string"}}}}}}}]}]}}}}
|
||||
@@ -1,14 +0,0 @@
|
||||
{
|
||||
"stx": {
|
||||
"balance": "1000000",
|
||||
"total_sent": "0",
|
||||
"total_received": "1000000",
|
||||
"lock_tx_id": "0xec94e7d20af8979b44d17a0520c126bf742b999a0fc7ddbcbe0ab21b228ecc8c",
|
||||
"locked": "50000",
|
||||
"lock_height": 100,
|
||||
"burnchain_lock_height": 100,
|
||||
"burnchain_unlock_height": 200
|
||||
},
|
||||
"fungible_tokens": {},
|
||||
"non_fungible_tokens": {}
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns address balances","title":"AddressBalanceResponse","type":"object","required":["stx","fungible_tokens","non_fungible_tokens"],"properties":{"stx":{"$schema":"http://json-schema.org/draft-07/schema#","description":"StxBalance","type":"object","additionalProperties":false,"required":["balance","total_sent","total_received","total_fees_sent","total_miner_rewards_received","lock_tx_id","locked","lock_height","burnchain_lock_height","burnchain_unlock_height"],"properties":{"balance":{"type":"string"},"total_sent":{"type":"string"},"total_received":{"type":"string"},"total_fees_sent":{"type":"string"},"total_miner_rewards_received":{"type":"string"},"lock_tx_id":{"type":"string","description":"The transaction where the lock event occurred. Empty if no tokens are locked."},"locked":{"type":"string","description":"The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked."},"lock_height":{"type":"integer","description":"The STX chain block height of when the lock event occurred. Zero if no tokens are locked."},"burnchain_lock_height":{"type":"integer","description":"The burnchain block height of when the lock event occurred. Zero if no tokens are locked."},"burnchain_unlock_height":{"type":"integer","description":"The burnchain block height of when the tokens unlock. Zero if no tokens are locked."}}},"fungible_tokens":{"type":"object","patternProperties":{"*":{"$schema":"http://json-schema.org/draft-07/schema#","description":"FtBalance","type":"object","additionalProperties":false,"required":["balance","total_sent","total_received"],"properties":{"balance":{"type":"string"},"total_sent":{"type":"string"},"total_received":{"type":"string"}}}}},"non_fungible_tokens":{"type":"object","patternProperties":{"*":{"$schema":"http://json-schema.org/draft-07/schema#","description":"NftBalance","type":"object","additionalProperties":false,"required":["count","total_sent","total_received"],"properties":{"count":{"type":"string"},"total_sent":{"type":"string"},"total_received":{"type":"string"}}}}}}}
|
||||
@@ -1,10 +0,0 @@
|
||||
{
|
||||
"balance": "1000000",
|
||||
"total_sent": "0",
|
||||
"total_received": "1000000",
|
||||
"lock_tx_id": "0xec94e7d20af8979b44d17a0520c126bf742b999a0fc7ddbcbe0ab21b228ecc8c",
|
||||
"locked": "50000",
|
||||
"lock_height": 100,
|
||||
"burnchain_lock_height": 100,
|
||||
"burnchain_unlock_height": 200
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns address balances","title":"AddressStxBalanceResponse","type":"object","additionalProperties":false,"required":["balance","total_sent","total_received","total_fees_sent","total_miner_rewards_received","lock_tx_id","locked","lock_height","burnchain_lock_height","burnchain_unlock_height"],"properties":{"balance":{"type":"string"},"total_sent":{"type":"string"},"total_received":{"type":"string"},"total_fees_sent":{"type":"string"},"total_miner_rewards_received":{"type":"string"},"lock_tx_id":{"type":"string","description":"The transaction where the lock event occurred. Empty if no tokens are locked."},"locked":{"type":"string","description":"The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked."},"lock_height":{"type":"integer","description":"The STX chain block height of when the lock event occurred. Zero if no tokens are locked."},"burnchain_lock_height":{"type":"integer","description":"The burnchain block height of when the lock event occurred. Zero if no tokens are locked."},"burnchain_unlock_height":{"type":"integer","description":"The burnchain block height of when the tokens unlock. Zero if no tokens are locked."}}}
|
||||
@@ -1,24 +0,0 @@
|
||||
{
|
||||
"limit": 20,
|
||||
"offset": 0,
|
||||
"total": 4989,
|
||||
"results": [
|
||||
{
|
||||
"tx_id": "0xb16077b94222bc1466396d30df13db460864e85ce929a20aae0a2ac80b31e4e2",
|
||||
"tx_status": "success",
|
||||
"tx_type": "coinbase",
|
||||
"fee_rate": "0",
|
||||
"sender_address": "ST2TJRHDHMYBQ417HFB0BDX430TQA5PXRX6495G1V",
|
||||
"sponsored": false,
|
||||
"post_condition_mode": "deny",
|
||||
"block_hash": "0x83f84f814c1b00ddb672d93b97d06c8326f76746d90a979c12b69e54beb73f69",
|
||||
"block_height": 5603,
|
||||
"burn_block_time": 1594335838,
|
||||
"canonical": true,
|
||||
"tx_index": 0,
|
||||
"coinbase_payload": {
|
||||
"data": "0x0000000000000000000000000000000000000000000000000000000000000000"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
@@ -1,15 +0,0 @@
|
||||
{
|
||||
"limit": 20,
|
||||
"offset": 0,
|
||||
"total": 3275,
|
||||
"results": [
|
||||
{
|
||||
"canonical": true,
|
||||
"height": 3275,
|
||||
"hash": "0xe77ba8cf6bb7c0e4f64adc83356289ed467d31a22354907b4bb814590058430f",
|
||||
"parent_block_hash": "0x75ab21ef25cbff2caa14c27d830ed7886a4d1522e1b6f9e5dc3b59ccf73ed49f",
|
||||
"burn_block_time": 1594233639,
|
||||
"txs": ["0x66557c219c6b0cdb40681ecf79a69f03654d88ef1910651a7db0b078f58af5ca"]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns blocks","additionalProperties":false,"title":"BlockListResponse","type":"object","required":["results","limit","offset","total"],"properties":{"limit":{"type":"integer","maximum":30,"description":"The number of blocks to return"},"offset":{"type":"integer","description":"The number to blocks to skip (starting at `0`)","default":0},"total":{"type":"integer","description":"The number of blocks available"},"results":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"Block","description":"A block","type":"object","required":["canonical","height","hash","parent_block_hash","txs","burn_block_time","burn_block_time_iso","burn_block_hash","burn_block_height","miner_txid"],"properties":{"canonical":{"type":"boolean","description":"Set to `true` if block corresponds to the canonical chain tip"},"height":{"type":"integer","description":"Height of the block"},"hash":{"type":"string","description":"Hash representing the block"},"parent_block_hash":{"type":"string","description":"Hash of the parent block"},"burn_block_time":{"type":"number","description":"Unix timestamp (in seconds) indicating when this block was mined."},"burn_block_time_iso":{"type":"string","description":"An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined."},"burn_block_hash":{"type":"string","description":"Hash of the anchor chain block"},"burn_block_height":{"type":"integer","description":"Height of the anchor chain block"},"miner_txid":{"type":"string","description":"Anchor chain transaction ID"},"txs":{"type":"array","description":"List of transactions included in the block","items":{"type":"string","description":"Transaction ID"}}}}}}}
|
||||
@@ -1,24 +0,0 @@
|
||||
{
|
||||
"limit": 20,
|
||||
"offset": 0,
|
||||
"results": [
|
||||
{
|
||||
"canonical": true,
|
||||
"burn_block_hash": "0x4eaabcd105865e471f697eff5dd5bd85d47ecb5a26a3379d74fae0ae87c40904",
|
||||
"burn_block_height": 331,
|
||||
"burn_amount": "12000",
|
||||
"reward_recipient": "1C56LYirKa3PFXFsvhSESgDy2acEHVAEt6",
|
||||
"reward_amount": "5000",
|
||||
"reward_index": 0
|
||||
},
|
||||
{
|
||||
"canonical": true,
|
||||
"burn_block_hash": "0x4eaabcd105865e471f697eff5dd5bd85d47ecb5a26a3379d74fae0ae87c40904",
|
||||
"burn_block_height": 336,
|
||||
"burn_amount": "14000",
|
||||
"reward_recipient": "1M3bvWB9CRh5BTumeVxtHDEV6W4S2R9AZw",
|
||||
"reward_amount": "2000",
|
||||
"reward_index": 0
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns blocks","additionalProperties":false,"title":"BurnchainRewardListResponse","type":"object","required":["results","limit","offset"],"properties":{"limit":{"type":"integer","maximum":30,"description":"The number of burnchain rewards to return"},"offset":{"type":"integer","description":"The number to burnchain rewards to skip (starting at `0`)","default":0},"results":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"BurnchainReward","description":"Reward payment made on the burnchain","type":"object","required":["canonical","burn_block_hash","burn_block_height","burn_amount","reward_recipient","reward_amount","reward_index"],"properties":{"canonical":{"type":"boolean","description":"Set to `true` if block corresponds to the canonical burchchain tip"},"burn_block_hash":{"type":"string","description":"The hash representing the burnchain block"},"burn_block_height":{"type":"integer","description":"Height of the burnchain block"},"burn_amount":{"type":"string","description":"The total amount of burnchain tokens burned for this burnchain block, in the smallest unit (e.g. satoshis for Bitcoin)"},"reward_recipient":{"type":"string","description":"The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g. B58 encoded for Bitcoin)"},"reward_amount":{"type":"string","description":"The amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin)"},"reward_index":{"type":"integer","description":"The index position of the reward entry, useful for ordering when there's more than one recipient per burnchain block"}}}}}}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"okay": false,
|
||||
"cause": "Unchecked(PublicFunctionNotReadOnly(..."
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"okay": true,
|
||||
"result": "0x111..."
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request to get contract source","title":"ReadOnlyFunctionSuccessResponse","type":"object","additionalProperties":false,"required":["okay"],"properties":{"okay":{"type":"boolean"},"result":{"type":"string"},"cause":{"type":"string"}}}
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"balance": "0x0000000000000000000000000007a120",
|
||||
"locked": "0x0000000000000000000000000007a120",
|
||||
"unlock_height": 126,
|
||||
"nonce": 2867,
|
||||
"balance_proof": "0xabce",
|
||||
"nonce_proof": "0xabcd"
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request for account data","title":"AccountDataResponse","type":"object","additionalProperties":false,"required":["balance","locked","unlock_height","nonce","balance_proof","nonce_proof"],"properties":{"balance":{"type":"string"},"locked":{"type":"string"},"unlock_height":{"type":"integer"},"nonce":{"type":"integer"},"balance_proof":{"type":"string"},"nonce_proof":{"type":"string"}}}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"data": "0x0a0c000000010a6d6f6e737465722d69640100000000000000000000000000000001",
|
||||
"proof": "0x123..."
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"Response of get data map entry request","title":"MapEntryResponse","type":"object","required":["data"],"properties":{"data":{"type":"string","description":"Hex-encoded string of clarity value. It is always an optional tuple."},"proof":{"type":"string","description":"Hex-encoded string of the MARF proof for the data"}}}
|
||||
@@ -1,134 +0,0 @@
|
||||
{
|
||||
"functions": [
|
||||
{
|
||||
"name": "get-value",
|
||||
"access": "public",
|
||||
"args": [
|
||||
{
|
||||
"name": "key",
|
||||
"type": {
|
||||
"buffer": {
|
||||
"length": 32
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"outputs": {
|
||||
"type": {
|
||||
"response": {
|
||||
"ok": {
|
||||
"buffer": {
|
||||
"length": 32
|
||||
}
|
||||
},
|
||||
"error": "int128"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "set-value",
|
||||
"access": "public",
|
||||
"args": [
|
||||
{
|
||||
"name": "key",
|
||||
"type": {
|
||||
"buffer": {
|
||||
"length": 32
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": {
|
||||
"buffer": {
|
||||
"length": 32
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"outputs": {
|
||||
"type": {
|
||||
"response": {
|
||||
"ok": "uint128",
|
||||
"error": "none"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "test-emit-event",
|
||||
"access": "public",
|
||||
"args": [],
|
||||
"outputs": {
|
||||
"type": {
|
||||
"response": {
|
||||
"ok": "uint128",
|
||||
"error": "none"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "test-event-types",
|
||||
"access": "public",
|
||||
"args": [],
|
||||
"outputs": {
|
||||
"type": {
|
||||
"response": {
|
||||
"ok": "uint128",
|
||||
"error": "none"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"variables": [
|
||||
{
|
||||
"name": "recipient",
|
||||
"type": "principal",
|
||||
"access": "constant"
|
||||
},
|
||||
{
|
||||
"name": "sender",
|
||||
"type": "principal",
|
||||
"access": "constant"
|
||||
}
|
||||
],
|
||||
"maps": [
|
||||
{
|
||||
"name": "store",
|
||||
"key": [
|
||||
{
|
||||
"name": "key",
|
||||
"type": {
|
||||
"buffer": {
|
||||
"length": 32
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"value": [
|
||||
{
|
||||
"name": "value",
|
||||
"type": {
|
||||
"buffer": {
|
||||
"length": 32
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"fungible_tokens": [
|
||||
{
|
||||
"name": "novel-token-19"
|
||||
}
|
||||
],
|
||||
"non_fungible_tokens": [
|
||||
{
|
||||
"name": "hello-nft",
|
||||
"type": "uint128"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request to get contract interface","title":"ContractInterfaceResponse","type":"object","required":["functions","variables","maps","fungible_tokens","non_fungible_tokens"],"properties":{"functions":{"type":"array","items":{"type":"object"},"description":"List of defined methods"},"variables":{"type":"array","items":{"type":"object"},"description":"List of defined variables"},"maps":{"type":"array","items":{"type":"object"},"description":"List of defined data-maps"},"fungible_tokens":{"type":"array","items":{"type":"object"},"description":"List of fungible tokens in the contract"},"non_fungible_tokens":{"type":"array","items":{"type":"object"},"description":"List of non-fungible tokens in the contract"}}}
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"source": "(define-constant sender 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR)\n(define-constant recipient 'SM2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQVX8X0G)\n\n(define-fungible-token novel-token-19)\n(begin (ft-mint? novel-token-19 u12 sender))\n(begin (ft-transfer? novel-token-19 u2 sender recipient))\n\n(define-non-fungible-token hello-nft uint)\n(begin (nft-mint? hello-nft u1 sender))\n(begin (nft-mint? hello-nft u2 sender))\n(begin (nft-transfer? hello-nft u1 sender recipient))\n\n(define-public (test-emit-event)\n (begin\n (print \"Event! Hello world\")\n (ok u1)))\n(begin (test-emit-event))\n\n(define-public (test-event-types)\n (begin\n (unwrap-panic (ft-mint? novel-token-19 u3 recipient))\n (unwrap-panic (nft-mint? hello-nft u2 recipient))\n (unwrap-panic (stx-transfer? u60 tx-sender 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR))\n (unwrap-panic (stx-burn? u20 tx-sender))\n (ok u1)))\n\n(define-map store ((key (buff 32))) ((value (buff 32))))\n(define-public (get-value (key (buff 32)))\n (begin\n (match (map-get? store ((key key)))\n entry (ok (get value entry))\n (err 0))))\n(define-public (set-value (key (buff 32)) (value (buff 32)))\n (begin\n (map-set store ((key key)) ((value value)))\n (ok u1)))",
|
||||
"publish_height": 3196,
|
||||
"proof": "0000001104060000001ec4e..."
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request to get contract source","title":"ContractSourceResponse","type":"object","additionalProperties":false,"required":["source","publish_height","proof"],"properties":{"source":{"type":"string"},"publish_height":{"type":"integer"},"proof":{"type":"string"}}}
|
||||
@@ -1 +0,0 @@
|
||||
1
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET fee estimates","title":"CoreNodeFeeResponse","type":"string","additionalProperties":false}
|
||||
@@ -1,15 +0,0 @@
|
||||
{
|
||||
"peer_version": 385875968,
|
||||
"pox_consensus": "17f76e597bab45646956f38dd39573085d72cbc0",
|
||||
"burn_block_height": 16,
|
||||
"stable_pox_consensus": "8e0561978fc5506b68a589c402dad97e862edb59",
|
||||
"stable_burn_block_height": 15,
|
||||
"server_version": "blockstack-core 0.0.1 => 23.0.0.0 (, release build, linux [x86_64])",
|
||||
"network_id": 2147483648,
|
||||
"parent_network_id": 3669344250,
|
||||
"stacks_tip_height": 15,
|
||||
"stacks_tip": "b1807a2d3f7f8c7922f7c1d60d7c34145ade05d789640dc7dc9ec1021e07bb54",
|
||||
"stacks_tip_consensus_hash": "17f76e597bab45646956f38dd39573085d72cbc0",
|
||||
"unanchored_tip": "0000000000000000000000000000000000000000000000000000000000000000",
|
||||
"exit_at_block_height": null
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that core node information","title":"CoreNodeInfoResponse","type":"object","additionalProperties":false,"required":["peer_version","pox_consensus","burn_block_height","stable_pox_consensus","stable_burn_block_height","server_version","network_id","parent_network_id","stacks_tip_height","stacks_tip","stacks_tip_consensus_hash","unanchored_tip","exit_at_block_height"],"properties":{"peer_version":{"type":"integer","description":"identifies the version number for the networking communication, this should not change while a node is running, and will only change if there's an upgrade"},"pox_consensus":{"type":"string","description":"is a hash used to identify the burnchain view for a node. it incorporates bitcoin chain information and PoX information. nodes that disagree on this value will appear to each other as forks. this value will change after every block"},"burn_block_height":{"type":"integer","description":"latest bitcoin chain height"},"stable_pox_consensus":{"type":"string","description":"same as burn_consensus, but evaluated at stable_burn_block_height"},"stable_burn_block_height":{"type":"integer","description":"leftover from stacks 1.0, basically always burn_block_height - 1"},"server_version":{"type":"string","description":"is a version descriptor"},"network_id":{"type":"integer","description":"is similar to peer_version and will be used to differentiate between different testnets. this value will be different between mainnet and testnet. once launched, this value will not change"},"parent_network_id":{"type":"integer","description":"same as network_id, but for bitcoin"},"stacks_tip_height":{"type":"integer","description":"the latest Stacks chain height. Stacks forks can occur independent of the Bitcoin chain, that height doesn't increase 1-to-1 with the Bitcoin height"},"stacks_tip":{"type":"string","description":"the best known block hash for the Stack chain (not including any pending microblocks)"},"stacks_tip_consensus_hash":{"type":"string","description":"the burn chain (i.e., bitcoin) consensus hash at the time that stacks_tip was mined"},"unanchored_tip":{"type":"string","description":"the latest microblock hash if any microblocks were processed. if no microblock has been processed for the current block, a 000.., hex array is returned"},"exit_at_block_height":{"type":"integer","description":"the block height at which the testnet network will be reset. not applicable for mainnet"}}}
|
||||
@@ -1,11 +0,0 @@
|
||||
{
|
||||
"contract_id": "ST000000000000000000002AMW42H.pox",
|
||||
"first_burnchain_block_height": 0,
|
||||
"min_amount_ustx": 150000000000,
|
||||
"registration_window_length": 250,
|
||||
"rejection_fraction": 25,
|
||||
"reward_cycle_id": 0,
|
||||
"reward_cycle_length": 1000,
|
||||
"rejection_votes_left_required": 1000,
|
||||
"total_liquid_supply_ustx": 1000000000
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"Get Proof of Transfer (PoX) information","title":"CoreNodePoxResponse","type":"object","additionalProperties":false,"required":["contract_id","first_burnchain_block_height","min_amount_ustx","registration_window_length","rejection_fraction","reward_cycle_id","reward_cycle_length","rejection_votes_left_required","total_liquid_supply_ustx"],"properties":{"contract_id":{"type":"string"},"first_burnchain_block_height":{"type":"integer"},"min_amount_ustx":{"type":"integer"},"registration_window_length":{"type":"integer"},"rejection_fraction":{"type":"integer"},"reward_cycle_id":{"type":"integer"},"reward_cycle_length":{"type":"integer"},"rejection_votes_left_required":{"type":"integer"},"total_liquid_supply_ustx":{"type":"integer"}}}
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"success": true,
|
||||
"txId": "0xf2f0402f9f4c4d43b382690c4f7b97e24d5ff5dd5c619e3615daa64dca7ef4bc",
|
||||
"txRaw": "80800000000400164247d6f2b425ac5771423ae6c80c754f7172b0000000000000003200000000000000b400008537046ff1008368baaa3ff2235122c556b89dad4f9df0639b924cf32a44b866497e49846b24191e711b21faaae96ca0542e4a140168484740b94211cececb3303020000000000051ab52c45b1a7977204f17ac0b6f48306aea2dbb8e9000000000007a12046617563657400000000000000000000000000000000000000000000000000000000"
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"POST request that runs the faucet","title":"RunFaucetResponse","type":"object","additionalProperties":false,"required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the faucet call was successful"},"txId":{"type":"string","description":"The transaction ID for the faucet call"},"txRaw":{"type":"string","description":"Raw transaction in hex string representation"}}}
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"target_block_time": 600
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that target block time for a given network","title":"NetworkBlockTimeResponse","type":"object","additionalProperties":false,"required":["target_block_time","total_sent","total_received"],"properties":{"target_block_time":{"type":"integer"}}}
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"testnet": {
|
||||
"target_block_time": 120
|
||||
},
|
||||
"mainnet": {
|
||||
"target_block_time": 600
|
||||
}
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns network target block times","title":"NetworkBlockTimesResponse","type":"object","additionalProperties":false,"required":["mainnet","testnet"],"properties":{"mainnet":{"$schema":"http://json-schema.org/draft-07/schema#","description":"TargetBlockTime","type":"object","additionalProperties":false,"required":["target_block_time","total_sent","total_received"],"properties":{"target_block_time":{"type":"integer"}}},"testnet":{"$schema":"http://json-schema.org/draft-07/schema#","description":"TargetBlockTime","type":"object","additionalProperties":false,"required":["target_block_time","total_sent","total_received"],"properties":{"target_block_time":{"type":"integer"}}}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-account-request","type":"object","title":"RosettaAccountBalanceRequest","description":"An AccountBalanceRequest is utilized to make a balance request on the /account/balance endpoint. If the block_identifier is populated, a historical balance query should be performed.","required":["network_identifier","account_identifier"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"account_identifier":{"type":"object","title":"RosettaAccount","description":"The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"sub_account":{"type":"object","title":"RosettaSubAccount","description":"An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to.","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"metadata":{"type":"object","description":"If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients.","required":[]}}},"metadata":{"type":"object","description":"Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata.","required":[]}}},"block_identifier":{"$id":"rosetta-partial-block-identifier.schema.json","type":"object","title":"RosettaPartialBlockIdentifier","description":"When fetching data by BlockIdentifier, it may be possible to only specify the index or hash. If neither property is specified, it is assumed that the client is making a request at the current block.","anyOf":[{"$id":"rosetta-block-identifier-hash.schema.json","type":"object","title":"RosettaBlockIdentifierHash","description":"This is also known as the block hash.","properties":{"hash":{"type":"string","description":"This is also known as the block hash."}}},{"$id":"rosetta-block-identifier-height.schema.json","type":"object","title":"RosettaBlockIdentifierHeight","description":"This is also known as the block height.","properties":{"index":{"type":"integer","description":"This is also known as the block height."}}}]}}}
|
||||
File diff suppressed because one or more lines are too long
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-block-request","type":"object","title":"RosettaBlockRequest","description":"A BlockRequest is utilized to make a block request on the /block endpoint.","required":["network_identifier"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"block_identifier":{"$id":"rosetta-partial-block-identifier.schema.json","type":"object","title":"RosettaPartialBlockIdentifier","description":"When fetching data by BlockIdentifier, it may be possible to only specify the index or hash. If neither property is specified, it is assumed that the client is making a request at the current block.","anyOf":[{"$id":"rosetta-block-identifier-hash.schema.json","type":"object","title":"RosettaBlockIdentifierHash","description":"This is also known as the block hash.","properties":{"hash":{"type":"string","description":"This is also known as the block hash."}}},{"$id":"rosetta-block-identifier-height.schema.json","type":"object","title":"RosettaBlockIdentifierHeight","description":"This is also known as the block height.","properties":{"index":{"type":"integer","description":"This is also known as the block height."}}}]}}}
|
||||
File diff suppressed because one or more lines are too long
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-block-transaction-request.schema.json","type":"object","title":"RosettaBlockTransactionRequest","description":"A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse.","required":["network_identifier","block_identifier","transaction_identifier"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"block_identifier":{"$id":"rosetta-block-identifier.schema.json","title":"RosettaBlockIdentifier","description":"The block_identifier uniquely identifies a block in a particular network.","allOf":[{"required":["hash"],"$id":"rosetta-block-identifier-hash.schema.json","type":"object","title":"RosettaBlockIdentifierHash","description":"This is also known as the block hash.","properties":{"hash":{"type":"string","description":"This is also known as the block hash."}}},{"required":["index"],"$id":"rosetta-block-identifier-height.schema.json","type":"object","title":"RosettaBlockIdentifierHeight","description":"This is also known as the block height.","properties":{"index":{"type":"integer","description":"This is also known as the block height."}}}]},"transaction_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"TransactionIdentifier","description":"The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.","required":["hash"],"properties":{"hash":{"type":"string","description":"Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier."}}}}}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-combine-response","type":"object","title":"RosettaConstructionCombineResponse","description":"RosettaConstructionCombineResponse is returned by /construction/combine. The network payload will be sent directly to the construction/submit endpoint.","required":["signed_transaction"],"properties":{"signed_transaction":{"type":"string","description":"Signed transaction bytes in hex"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"construction-derive-request","type":"object","title":"RosettaConstructionDeriveRequest","description":"Network is provided in the request because some blockchains have different address formats for different networks","required":["network_identifier","public_key"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"public_key":{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-public-key-schema","type":"object","title":"RosettaPublicKey","description":"PublicKey contains a public key byte array for a particular CurveType encoded in hex. Note that there is no PrivateKey struct as this is NEVER the concern of an implementation.","required":["hex_bytes","curve_type"],"properties":{"hex_bytes":{"type":"string","description":"Hex-encoded public key bytes in the format specified by the CurveType."},"curve_type":{"type":"string","description":"CurveType is the type of cryptographic curve associated with a PublicKey.","enum":["secp256k1","edwards25519"]}}},"metadata":{"type":"object"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-derive-response","type":"object","title":"RosettaConstructionDeriveResponse","description":"ConstructionDeriveResponse is returned by the /construction/derive endpoint.","required":["address"],"properties":{"address":{"type":"string","description":"Address in network-specific format."},"metadata":{"type":"object"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-hash-request","type":"object","title":"RosettaConstructionHashRequest","description":"TransactionHash returns the network-specific transaction hash for a signed transaction.","required":["network_identifier","signed_transaction"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"signed_transaction":{"type":"string","description":"Signed transaction"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-hash-response","type":"object","title":"RosettaConstructionHashResponse","description":"TransactionIdentifier contains the transaction_identifier of a transaction that was submitted to either /construction/hash or /construction/submit.","required":["transaction_identifier"],"properties":{"transaction_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"TransactionIdentifier","description":"The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.","required":["hash"],"properties":{"hash":{"type":"string","description":"Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier."}}},"metadata":{"type":"object"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"http://example.com/example.json","type":"object","title":"RosettaConstructionMetadataRequest","description":"A ConstructionMetadataRequest is utilized to get information required to construct a transaction. The Options object used to specify which metadata to return is left purposely unstructured to allow flexibility for implementers. Optionally, the request can also include an array of PublicKeys associated with the AccountIdentifiers returned in ConstructionPreprocessResponse.","required":["network_identifier","options"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"options":{"$id":"rosetta-construction-options","title":"RosettaOptions","type":"object","description":"The options that will be sent directly to /construction/metadata by the caller.","required":[],"properties":{"sender_address":{"type":"string","description":"sender's address "},"type":{"type":"string","description":"Type of operation e.g transfer"},"status":{"type":"string","description":"This value indicates the state of the operations"},"token_transfer_recipient_address":{"type":"string","description":"Recipient's address"},"amount":{"type":"string","description":"Amount to be transfeered."},"symbol":{"type":"string","description":"Currency symbol e.g STX"},"decimals":{"type":"integer","description":"Number of decimal places"},"gas_limit":{"type":"number","description":"Maximum price a user is willing to pay."},"gas_price":{"type":"number","description":"Cost necessary to perform a transaction on the network"},"suggested_fee_multiplier":{"type":"number","description":" A suggested fee multiplier to indicate that the suggested fee should be scaled. This may be used to set higher fees for urgent transactions or to pay lower fees when there is less urgency."},"max_fee":{"type":"string","description":"Maximum fee user is willing to pay"},"fee":{"type":"string","description":"Fee for this transaction"}}},"public_keys":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-public-key-schema","type":"object","title":"RosettaPublicKey","description":"PublicKey contains a public key byte array for a particular CurveType encoded in hex. Note that there is no PrivateKey struct as this is NEVER the concern of an implementation.","required":["hex_bytes","curve_type"],"properties":{"hex_bytes":{"type":"string","description":"Hex-encoded public key bytes in the format specified by the CurveType."},"curve_type":{"type":"string","description":"CurveType is the type of cryptographic curve associated with a PublicKey.","enum":["secp256k1","edwards25519"]}}}}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-metadata-response","type":"object","title":"RosettaConstructionMetadataResponse","description":"The ConstructionMetadataResponse returns network-specific metadata used for transaction construction. Optionally, the implementer can return the suggested fee associated with the transaction being constructed. The caller may use this info to adjust the intent of the transaction or to create a transaction with a different account that can pay the suggested fee. Suggested fee is an array in case fee payment must occur in multiple currencies.","required":["metadata"],"properties":{"metadata":{"type":"object","required":[],"properties":{"account_sequence":{"type":"integer"},"recent_block_hash":{"type":"string"}}},"suggested_fee":{"type":"object","title":"RosettaAmount","description":"Amount is some Value of a Currency. It is considered invalid to specify a Value without a Currency.","required":["value","currency"],"properties":{"value":{"type":"string","description":"Value of the transaction in atomic units represented as an arbitrary-sized signed integer. For example, 1 BTC would be represented by a value of 100000000."},"currency":{"description":"Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins).","title":"RosettaCurrency","type":"object","required":["symbol","decimals"],"properties":{"symbol":{"type":"string","description":"Canonical symbol associated with a currency."},"decimals":{"type":"integer","description":"Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10."},"metadata":{"type":"object","description":"Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token."}}},"metadata":{"type":"object","description":"","required":[]}}}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-parse-request","type":"object","title":"RosettaConstructionParseRequest","description":"Parse is called on both unsigned and signed transactions to understand the intent of the formulated transaction. This is run as a sanity check before signing (after /construction/payloads) and before broadcast (after /construction/combine).","required":["network_identifier","signed","transaction"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"signed":{"type":"boolean","description":"Signed is a boolean indicating whether the transaction is signed."},"transaction":{"type":"string","description":"This must be either the unsigned transaction blob returned by /construction/payloads or the signed transaction blob returned by /construction/combine."}}}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"http://example.com/example.json","type":"object","title":"RosettaConstructionPayloadResponse","description":"RosettaConstructionPayloadResponse is returned by /construction/payloads. It contains an unsigned transaction blob (that is usually needed to construct the a network transaction from a collection of signatures) and an array of payloads that must be signed by the caller.","required":["unsigned_transaction","payloads"],"properties":{"unsigned_transaction":{"type":"string","description":"This is an unsigned transaction blob (that is usually needed to construct the a network transaction from a collection of signatures)"},"payloads":{"type":"array","description":"An array of payloads that must be signed by the caller","items":{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-signing-payload","type":"object","title":"SigningPayload","description":"SigningPayload is signed by the client with the keypair associated with an address using the specified SignatureType. SignatureType can be optionally populated if there is a restriction on the signature scheme that can be used to sign the payload.","required":["hex_bytes"],"properties":{"address":{"type":"string","description":"The network-specific address of the account that should sign the payload."},"account_identifier":{"type":"object","title":"RosettaAccount","description":"The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"sub_account":{"type":"object","title":"RosettaSubAccount","description":"An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to.","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"metadata":{"type":"object","description":"If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients.","required":[]}}},"metadata":{"type":"object","description":"Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata.","required":[]}}},"hex_bytes":{"type":"string"},"signature_type":{"type":"string","description":"SignatureType is the type of a cryptographic signature.","enum":["ecdsa","ecdsa_recovery","ed25519","schnorr_1","schnorr_poseidon"]}}}}}}
|
||||
File diff suppressed because one or more lines are too long
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-preprocess-response","type":"object","title":"RosettaConstructionPreprocessResponse","description":"RosettaConstructionPreprocessResponse contains options that will be sent unmodified to /construction/metadata. If it is not necessary to make a request to /construction/metadata, options should be omitted. Some blockchains require the PublicKey of particular AccountIdentifiers to construct a valid transaction. To fetch these PublicKeys, populate required_public_keys with the AccountIdentifiers associated with the desired PublicKeys. If it is not necessary to retrieve any PublicKeys for construction, required_public_keys should be omitted.","required":[],"properties":{"options":{"$id":"rosetta-construction-options","title":"RosettaOptions","type":"object","description":"The options that will be sent directly to /construction/metadata by the caller.","required":[],"properties":{"sender_address":{"type":"string","description":"sender's address "},"type":{"type":"string","description":"Type of operation e.g transfer"},"status":{"type":"string","description":"This value indicates the state of the operations"},"token_transfer_recipient_address":{"type":"string","description":"Recipient's address"},"amount":{"type":"string","description":"Amount to be transfeered."},"symbol":{"type":"string","description":"Currency symbol e.g STX"},"decimals":{"type":"integer","description":"Number of decimal places"},"gas_limit":{"type":"number","description":"Maximum price a user is willing to pay."},"gas_price":{"type":"number","description":"Cost necessary to perform a transaction on the network"},"suggested_fee_multiplier":{"type":"number","description":" A suggested fee multiplier to indicate that the suggested fee should be scaled. This may be used to set higher fees for urgent transactions or to pay lower fees when there is less urgency."},"max_fee":{"type":"string","description":"Maximum fee user is willing to pay"},"fee":{"type":"string","description":"Fee for this transaction"}}},"required_public_keys":{"type":"array","items":{"type":"object","title":"RosettaAccount","description":"The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"sub_account":{"type":"object","title":"RosettaSubAccount","description":"An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to.","required":["address"],"properties":{"address":{"type":"string","description":"The address may be a cryptographic public key (or some encoding of it) or a provided username."},"metadata":{"type":"object","description":"If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients.","required":[]}}},"metadata":{"type":"object","description":"Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata.","required":[]}}}}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-submit-request","type":"object","title":"RosettaConstructionSubmitRequest","description":"Submit the transaction in blockchain","required":["network_identifier","signed_transaction"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"signed_transaction":{"type":"string","description":"Signed transaction"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-construction-submit-response","type":"object","title":"RosettaConstructionSubmitResponse","description":"TransactionIdentifier contains the transaction_identifier of a transaction that was submitted to either /construction/submit.","required":["transaction_identifier"],"properties":{"transaction_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"TransactionIdentifier","description":"The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.","required":["hash"],"properties":{"hash":{"type":"string","description":"Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier."}}},"metadata":{"type":"object"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"RosettaMempoolRequest","description":"Get all Transaction Identifiers in the mempool","required":["network_identifier"],"properties":{"network_identifier":{"description":"The network_identifier specifies which network a particular object is associated with.","$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"metadata":{"type":"object"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"RosettaMempoolResponse","description":"A MempoolResponse contains all transaction identifiers in the mempool for a particular network_identifier.","required":["transaction_identifiers"],"properties":{"transaction_identifiers":{"type":"array","description":"","items":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"TransactionIdentifier","description":"The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.","required":["hash"],"properties":{"hash":{"type":"string","description":"Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier."}}}},"metadata":{"type":"object"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-mempool-transaction-request","type":"object","title":"RosettaMempoolTransactionRequest","description":"A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool.","required":["network_identifier","transaction_identifier"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"transaction_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"TransactionIdentifier","description":"The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.","required":["hash"],"properties":{"hash":{"type":"string","description":"Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier."}}}}}
|
||||
File diff suppressed because one or more lines are too long
@@ -1,62 +0,0 @@
|
||||
{
|
||||
"transaction": {
|
||||
"transaction_identifier": {
|
||||
"hash": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f"
|
||||
},
|
||||
"operations": [
|
||||
{
|
||||
"operation_identifier": {
|
||||
"index": 1,
|
||||
"network_index": 0
|
||||
},
|
||||
"related_operations": [
|
||||
{
|
||||
"index": 0,
|
||||
"operation_identifier": {
|
||||
"index": 0
|
||||
}
|
||||
}
|
||||
],
|
||||
"type": "Transfer",
|
||||
"status": "Reverted",
|
||||
"account": {
|
||||
"address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
|
||||
"sub_account": {
|
||||
"address": "0x6b175474e89094c44da98b954eedeac495271d0f",
|
||||
"metadata": {}
|
||||
},
|
||||
"metadata": {}
|
||||
},
|
||||
"amount": {
|
||||
"value": "1238089899992",
|
||||
"currency": {
|
||||
"symbol": "BTC",
|
||||
"decimals": 8,
|
||||
"metadata": {
|
||||
"Issuer": "Satoshi"
|
||||
}
|
||||
},
|
||||
"metadata": {}
|
||||
},
|
||||
"coin_change": {
|
||||
"coin_identifier": {
|
||||
"identifier": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f:1"
|
||||
},
|
||||
"coin_action": "coin_created"
|
||||
},
|
||||
"metadata": {
|
||||
"asm": "304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd01 03301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2",
|
||||
"hex": "48304502201fd8abb11443f8b1b9a04e0495e0543d05611473a790c8939f089d073f90509a022100f4677825136605d732e2126d09a2d38c20c75946cd9fc239c0497e84c634e3dd012103301a8259a12e35694cc22ebc45fee635f4993064190f6ce96e7fb19a03bb6be2"
|
||||
}
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"size": 12378,
|
||||
"lockTime": 1582272577
|
||||
}
|
||||
},
|
||||
"metadata": {
|
||||
"descendant_fees": 123923,
|
||||
"ancestor_count": 2
|
||||
}
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-network-list-request","type":"object","title":"RosettaNetworkListRequest","description":"This endpoint returns a list of NetworkIdentifiers that the Rosetta server supports.","required":[],"properties":{"metadata":{"type":"object","description":"A MetadataRequest is utilized in any request where the only argument is optional metadata.","required":[]}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-network-list-response.schema.json","type":"object","title":"RosettaNetworkListResponse","description":"A NetworkListResponse contains all NetworkIdentifiers that the node can serve information for.","required":["network_identifiers"],"properties":{"network_identifiers":{"type":"array","description":"The network_identifier specifies which network a particular object is associated with.","items":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}}}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"Rosetta-options-request","type":"object","title":"RosettaOptionsRequest","description":"This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network.","required":["network_identifier"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"metadata":{"type":"object"}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-network-options-response","type":"object","title":"RosettaNetworkOptionsResponse","description":"NetworkOptionsResponse contains information about the versioning of the node and the allowed operation statuses, operation types, and errors.","required":["version","allow"],"properties":{"version":{"type":"object","description":"The Version object is utilized to inform the client of the versions of different components of the Rosetta implementation.","required":["rosetta_version","node_version"],"properties":{"rosetta_version":{"type":"string","description":"The rosetta_version is the version of the Rosetta interface the implementation adheres to. This can be useful for clients looking to reliably parse responses."},"node_version":{"type":"string","description":"The node_version is the canonical version of the node runtime. This can help clients manage deployments."},"middleware_version":{"type":"string","description":"When a middleware server is used to adhere to the Rosetta interface, it should return its version here. This can help clients manage deployments."},"metadata":{"type":"object","description":"Any other information that may be useful about versioning of dependent services should be returned here."}}},"allow":{"type":"object","description":"Allow specifies supported Operation status, Operation types, and all possible error statuses. This Allow object is used by clients to validate the correctness of a Rosetta Server implementation. It is expected that these clients will error if they receive some response that contains any of the above information that is not specified here.","required":["operation_statuses","operation_types","errors","historical_balance_lookup"],"properties":{"operation_statuses":{"type":"array","description":"All Operation.Status this implementation supports. Any status that is returned during parsing that is not listed here will cause client validation to error.","items":{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-operation-statuses.schema.json","type":"object","title":"RosettaOperationStatus","description":"OperationStatus is utilized to indicate which Operation status are considered successful.","required":["status","successful"],"properties":{"status":{"type":"string","description":"The status is the network-specific status of the operation."},"successful":{"type":"boolean","description":"An Operation is considered successful if the Operation.Amount should affect the Operation.Account. Some blockchains (like Bitcoin) only include successful operations in blocks but other blockchains (like Ethereum) include unsuccessful operations that incur a fee. To reconcile the computed balance from the stream of Operations, it is critical to understand which Operation.Status indicate an Operation is successful and should affect an Account."}}}},"operation_types":{"type":"array","description":"All Operation.Type this implementation supports. Any type that is returned during parsing that is not listed here will cause client validation to error.","items":{"anyOf":[{"type":"string"}]}},"errors":{"type":"array","description":"All Errors that this implementation could return. Any error that is returned during parsing that is not listed here will cause client validation to error.","items":{"$schema":"http://json-schema.org/draft-07/schema","$id":"Rosetta-errors","type":"object","title":"RosettaError","description":"Instead of utilizing HTTP status codes to describe node errors (which often do not have a good analog), rich errors are returned using this object. Both the code and message fields can be individually used to correctly identify an error. Implementations MUST use unique values for both fields.","required":["code","message","retriable"],"properties":{"code":{"type":"integer","description":"Code is a network-specific error code. If desired, this code can be equivalent to an HTTP status code."},"message":{"type":"string","description":"Message is a network-specific error message. The message MUST NOT change for a given code. In particular, this means that any contextual information should be included in the details field."},"retriable":{"type":"boolean","description":"An error is retriable if the same request may succeed if submitted again."},"details":{"type":"object","description":"Often times it is useful to return context specific to the request that caused the error (i.e. a sample of the stack trace or impacted account) in addition to the standard error message.","required":[],"properties":{"address":{"type":"string"},"error":{"type":"string"}}}}}},"historical_balance_lookup":{"type":"boolean","description":"Any Rosetta implementation that supports querying the balance of an account at any height in the past should set this to true."}}}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"Rosetta-status-request","type":"object","title":"RosettaStatusRequest","description":"This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here.","required":["network_identifier"],"properties":{"network_identifier":{"$schema":"http://json-schema.org/draft-07/schema","type":"object","title":"NetworkIdentifier","description":"The network_identifier specifies which network a particular object is associated with.","required":["blockchain","network"],"properties":{"blockchain":{"type":"string","description":"Blockchain name"},"network":{"type":"string","description":"If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet."},"sub_network_identifier":{"type":"object","description":"In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.","required":["network"],"properties":{"network":{"type":"string","description":"Netowork name"},"metadata":{"type":"object","description":"Meta data from subnetwork identifier","required":["producer"],"properties":{"producer":{"type":"string","description":"producer"}}}}}}},"metadata":{"type":"object","description":"","required":[]}}}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema","$id":"rosetta-network-status-response.schema.json","type":"object","title":"RosettaNetworkStatusResponse","description":"NetworkStatusResponse contains basic information about the node's view of a blockchain network. It is assumed that any BlockIdentifier.Index less than or equal to CurrentBlockIdentifier.Index can be queried. If a Rosetta implementation prunes historical state, it should populate the optional oldest_block_identifier field with the oldest block available to query. If this is not populated, it is assumed that the genesis_block_identifier is the oldest queryable block. If a Rosetta implementation performs some pre-sync before it is possible to query blocks, sync_status should be populated so that clients can still monitor healthiness. Without this field, it may appear that the implementation is stuck syncing and needs to be terminated.","required":["current_block_identifier","current_block_timestamp","genesis_block_identifier","peers"],"properties":{"current_block_identifier":{"$id":"rosetta-block-identifier.schema.json","title":"RosettaBlockIdentifier","description":"The block_identifier uniquely identifies a block in a particular network.","allOf":[{"required":["hash"],"$id":"rosetta-block-identifier-hash.schema.json","type":"object","title":"RosettaBlockIdentifierHash","description":"This is also known as the block hash.","properties":{"hash":{"type":"string","description":"This is also known as the block hash."}}},{"required":["index"],"$id":"rosetta-block-identifier-height.schema.json","type":"object","title":"RosettaBlockIdentifierHeight","description":"This is also known as the block height.","properties":{"index":{"type":"integer","description":"This is also known as the block height."}}}]},"current_block_timestamp":{"type":"integer","description":"The timestamp of the block in milliseconds since the Unix Epoch. The timestamp is stored in milliseconds because some blockchains produce blocks more often than once a second."},"genesis_block_identifier":{"$id":"rosetta-block-genesis-identifier.schema.json","type":"object","title":"RosettaGenesisBlockIdentifier","description":"The block_identifier uniquely identifies a block in a particular network.","required":["index","hash"],"properties":{"index":{"type":"integer","description":"This is also known as the block height."},"hash":{"type":"string","description":"Block hash"}}},"oldest_block_identifier":{"$id":"rosetta-block-oldest-identifier.schema.json","type":"object","title":"RosettaOldestBlockIdentifier","description":"The block_identifier uniquely identifies a block in a particular network.","required":["index","hash"],"properties":{"index":{"type":"integer","description":"This is also known as the block height."},"hash":{"type":"string","description":"Block hash"}}},"sync_status":{"type":"object","title":"RosettaSyncStatus","description":"SyncStatus is used to provide additional context about an implementation's sync status. It is often used to indicate that an implementation is healthy when it cannot be queried until some sync phase occurs. If an implementation is immediately queryable, this model is often not populated.","required":["current_index"],"properties":{"current_index":{"type":"integer","description":"CurrentIndex is the index of the last synced block in the current stage."},"target_index":{"type":"integer","description":"TargetIndex is the index of the block that the implementation is attempting to sync to in the current stage."},"stage":{"type":"string","description":"Stage is the phase of the sync process."}}},"peers":{"type":"array","description":"Peers information","items":{"$id":"rosetta-network-peers.schema.json","type":"object","title":"RosettaPeers","description":"A Peer is a representation of a node's peer.","required":["peer_id"],"properties":{"peer_id":{"type":"string","description":"peer id"},"metadata":{"type":"object","description":"meta data"}}}}},"additionalProperties":true}
|
||||
@@ -1,14 +0,0 @@
|
||||
{
|
||||
"found": true,
|
||||
"result": {
|
||||
"entity_id": "ST2P7B9G6Y55QWZJ9B93DVSEG5S6Z4PFJHB3XRKHW.hello_world",
|
||||
"entity_type": "contract_address",
|
||||
"tx_data": {
|
||||
"canonical": true,
|
||||
"block_hash": "0xb076fd3983e63bbf28ae615daa31c5b6084d23ceeb920c54f1ea666244415457",
|
||||
"burn_block_time": 1595229199,
|
||||
"block_height": 648,
|
||||
"tx_type": "smart_contract"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,87 +0,0 @@
|
||||
{
|
||||
"limit": 96,
|
||||
"offset": 0,
|
||||
"total": 5,
|
||||
"results": [
|
||||
{
|
||||
"tx_id": "0xb31df5a363dad31723324cb5e0eefa04d491519fd30827a521cbc830114aa50c",
|
||||
"tx_status": "pending",
|
||||
"tx_type": "token_transfer",
|
||||
"receipt_time": 1598288370,
|
||||
"receipt_time_iso": "2020-08-24T16:59:30.000Z",
|
||||
"fee_rate": "180",
|
||||
"sender_address": "STB44HYPYAT2BB2QE513NSP81HTMYWBJP02HPGK6",
|
||||
"sponsored": false,
|
||||
"post_condition_mode": "deny",
|
||||
"token_transfer": {
|
||||
"recipient_address": "ST1GY25DM8RZV4X15X07THRZ2C5NMWPGQWKFGV87F",
|
||||
"amount": "500000",
|
||||
"memo": "0x46617563657400000000000000000000000000000000000000000000000000000000"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tx_id": "0x5bed8e3f801cb4e2c74d2815a092f7c1c6a35f2fce4a80c80ca70848d34cb395",
|
||||
"tx_status": "pending",
|
||||
"tx_type": "token_transfer",
|
||||
"receipt_time": 1598282326,
|
||||
"receipt_time_iso": "2020-08-24T15:18:46.000Z",
|
||||
"fee_rate": "180",
|
||||
"sender_address": "ST1PS1KF93VBY5A1JV7TM66KN046KP3E3761DBSAG",
|
||||
"sponsored": false,
|
||||
"post_condition_mode": "deny",
|
||||
"token_transfer": {
|
||||
"recipient_address": "ST2H33S8SEY27QKEKQKR6S5PECYPKY45CQYGGQR8X",
|
||||
"amount": "1000",
|
||||
"memo": "0x00000000000000000000000000000000000000000000000000000000000000000000"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tx_id": "0x9916036fde08a207e581cdcabc18ff55469861cb81194ab0e3e7c9a02cd5a17c",
|
||||
"tx_status": "pending",
|
||||
"tx_type": "smart_contract",
|
||||
"receipt_time": 1598258958,
|
||||
"receipt_time_iso": "2020-08-24T08:49:18.000Z",
|
||||
"fee_rate": "2000",
|
||||
"sender_address": "ST2R1XSFXYHCSFE426HP45TTD8ZWV9XHX2SRP3XA8",
|
||||
"sponsored": false,
|
||||
"post_condition_mode": "deny",
|
||||
"post_conditions": [],
|
||||
"smart_contract": {
|
||||
"contract_id": "ST2R1XSFXYHCSFE426HP45TTD8ZWV9XHX2SRP3XA8.test-loans-1",
|
||||
"source_code": "(define-data-var stx-loaned int 0)\n(define-data-var lockup-period int 0)\n(define-data-var stx-return int 0)\n(define-public (get-stx-return (stx uint) (months uint))\n (ok\n (begin\n (var-set stx-loaned (to-int(stx))\n (var-set lockup-period (to-int(months))\n (calculate-stx-return)\n (print (var-get stx-return))\n (transfer-to-server)\n )\n )\n)\n(define-private (calculate-stx-return)\n (ok\n (begin\n (var-set stx-return (- (+ (* (/ (* (var-get stx-loaned) 5) 100) (var-get lockup-period)) (var-get stx-loaned)) 5))\n )\n )\n)\n(define-private (transfer-to-server)\n (begin\n (unwrap-panic (stx-transfer? (to-uint (var-get stx-loaned)) tx-sender 'ST2R1XSFXYHCSFE426HP45TTD8ZWV9XHX2SRP3XA8))\n (ok (to-uint (var-get stx-loaned)))\n )\n)"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tx_id": "0x871fb186c8d6ac6ede2822c71074d9884b593c0d7f2d0d6e8516e615484d7501",
|
||||
"tx_status": "pending",
|
||||
"tx_type": "smart_contract",
|
||||
"receipt_time": 1598230365,
|
||||
"receipt_time_iso": "2020-08-24T00:52:45.000Z",
|
||||
"fee_rate": "2000",
|
||||
"sender_address": "ST1FJGMWPGM1P7N0K3N9QEPZK5H1VDC5YWTVMEAZ1",
|
||||
"sponsored": false,
|
||||
"post_condition_mode": "deny",
|
||||
"post_conditions": [],
|
||||
"smart_contract": {
|
||||
"contract_id": "ST1FJGMWPGM1P7N0K3N9QEPZK5H1VDC5YWTVMEAZ1.contract-hook-1598230358601",
|
||||
"source_code": ";; ## CUSTOM FUNCTION TO EXTRACT A SUBSTRING\n\n(define-read-only (subs (source (buff 10)) \n (start int) \n (end int))\n (begin\n (unwrap-panic (if (and (<= 0 start) (<= start 10)) (ok 1) (err \"Out of bounds: start\")))\n (unwrap-panic (if (and (<= 0 end) (<= end 10)) (ok 1) (err \"Out of bounds: end\")))\n (let ((temp1 (fold subs1 source \n {start: start, end: end, cursor: 1, data: \"\"})))\n (let ((data (get data temp1))) \n data))))\n \n;; Call the function to extract the substring between the bounds:\n\n;; (subs \"123456789\" 2 5)\n\n(define-read-only (subs1 \n (ch (buff 1))\n (acc {data: (buff 10), \n start: int,\n end: int,\n cursor: int})) \n (let ((data (get data acc))\n (start (get start acc))\n (cursor (get cursor acc))\n (end (get end acc))) \n (let ((temp2 \n {cursor: (+ 1 cursor),\n data: (default-to \"\"\n (as-max-len?\n (concat data \n (if (let ((temp3 start)\n (temp4 cursor)\n (temp5 end))\n (and (<= temp3 temp4)\n (<= temp4 temp5)))\n ch \n \"\"))\n u10))}))\n {start: (get start acc),\n end: (get end acc),\n cursor: (get cursor temp2),\n data: (get data temp2)})))\n"
|
||||
}
|
||||
},
|
||||
{
|
||||
"tx_id": "0x66df10d99d3a26018f521d60e9f744b083386c73e47ad39c394d570abee55f1f",
|
||||
"tx_status": "pending",
|
||||
"tx_type": "smart_contract",
|
||||
"receipt_time": 1598230066,
|
||||
"receipt_time_iso": "2020-08-24T00:47:46.000Z",
|
||||
"fee_rate": "2000",
|
||||
"sender_address": "ST1FJGMWPGM1P7N0K3N9QEPZK5H1VDC5YWTVMEAZ1",
|
||||
"sponsored": false,
|
||||
"post_condition_mode": "deny",
|
||||
"post_conditions": [],
|
||||
"smart_contract": {
|
||||
"contract_id": "ST1FJGMWPGM1P7N0K3N9QEPZK5H1VDC5YWTVMEAZ1.contract-hook-1598230054238",
|
||||
"source_code": "(define-read-only (subs1 \n (ch (buff 1))\n (acc {data: (buff 10), \n start: int,\n end: int,\n cursor: int}))\n (begin\n (unwrap-panic (if (and (<= 1 (get start acc)) (<= (get start acc) 10)) (ok 1) (err \"Out of bounds: start\")))\n (unwrap-panic (if (and (<= 1 (get end acc)) (<= (get end acc) 10)) (ok 1) (err \"Out of bounds: end\")))\n (unwrap-panic (if (and (<= 1 (get cursor acc)) (<= (get cursor acc) 10)) (ok 1) (err \"Out of bounds: cursor\")))\n (let ((data (get data acc))\n (start (get start acc))\n (cursor (get cursor acc))\n (end (get end acc))) \n (let ((temp1 \n {cursor: (+ 1 cursor),\n data: (default-to \"\"\n (as-max-len?\n (concat data \n (if (let ((temp2 start)\n (temp3 cursor)\n (temp4 end))\n (and (<= temp2 temp3)\n (<= temp3 temp4)))\n ch \n \"\"))\n u10))}))\n {start: (get start acc),\n end: (get end acc),\n cursor: (get cursor temp1),\n data: (get data temp1)}))))\n"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
@@ -1,24 +0,0 @@
|
||||
{
|
||||
"limit": 10,
|
||||
"offset": 0,
|
||||
"total": 101922,
|
||||
"results": [
|
||||
{
|
||||
"tx_id": "0x5e9f3933e358df6a73fec0d47ce3e1062c20812c129f5294e6f37a8d27c051d9",
|
||||
"tx_status": "success",
|
||||
"tx_type": "coinbase",
|
||||
"fee_rate": "0",
|
||||
"sender_address": "ST3WCQ6S0DFT7YHF53M8JPKGDS1N1GSSR91677XF1",
|
||||
"sponsored": false,
|
||||
"post_condition_mode": "deny",
|
||||
"block_hash": "0x58412b50266debd0c35b1a20348ad9c0f17e5525fb155a97033256c83c9e2491",
|
||||
"block_height": 3231,
|
||||
"burn_block_time": 1594230455,
|
||||
"canonical": true,
|
||||
"tx_index": 0,
|
||||
"coinbase_payload": {
|
||||
"data": "0x0000000000000000000000000000000000000000000000000000000000000000"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
@@ -1,11 +0,0 @@
|
||||
{
|
||||
"error": "transaction rejected",
|
||||
"reason": "BadNonce",
|
||||
"reason_data": {
|
||||
"actual": 4,
|
||||
"expected": 0,
|
||||
"is_origin": true,
|
||||
"principal": "ST2ZRX0K27GW0SP3GJCEMHD95TQGJMKB7G9Y0X1MH"
|
||||
},
|
||||
"txid": "caf6fd60ae05b0c2d19ef14ab6a7670b1095d117fa7c80224c74e76214d0a791"
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
{"$schema":"http://json-schema.org/draft-07/schema#","description":"GET request that returns transactions","title":"PostCoreNodeTransactionsError","type":"object","required":["error","reason","reason_data","txid"],"properties":{"error":{"type":"string","description":"The error"},"reason":{"type":"string","description":"The reason for the error"},"reason_data":{"type":"object","description":"More details about the reason"},"txid":{"type":"string","description":"The relevant transaction id"}}}
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 9.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 480 B |
Binary file not shown.
|
Before Width: | Height: | Size: 855 B |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,696 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>AccountsApi | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="accountsapi.html">AccountsApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class AccountsApi</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">AccountsApi</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/accountsapiinterface.html" class="tsd-signature-type">AccountsApiInterface</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="accountsapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="accountsapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccountassets" class="tsd-kind-icon">get<wbr>Account<wbr>Assets</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccountassetsraw" class="tsd-kind-icon">get<wbr>Account<wbr>Assets<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccountbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Balance</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccountbalanceraw" class="tsd-kind-icon">get<wbr>Account<wbr>Balance<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccountinfo" class="tsd-kind-icon">get<wbr>Account<wbr>Info</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccountinforaw" class="tsd-kind-icon">get<wbr>Account<wbr>Info<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccountstxbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccountstxbalanceraw" class="tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccounttransactions" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="accountsapi.html#getaccounttransactionsraw" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="accountsapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="accountsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="accountsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="accountsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Accounts<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="accountsapi.html" class="tsd-signature-type">AccountsApi</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="accountsapi.html" class="tsd-signature-type">AccountsApi</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccountassets" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Assets</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Assets<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccountassetsrequest.html" class="tsd-signature-type">GetAccountAssetsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressassetslistresponse.html" class="tsd-signature-type">AddressAssetsListResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccountassets">getAccountAssets</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L190">client/src/generated/apis/AccountsApi.ts:190</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get account assets</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccountassetsrequest.html" class="tsd-signature-type">GetAccountAssetsRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressassetslistresponse.html" class="tsd-signature-type">AddressAssetsListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccountassetsraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Assets<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Assets<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccountassetsrequest.html" class="tsd-signature-type">GetAccountAssetsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressassetslistresponse.html" class="tsd-signature-type">AddressAssetsListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccountassetsraw">getAccountAssetsRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L160">client/src/generated/apis/AccountsApi.ts:160</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get account assets</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccountassetsrequest.html" class="tsd-signature-type">GetAccountAssetsRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressassetslistresponse.html" class="tsd-signature-type">AddressAssetsListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccountbalance" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Balance</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Balance<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccountbalancerequest.html" class="tsd-signature-type">GetAccountBalanceRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressbalanceresponse.html" class="tsd-signature-type">AddressBalanceResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccountbalance">getAccountBalance</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L220">client/src/generated/apis/AccountsApi.ts:220</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get account balances</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccountbalancerequest.html" class="tsd-signature-type">GetAccountBalanceRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressbalanceresponse.html" class="tsd-signature-type">AddressBalanceResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccountbalanceraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Balance<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Balance<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccountbalancerequest.html" class="tsd-signature-type">GetAccountBalanceRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressbalanceresponse.html" class="tsd-signature-type">AddressBalanceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccountbalanceraw">getAccountBalanceRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L198">client/src/generated/apis/AccountsApi.ts:198</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get account balances</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccountbalancerequest.html" class="tsd-signature-type">GetAccountBalanceRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressbalanceresponse.html" class="tsd-signature-type">AddressBalanceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccountinfo" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Info</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Info<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccountinforequest.html" class="tsd-signature-type">GetAccountInfoRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/accountdataresponse.html" class="tsd-signature-type">AccountDataResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccountinfo">getAccountInfo</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L260">client/src/generated/apis/AccountsApi.ts:260</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the account data for the provided principal Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
|
||||
Get account info</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccountinforequest.html" class="tsd-signature-type">GetAccountInfoRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/accountdataresponse.html" class="tsd-signature-type">AccountDataResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccountinforaw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Info<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Info<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccountinforequest.html" class="tsd-signature-type">GetAccountInfoRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/accountdataresponse.html" class="tsd-signature-type">AccountDataResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccountinforaw">getAccountInfoRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L229">client/src/generated/apis/AccountsApi.ts:229</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the account data for the provided principal Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings. For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
|
||||
Get account info</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccountinforequest.html" class="tsd-signature-type">GetAccountInfoRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/accountdataresponse.html" class="tsd-signature-type">AccountDataResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccountstxbalance" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Stx<wbr>Balance</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccountstxbalancerequest.html" class="tsd-signature-type">GetAccountStxBalanceRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressstxbalanceresponse.html" class="tsd-signature-type">AddressStxBalanceResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccountstxbalance">getAccountStxBalance</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L290">client/src/generated/apis/AccountsApi.ts:290</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get account STX balance</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccountstxbalancerequest.html" class="tsd-signature-type">GetAccountStxBalanceRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressstxbalanceresponse.html" class="tsd-signature-type">AddressStxBalanceResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccountstxbalanceraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Stx<wbr>Balance<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccountstxbalancerequest.html" class="tsd-signature-type">GetAccountStxBalanceRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressstxbalanceresponse.html" class="tsd-signature-type">AddressStxBalanceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccountstxbalanceraw">getAccountStxBalanceRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L268">client/src/generated/apis/AccountsApi.ts:268</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get account STX balance</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccountstxbalancerequest.html" class="tsd-signature-type">GetAccountStxBalanceRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/addressstxbalanceresponse.html" class="tsd-signature-type">AddressStxBalanceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccounttransactions" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Transactions</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Transactions<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccounttransactionsrequest.html" class="tsd-signature-type">GetAccountTransactionsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/addresstransactionslistresponse.html" class="tsd-signature-type">AddressTransactionsListResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccounttransactions">getAccountTransactions</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L328">client/src/generated/apis/AccountsApi.ts:328</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get account transactions</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccounttransactionsrequest.html" class="tsd-signature-type">GetAccountTransactionsRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/addresstransactionslistresponse.html" class="tsd-signature-type">AddressTransactionsListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getaccounttransactionsraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Account<wbr>Transactions<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getaccounttransactionsrequest.html" class="tsd-signature-type">GetAccountTransactionsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/addresstransactionslistresponse.html" class="tsd-signature-type">AddressTransactionsListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/accountsapiinterface.html">AccountsApiInterface</a>.<a href="../interfaces/accountsapiinterface.html#getaccounttransactionsraw">getAccountTransactionsRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/AccountsApi.ts#L298">client/src/generated/apis/AccountsApi.ts:298</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get account transactions</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getaccounttransactionsrequest.html" class="tsd-signature-type">GetAccountTransactionsRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/addresstransactionslistresponse.html" class="tsd-signature-type">AddressTransactionsListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="accountsapi.html" class="tsd-kind-icon">Accounts<wbr>Api</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="accountsapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="accountsapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccountassets" class="tsd-kind-icon">get<wbr>Account<wbr>Assets</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccountassetsraw" class="tsd-kind-icon">get<wbr>Account<wbr>Assets<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccountbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Balance</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccountbalanceraw" class="tsd-kind-icon">get<wbr>Account<wbr>Balance<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccountinfo" class="tsd-kind-icon">get<wbr>Account<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccountinforaw" class="tsd-kind-icon">get<wbr>Account<wbr>Info<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccountstxbalance" class="tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccountstxbalanceraw" class="tsd-kind-icon">get<wbr>Account<wbr>Stx<wbr>Balance<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccounttransactions" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="accountsapi.html#getaccounttransactionsraw" class="tsd-kind-icon">get<wbr>Account<wbr>Transactions<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="accountsapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="accountsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="accountsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="accountsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,518 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>BaseAPI | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="baseapi.html">BaseAPI</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class BaseAPI</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>This is the base class for all generated API classes.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">BaseAPI</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="accountsapi.html" class="tsd-signature-type">AccountsApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="blocksapi.html" class="tsd-signature-type">BlocksApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="burnchainapi.html" class="tsd-signature-type">BurnchainApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="faucetsapi.html" class="tsd-signature-type">FaucetsApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="feesapi.html" class="tsd-signature-type">FeesApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="infoapi.html" class="tsd-signature-type">InfoApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="rosettaapi.html" class="tsd-signature-type">RosettaApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="searchapi.html" class="tsd-signature-type">SearchApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="smartcontractsapi.html" class="tsd-signature-type">SmartContractsApi</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="transactionsapi.html" class="tsd-signature-type">TransactionsApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="baseapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="baseapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="baseapi.html#middleware" class="tsd-kind-icon">middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="baseapi.html#clone" class="tsd-kind-icon">clone</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="baseapi.html#createfetchparams" class="tsd-kind-icon">create<wbr>Fetch<wbr>Params</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="baseapi.html#fetchapi" class="tsd-kind-icon">fetch<wbr>Api</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="baseapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="baseapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="baseapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="baseapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>BaseAPI<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="middleware" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> middleware</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">middleware<span class="tsd-signature-symbol">:</span> <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
||||
<a name="clone" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> clone</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
||||
<li class="tsd-signature tsd-kind-icon">clone<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L106">client/src/generated/runtime.ts:106</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Create a shallow clone of <code>this</code> by constructing a new instance
|
||||
and then shallow cloning data members.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<a name="createfetchparams" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> create<wbr>Fetch<wbr>Params</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<li class="tsd-signature tsd-kind-icon">create<wbr>Fetch<wbr>Params<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>init<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"include"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"omit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"same-origin"</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpheaders" class="tsd-signature-type">HTTPHeaders</a><span class="tsd-signature-symbol">; </span>method<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpmethod" class="tsd-signature-type">HTTPMethod</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L56">client/src/generated/runtime.ts:56</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>init<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"include"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"omit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"same-origin"</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpheaders" class="tsd-signature-type">HTTPHeaders</a><span class="tsd-signature-symbol">; </span>method<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpmethod" class="tsd-signature-type">HTTPMethod</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>init<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"include"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"omit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"same-origin"</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpheaders" class="tsd-signature-type">HTTPHeaders</a><span class="tsd-signature-symbol">; </span>method<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpmethod" class="tsd-signature-type">HTTPMethod</a><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>credentials<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"include"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"omit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"same-origin"</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>headers<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpheaders" class="tsd-signature-type">HTTPHeaders</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>method<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpmethod" class="tsd-signature-type">HTTPMethod</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<a name="fetchapi" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> fetch<wbr>Api</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<li class="tsd-signature tsd-kind-icon">fetch<wbr>Api<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, init<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L78">client/src/generated/runtime.ts:78</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>url: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>init: <span class="tsd-signature-type">RequestInit</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="baseapi.html" class="tsd-kind-icon">BaseAPI</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="baseapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
||||
<a href="baseapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="baseapi.html#middleware" class="tsd-kind-icon">middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
||||
<a href="baseapi.html#clone" class="tsd-kind-icon">clone</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<a href="baseapi.html#createfetchparams" class="tsd-kind-icon">create<wbr>Fetch<wbr>Params</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
||||
<a href="baseapi.html#fetchapi" class="tsd-kind-icon">fetch<wbr>Api</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
||||
<a href="baseapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
||||
<a href="baseapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
||||
<a href="baseapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
|
||||
<a href="baseapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,233 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>BlobApiResponse | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="blobapiresponse.html">BlobApiResponse</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class BlobApiResponse</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">BlobApiResponse</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="blobapiresponse.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="blobapiresponse.html#raw" class="tsd-kind-icon">raw</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="blobapiresponse.html#value" class="tsd-kind-icon">value</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Blob<wbr>Api<wbr>Response<span class="tsd-signature-symbol">(</span>raw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="blobapiresponse.html" class="tsd-signature-type">BlobApiResponse</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L302">client/src/generated/runtime.ts:302</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>raw: <span class="tsd-signature-type">Response</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="blobapiresponse.html" class="tsd-signature-type">BlobApiResponse</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="raw" class="tsd-anchor"></a>
|
||||
<h3>raw</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Response</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L303">client/src/generated/runtime.ts:303</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="value" class="tsd-anchor"></a>
|
||||
<h3>value</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L305">client/src/generated/runtime.ts:305</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="blobapiresponse.html" class="tsd-kind-icon">Blob<wbr>Api<wbr>Response</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="blobapiresponse.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="blobapiresponse.html#raw" class="tsd-kind-icon">raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="blobapiresponse.html#value" class="tsd-kind-icon">value</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,500 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>BlocksApi | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="blocksapi.html">BlocksApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class BlocksApi</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">BlocksApi</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/blocksapiinterface.html" class="tsd-signature-type">BlocksApiInterface</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="blocksapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="blocksapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="blocksapi.html#getblockbyhash" class="tsd-kind-icon">get<wbr>Block<wbr>ByHash</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="blocksapi.html#getblockbyhashraw" class="tsd-kind-icon">get<wbr>Block<wbr>ByHash<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="blocksapi.html#getblocklist" class="tsd-kind-icon">get<wbr>Block<wbr>List</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="blocksapi.html#getblocklistraw" class="tsd-kind-icon">get<wbr>Block<wbr>List<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="blocksapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="blocksapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="blocksapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="blocksapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Blocks<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="blocksapi.html" class="tsd-signature-type">BlocksApi</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="blocksapi.html" class="tsd-signature-type">BlocksApi</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getblockbyhash" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Block<wbr>ByHash</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>ByHash<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getblockbyhashrequest.html" class="tsd-signature-type">GetBlockByHashRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/block.html" class="tsd-signature-type">Block</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/blocksapiinterface.html">BlocksApiInterface</a>.<a href="../interfaces/blocksapiinterface.html#getblockbyhash">getBlockByHash</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BlocksApi.ts#L109">client/src/generated/apis/BlocksApi.ts:109</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a specific block by hash
|
||||
Get block</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getblockbyhashrequest.html" class="tsd-signature-type">GetBlockByHashRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/block.html" class="tsd-signature-type">Block</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getblockbyhashraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Block<wbr>ByHash<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>ByHash<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getblockbyhashrequest.html" class="tsd-signature-type">GetBlockByHashRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/block.html" class="tsd-signature-type">Block</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/blocksapiinterface.html">BlocksApiInterface</a>.<a href="../interfaces/blocksapiinterface.html#getblockbyhashraw">getBlockByHashRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BlocksApi.ts#L86">client/src/generated/apis/BlocksApi.ts:86</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a specific block by hash
|
||||
Get block</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getblockbyhashrequest.html" class="tsd-signature-type">GetBlockByHashRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/block.html" class="tsd-signature-type">Block</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getblocklist" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Block<wbr>List</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>List<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getblocklistrequest.html" class="tsd-signature-type">GetBlockListRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/blocklistresponse.html" class="tsd-signature-type">BlockListResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/blocksapiinterface.html">BlocksApiInterface</a>.<a href="../interfaces/blocksapiinterface.html#getblocklist">getBlockList</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BlocksApi.ts#L145">client/src/generated/apis/BlocksApi.ts:145</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all recently mined blocks
|
||||
Get recent blocks</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getblocklistrequest.html" class="tsd-signature-type">GetBlockListRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/blocklistresponse.html" class="tsd-signature-type">BlockListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getblocklistraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Block<wbr>List<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>List<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getblocklistrequest.html" class="tsd-signature-type">GetBlockListRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/blocklistresponse.html" class="tsd-signature-type">BlockListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/blocksapiinterface.html">BlocksApiInterface</a>.<a href="../interfaces/blocksapiinterface.html#getblocklistraw">getBlockListRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BlocksApi.ts#L118">client/src/generated/apis/BlocksApi.ts:118</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all recently mined blocks
|
||||
Get recent blocks</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getblocklistrequest.html" class="tsd-signature-type">GetBlockListRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/blocklistresponse.html" class="tsd-signature-type">BlockListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="blocksapi.html" class="tsd-kind-icon">Blocks<wbr>Api</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="blocksapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="blocksapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="blocksapi.html#getblockbyhash" class="tsd-kind-icon">get<wbr>Block<wbr>ByHash</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="blocksapi.html#getblockbyhashraw" class="tsd-kind-icon">get<wbr>Block<wbr>ByHash<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="blocksapi.html#getblocklist" class="tsd-kind-icon">get<wbr>Block<wbr>List</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="blocksapi.html#getblocklistraw" class="tsd-kind-icon">get<wbr>Block<wbr>List<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="blocksapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="blocksapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="blocksapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="blocksapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,568 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>BurnchainApi | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="burnchainapi.html">BurnchainApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class BurnchainApi</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">BurnchainApi</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/burnchainapiinterface.html" class="tsd-signature-type">BurnchainApiInterface</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="burnchainapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="burnchainapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="burnchainapi.html#getburnchainrewardlist" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="burnchainapi.html#getburnchainrewardlistbyaddress" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>ByAddress</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="burnchainapi.html#getburnchainrewardlistbyaddressraw" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>ByAddress<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="burnchainapi.html#getburnchainrewardlistraw" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="burnchainapi.html#getburnchainrewardstotalbyaddress" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Rewards<wbr>Total<wbr>ByAddress</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="burnchainapi.html#getburnchainrewardstotalbyaddressraw" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Rewards<wbr>Total<wbr>ByAddress<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="burnchainapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="burnchainapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="burnchainapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="burnchainapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Burnchain<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="burnchainapi.html" class="tsd-signature-type">BurnchainApi</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="burnchainapi.html" class="tsd-signature-type">BurnchainApi</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getburnchainrewardlist" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Burnchain<wbr>Reward<wbr>List</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getburnchainrewardlistrequest.html" class="tsd-signature-type">GetBurnchainRewardListRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardlistresponse.html" class="tsd-signature-type">BurnchainRewardListResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/burnchainapiinterface.html">BurnchainApiInterface</a>.<a href="../interfaces/burnchainapiinterface.html#getburnchainrewardlist">getBurnchainRewardList</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BurnchainApi.ts#L137">client/src/generated/apis/BurnchainApi.ts:137</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
|
||||
Get recent burnchain reward recipients</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getburnchainrewardlistrequest.html" class="tsd-signature-type">GetBurnchainRewardListRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardlistresponse.html" class="tsd-signature-type">BurnchainRewardListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getburnchainrewardlistbyaddress" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>ByAddress</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>ByAddress<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getburnchainrewardlistbyaddressrequest.html" class="tsd-signature-type">GetBurnchainRewardListByAddressRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardlistresponse.html" class="tsd-signature-type">BurnchainRewardListResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/burnchainapiinterface.html">BurnchainApiInterface</a>.<a href="../interfaces/burnchainapiinterface.html#getburnchainrewardlistbyaddress">getBurnchainRewardListByAddress</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BurnchainApi.ts#L177">client/src/generated/apis/BurnchainApi.ts:177</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
|
||||
Get recent burnchain reward for the given recipient</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getburnchainrewardlistbyaddressrequest.html" class="tsd-signature-type">GetBurnchainRewardListByAddressRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardlistresponse.html" class="tsd-signature-type">BurnchainRewardListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getburnchainrewardlistbyaddressraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>ByAddress<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>ByAddress<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getburnchainrewardlistbyaddressrequest.html" class="tsd-signature-type">GetBurnchainRewardListByAddressRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardlistresponse.html" class="tsd-signature-type">BurnchainRewardListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/burnchainapiinterface.html">BurnchainApiInterface</a>.<a href="../interfaces/burnchainapiinterface.html#getburnchainrewardlistbyaddressraw">getBurnchainRewardListByAddressRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BurnchainApi.ts#L146">client/src/generated/apis/BurnchainApi.ts:146</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info
|
||||
Get recent burnchain reward for the given recipient</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getburnchainrewardlistbyaddressrequest.html" class="tsd-signature-type">GetBurnchainRewardListByAddressRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardlistresponse.html" class="tsd-signature-type">BurnchainRewardListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getburnchainrewardlistraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getburnchainrewardlistrequest.html" class="tsd-signature-type">GetBurnchainRewardListRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardlistresponse.html" class="tsd-signature-type">BurnchainRewardListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/burnchainapiinterface.html">BurnchainApiInterface</a>.<a href="../interfaces/burnchainapiinterface.html#getburnchainrewardlistraw">getBurnchainRewardListRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BurnchainApi.ts#L110">client/src/generated/apis/BurnchainApi.ts:110</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info
|
||||
Get recent burnchain reward recipients</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getburnchainrewardlistrequest.html" class="tsd-signature-type">GetBurnchainRewardListRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardlistresponse.html" class="tsd-signature-type">BurnchainRewardListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getburnchainrewardstotalbyaddress" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Burnchain<wbr>Rewards<wbr>Total<wbr>ByAddress</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Burnchain<wbr>Rewards<wbr>Total<wbr>ByAddress<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getburnchainrewardstotalbyaddressrequest.html" class="tsd-signature-type">GetBurnchainRewardsTotalByAddressRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardstotal.html" class="tsd-signature-type">BurnchainRewardsTotal</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/burnchainapiinterface.html">BurnchainApiInterface</a>.<a href="../interfaces/burnchainapiinterface.html#getburnchainrewardstotalbyaddress">getBurnchainRewardsTotalByAddress</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BurnchainApi.ts#L209">client/src/generated/apis/BurnchainApi.ts:209</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the total burnchain (e.g. Bitcoin) rewards for the given recipient
|
||||
Get total burnchain rewards for the given recipient</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getburnchainrewardstotalbyaddressrequest.html" class="tsd-signature-type">GetBurnchainRewardsTotalByAddressRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardstotal.html" class="tsd-signature-type">BurnchainRewardsTotal</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getburnchainrewardstotalbyaddressraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Burnchain<wbr>Rewards<wbr>Total<wbr>ByAddress<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Burnchain<wbr>Rewards<wbr>Total<wbr>ByAddress<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getburnchainrewardstotalbyaddressrequest.html" class="tsd-signature-type">GetBurnchainRewardsTotalByAddressRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardstotal.html" class="tsd-signature-type">BurnchainRewardsTotal</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/burnchainapiinterface.html">BurnchainApiInterface</a>.<a href="../interfaces/burnchainapiinterface.html#getburnchainrewardstotalbyaddressraw">getBurnchainRewardsTotalByAddressRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/BurnchainApi.ts#L186">client/src/generated/apis/BurnchainApi.ts:186</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the total burnchain (e.g. Bitcoin) rewards for the given recipient
|
||||
Get total burnchain rewards for the given recipient</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getburnchainrewardstotalbyaddressrequest.html" class="tsd-signature-type">GetBurnchainRewardsTotalByAddressRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/burnchainrewardstotal.html" class="tsd-signature-type">BurnchainRewardsTotal</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="burnchainapi.html" class="tsd-kind-icon">Burnchain<wbr>Api</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="burnchainapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="burnchainapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="burnchainapi.html#getburnchainrewardlist" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="burnchainapi.html#getburnchainrewardlistbyaddress" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>ByAddress</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="burnchainapi.html#getburnchainrewardlistbyaddressraw" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>ByAddress<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="burnchainapi.html#getburnchainrewardlistraw" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Reward<wbr>List<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="burnchainapi.html#getburnchainrewardstotalbyaddress" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Rewards<wbr>Total<wbr>ByAddress</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="burnchainapi.html#getburnchainrewardstotalbyaddressraw" class="tsd-kind-icon">get<wbr>Burnchain<wbr>Rewards<wbr>Total<wbr>ByAddress<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="burnchainapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="burnchainapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="burnchainapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="burnchainapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,440 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Configuration | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="configuration.html">Configuration</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class Configuration</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Configuration</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="configuration.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="configuration.html#configuration-1" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#accesstoken" class="tsd-kind-icon">access<wbr>Token</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#apikey" class="tsd-kind-icon">api<wbr>Key</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#basepath" class="tsd-kind-icon">base<wbr>Path</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#credentials" class="tsd-kind-icon">credentials</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#fetchapi" class="tsd-kind-icon">fetch<wbr>Api</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#headers" class="tsd-kind-icon">headers</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#middleware" class="tsd-kind-icon">middleware</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#password" class="tsd-kind-icon">password</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#queryparamsstringify" class="tsd-kind-icon">query<wbr>Params<wbr>Stringify</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="configuration.html#username" class="tsd-kind-icon">username</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Configuration<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="../interfaces/configurationparameters.html" class="tsd-signature-type">ConfigurationParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L143">client/src/generated/runtime.ts:143</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="../interfaces/configurationparameters.html" class="tsd-signature-type">ConfigurationParameters</a><span class="tsd-signature-symbol"> = {}</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="configuration.html" class="tsd-signature-type">Configuration</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="configuration-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="../interfaces/configurationparameters.html" class="tsd-signature-type">ConfigurationParameters</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L144">client/src/generated/runtime.ts:144</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="accesstoken" class="tsd-anchor"></a>
|
||||
<h3>access<wbr>Token</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> accessToken<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scopes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L178">client/src/generated/runtime.ts:178</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scopes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="apikey" class="tsd-anchor"></a>
|
||||
<h3>api<wbr>Key</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> apiKey<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L170">client/src/generated/runtime.ts:170</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="basepath" class="tsd-anchor"></a>
|
||||
<h3>base<wbr>Path</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> basePath<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L146">client/src/generated/runtime.ts:146</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="credentials" class="tsd-anchor"></a>
|
||||
<h3>credentials</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> credentials<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestCredentials</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L190">client/src/generated/runtime.ts:190</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RequestCredentials</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="fetchapi" class="tsd-anchor"></a>
|
||||
<h3>fetch<wbr>Api</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> fetchApi<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../globals.html#fetchapi" class="tsd-signature-type">FetchAPI</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L150">client/src/generated/runtime.ts:150</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../globals.html#fetchapi" class="tsd-signature-type">FetchAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="headers" class="tsd-anchor"></a>
|
||||
<h3>headers</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> headers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../globals.html#httpheaders" class="tsd-signature-type">HTTPHeaders</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L186">client/src/generated/runtime.ts:186</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../globals.html#httpheaders" class="tsd-signature-type">HTTPHeaders</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="middleware" class="tsd-anchor"></a>
|
||||
<h3>middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> middleware<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L154">client/src/generated/runtime.ts:154</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="password" class="tsd-anchor"></a>
|
||||
<h3>password</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> password<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L166">client/src/generated/runtime.ts:166</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="queryparamsstringify" class="tsd-anchor"></a>
|
||||
<h3>query<wbr>Params<wbr>Stringify</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> queryParamsStringify<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpquery" class="tsd-signature-type">HTTPQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L158">client/src/generated/runtime.ts:158</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpquery" class="tsd-signature-type">HTTPQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span></h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../globals.html#httpquery" class="tsd-signature-type">HTTPQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>params: <a href="../globals.html#httpquery" class="tsd-signature-type">HTTPQuery</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="username" class="tsd-anchor"></a>
|
||||
<h3>username</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> username<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L162">client/src/generated/runtime.ts:162</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="configuration.html" class="tsd-kind-icon">Configuration</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="configuration.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="configuration.html#configuration-1" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#accesstoken" class="tsd-kind-icon">access<wbr>Token</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#apikey" class="tsd-kind-icon">api<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#basepath" class="tsd-kind-icon">base<wbr>Path</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#credentials" class="tsd-kind-icon">credentials</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#fetchapi" class="tsd-kind-icon">fetch<wbr>Api</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#headers" class="tsd-kind-icon">headers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#middleware" class="tsd-kind-icon">middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#password" class="tsd-kind-icon">password</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#queryparamsstringify" class="tsd-kind-icon">query<wbr>Params<wbr>Stringify</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="configuration.html#username" class="tsd-kind-icon">username</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,500 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>FaucetsApi | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="faucetsapi.html">FaucetsApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class FaucetsApi</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">FaucetsApi</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/faucetsapiinterface.html" class="tsd-signature-type">FaucetsApiInterface</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="faucetsapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="faucetsapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="faucetsapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="faucetsapi.html#runfaucetbtc" class="tsd-kind-icon">run<wbr>Faucet<wbr>Btc</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="faucetsapi.html#runfaucetbtcraw" class="tsd-kind-icon">run<wbr>Faucet<wbr>Btc<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="faucetsapi.html#runfaucetstx" class="tsd-kind-icon">run<wbr>Faucet<wbr>Stx</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="faucetsapi.html#runfaucetstxraw" class="tsd-kind-icon">run<wbr>Faucet<wbr>Stx<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="faucetsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="faucetsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="faucetsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Faucets<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="faucetsapi.html" class="tsd-signature-type">FaucetsApi</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="faucetsapi.html" class="tsd-signature-type">FaucetsApi</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="runfaucetbtc" class="tsd-anchor"></a>
|
||||
<h3>run<wbr>Faucet<wbr>Btc</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">run<wbr>Faucet<wbr>Btc<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/runfaucetbtcrequest.html" class="tsd-signature-type">RunFaucetBtcRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/runfaucetresponse.html" class="tsd-signature-type">RunFaucetResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/faucetsapiinterface.html">FaucetsApiInterface</a>.<a href="../interfaces/faucetsapiinterface.html#runfaucetbtc">runFaucetBtc</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/FaucetsApi.ts#L110">client/src/generated/apis/FaucetsApi.ts:110</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get BTC tokens for the testnet
|
||||
Get BTC tokens</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/runfaucetbtcrequest.html" class="tsd-signature-type">RunFaucetBtcRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/runfaucetresponse.html" class="tsd-signature-type">RunFaucetResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="runfaucetbtcraw" class="tsd-anchor"></a>
|
||||
<h3>run<wbr>Faucet<wbr>Btc<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">run<wbr>Faucet<wbr>Btc<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/runfaucetbtcrequest.html" class="tsd-signature-type">RunFaucetBtcRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/runfaucetresponse.html" class="tsd-signature-type">RunFaucetResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/faucetsapiinterface.html">FaucetsApiInterface</a>.<a href="../interfaces/faucetsapiinterface.html#runfaucetbtcraw">runFaucetBtcRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/FaucetsApi.ts#L83">client/src/generated/apis/FaucetsApi.ts:83</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get BTC tokens for the testnet
|
||||
Get BTC tokens</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/runfaucetbtcrequest.html" class="tsd-signature-type">RunFaucetBtcRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/runfaucetresponse.html" class="tsd-signature-type">RunFaucetResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="runfaucetstx" class="tsd-anchor"></a>
|
||||
<h3>run<wbr>Faucet<wbr>Stx</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">run<wbr>Faucet<wbr>Stx<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/runfaucetstxrequest.html" class="tsd-signature-type">RunFaucetStxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/runfaucetresponse.html" class="tsd-signature-type">RunFaucetResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/faucetsapiinterface.html">FaucetsApiInterface</a>.<a href="../interfaces/faucetsapiinterface.html#runfaucetstx">runFaucetStx</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/FaucetsApi.ts#L150">client/src/generated/apis/FaucetsApi.ts:150</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get STX tokens for the testnet
|
||||
Get STX tokens</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/runfaucetstxrequest.html" class="tsd-signature-type">RunFaucetStxRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/runfaucetresponse.html" class="tsd-signature-type">RunFaucetResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="runfaucetstxraw" class="tsd-anchor"></a>
|
||||
<h3>run<wbr>Faucet<wbr>Stx<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">run<wbr>Faucet<wbr>Stx<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/runfaucetstxrequest.html" class="tsd-signature-type">RunFaucetStxRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/runfaucetresponse.html" class="tsd-signature-type">RunFaucetResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/faucetsapiinterface.html">FaucetsApiInterface</a>.<a href="../interfaces/faucetsapiinterface.html#runfaucetstxraw">runFaucetStxRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/FaucetsApi.ts#L119">client/src/generated/apis/FaucetsApi.ts:119</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get STX tokens for the testnet
|
||||
Get STX tokens</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/runfaucetstxrequest.html" class="tsd-signature-type">RunFaucetStxRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/runfaucetresponse.html" class="tsd-signature-type">RunFaucetResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="faucetsapi.html" class="tsd-kind-icon">Faucets<wbr>Api</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="faucetsapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="faucetsapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="faucetsapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="faucetsapi.html#runfaucetbtc" class="tsd-kind-icon">run<wbr>Faucet<wbr>Btc</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="faucetsapi.html#runfaucetbtcraw" class="tsd-kind-icon">run<wbr>Faucet<wbr>Btc<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="faucetsapi.html#runfaucetstx" class="tsd-kind-icon">run<wbr>Faucet<wbr>Stx</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="faucetsapi.html#runfaucetstxraw" class="tsd-kind-icon">run<wbr>Faucet<wbr>Stx<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="faucetsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="faucetsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="faucetsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,420 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>FeesApi | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="feesapi.html">FeesApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class FeesApi</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">FeesApi</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/feesapiinterface.html" class="tsd-signature-type">FeesApiInterface</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="feesapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="feesapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="feesapi.html#getfeetransfer" class="tsd-kind-icon">get<wbr>Fee<wbr>Transfer</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="feesapi.html#getfeetransferraw" class="tsd-kind-icon">get<wbr>Fee<wbr>Transfer<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="feesapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="feesapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="feesapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="feesapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Fees<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="feesapi.html" class="tsd-signature-type">FeesApi</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="feesapi.html" class="tsd-signature-type">FeesApi</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getfeetransfer" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Fee<wbr>Transfer</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<wbr>Transfer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/feesapiinterface.html">FeesApiInterface</a>.<a href="../interfaces/feesapiinterface.html#getfeetransfer">getFeeTransfer</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/FeesApi.ts#L70">client/src/generated/apis/FeesApi.ts:70</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
|
||||
Get estimated fee</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getfeetransferraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Fee<wbr>Transfer<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<wbr>Transfer<wbr>Raw<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/feesapiinterface.html">FeesApiInterface</a>.<a href="../interfaces/feesapiinterface.html#getfeetransferraw">getFeeTransferRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/FeesApi.ts#L51">client/src/generated/apis/FeesApi.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
|
||||
Get estimated fee</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="feesapi.html" class="tsd-kind-icon">Fees<wbr>Api</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="feesapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="feesapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="feesapi.html#getfeetransfer" class="tsd-kind-icon">get<wbr>Fee<wbr>Transfer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="feesapi.html#getfeetransferraw" class="tsd-kind-icon">get<wbr>Fee<wbr>Transfer<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="feesapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="feesapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="feesapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="feesapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,652 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>InfoApi | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="infoapi.html">InfoApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class InfoApi</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">InfoApi</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/infoapiinterface.html" class="tsd-signature-type">InfoApiInterface</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="infoapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="infoapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getcoreapiinfo" class="tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getcoreapiinforaw" class="tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getnetworkblocktimebynetwork" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getnetworkblocktimebynetworkraw" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getnetworkblocktimes" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getnetworkblocktimesraw" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getpoxinfo" class="tsd-kind-icon">get<wbr>Pox<wbr>Info</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getpoxinforaw" class="tsd-kind-icon">get<wbr>Pox<wbr>Info<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="infoapi.html#getstatusraw" class="tsd-kind-icon">get<wbr>Status<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="infoapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="infoapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="infoapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="infoapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Info<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="infoapi.html" class="tsd-signature-type">InfoApi</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="infoapi.html" class="tsd-signature-type">InfoApi</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcoreapiinfo" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Core<wbr>Api<wbr>Info</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodeinforesponse.html" class="tsd-signature-type">CoreNodeInfoResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getcoreapiinfo">getCoreApiInfo</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L147">client/src/generated/apis/InfoApi.ts:147</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get Core API information
|
||||
Get Core API info</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodeinforesponse.html" class="tsd-signature-type">CoreNodeInfoResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcoreapiinforaw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Core<wbr>Api<wbr>Info<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info<wbr>Raw<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodeinforesponse.html" class="tsd-signature-type">CoreNodeInfoResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getcoreapiinforaw">getCoreApiInfoRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L128">client/src/generated/apis/InfoApi.ts:128</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get Core API information
|
||||
Get Core API info</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodeinforesponse.html" class="tsd-signature-type">CoreNodeInfoResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getnetworkblocktimebynetwork" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getnetworkblocktimebynetworkrequest.html" class="tsd-signature-type">GetNetworkBlockTimeByNetworkRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimeresponse.html" class="tsd-signature-type">NetworkBlockTimeResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getnetworkblocktimebynetwork">getNetworkBlockTimeByNetwork</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L177">client/src/generated/apis/InfoApi.ts:177</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a given network's target block time</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getnetworkblocktimebynetworkrequest.html" class="tsd-signature-type">GetNetworkBlockTimeByNetworkRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimeresponse.html" class="tsd-signature-type">NetworkBlockTimeResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getnetworkblocktimebynetworkraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getnetworkblocktimebynetworkrequest.html" class="tsd-signature-type">GetNetworkBlockTimeByNetworkRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimeresponse.html" class="tsd-signature-type">NetworkBlockTimeResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getnetworkblocktimebynetworkraw">getNetworkBlockTimeByNetworkRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L155">client/src/generated/apis/InfoApi.ts:155</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a given network's target block time</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getnetworkblocktimebynetworkrequest.html" class="tsd-signature-type">GetNetworkBlockTimeByNetworkRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimeresponse.html" class="tsd-signature-type">NetworkBlockTimeResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getnetworkblocktimes" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Network<wbr>Block<wbr>Times</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimesresponse.html" class="tsd-signature-type">NetworkBlockTimesResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getnetworkblocktimes">getNetworkBlockTimes</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L203">client/src/generated/apis/InfoApi.ts:203</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the network target block time</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimesresponse.html" class="tsd-signature-type">NetworkBlockTimesResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getnetworkblocktimesraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Network<wbr>Block<wbr>Times<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times<wbr>Raw<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimesresponse.html" class="tsd-signature-type">NetworkBlockTimesResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getnetworkblocktimesraw">getNetworkBlockTimesRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L185">client/src/generated/apis/InfoApi.ts:185</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the network target block time</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/networkblocktimesresponse.html" class="tsd-signature-type">NetworkBlockTimesResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getpoxinfo" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Pox<wbr>Info</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Pox<wbr>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodepoxresponse.html" class="tsd-signature-type">CoreNodePoxResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getpoxinfo">getPoxInfo</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L231">client/src/generated/apis/InfoApi.ts:231</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get Proof of Transfer (PoX) information. Can be used for Stacking.
|
||||
Get PoX details</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodepoxresponse.html" class="tsd-signature-type">CoreNodePoxResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getpoxinforaw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Pox<wbr>Info<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Pox<wbr>Info<wbr>Raw<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodepoxresponse.html" class="tsd-signature-type">CoreNodePoxResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getpoxinforaw">getPoxInfoRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L212">client/src/generated/apis/InfoApi.ts:212</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get Proof of Transfer (PoX) information. Can be used for Stacking.
|
||||
Get PoX details</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/corenodepoxresponse.html" class="tsd-signature-type">CoreNodePoxResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getstatus" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Status</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Status<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getstatus">getStatus</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L259">client/src/generated/apis/InfoApi.ts:259</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get Blockchain API status
|
||||
Get Blockchain API status</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getstatusraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Status<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Status<wbr>Raw<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/infoapiinterface.html">InfoApiInterface</a>.<a href="../interfaces/infoapiinterface.html#getstatusraw">getStatusRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/InfoApi.ts#L240">client/src/generated/apis/InfoApi.ts:240</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get Blockchain API status
|
||||
Get Blockchain API status</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="infoapi.html" class="tsd-kind-icon">Info<wbr>Api</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="infoapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="infoapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getcoreapiinfo" class="tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getcoreapiinforaw" class="tsd-kind-icon">get<wbr>Core<wbr>Api<wbr>Info<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getnetworkblocktimebynetwork" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getnetworkblocktimebynetworkraw" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Time<wbr>ByNetwork<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getnetworkblocktimes" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getnetworkblocktimesraw" class="tsd-kind-icon">get<wbr>Network<wbr>Block<wbr>Times<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getpoxinfo" class="tsd-kind-icon">get<wbr>Pox<wbr>Info</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getpoxinforaw" class="tsd-kind-icon">get<wbr>Pox<wbr>Info<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="infoapi.html#getstatusraw" class="tsd-kind-icon">get<wbr>Status<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="infoapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="infoapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="infoapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="infoapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,258 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>JSONApiResponse | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="jsonapiresponse.html">JSONApiResponse</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class JSONApiResponse<T></h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h3>Type parameters</h3>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T</h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">JSONApiResponse</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="jsonapiresponse.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="jsonapiresponse.html#raw" class="tsd-kind-icon">raw</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="jsonapiresponse.html#transformer" class="tsd-kind-icon">transformer</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="jsonapiresponse.html#value" class="tsd-kind-icon">value</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new JSONApi<wbr>Response<span class="tsd-signature-symbol">(</span>raw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span>, transformer<span class="tsd-signature-symbol">?: </span><a href="../interfaces/responsetransformer.html" class="tsd-signature-type">ResponseTransformer</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="jsonapiresponse.html" class="tsd-signature-type">JSONApiResponse</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L286">client/src/generated/runtime.ts:286</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>raw: <span class="tsd-signature-type">Response</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> transformer: <a href="../interfaces/responsetransformer.html" class="tsd-signature-type">ResponseTransformer</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = (jsonValue: any) => jsonValue</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="jsonapiresponse.html" class="tsd-signature-type">JSONApiResponse</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="raw" class="tsd-anchor"></a>
|
||||
<h3>raw</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Response</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L287">client/src/generated/runtime.ts:287</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a name="transformer" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> transformer</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">transformer<span class="tsd-signature-symbol">:</span> <a href="../interfaces/responsetransformer.html" class="tsd-signature-type">ResponseTransformer</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L287">client/src/generated/runtime.ts:287</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="value" class="tsd-anchor"></a>
|
||||
<h3>value</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L289">client/src/generated/runtime.ts:289</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-has-type-parameter">
|
||||
<a href="jsonapiresponse.html" class="tsd-kind-icon">JSONApi<wbr>Response</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="jsonapiresponse.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="jsonapiresponse.html#raw" class="tsd-kind-icon">raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
||||
<a href="jsonapiresponse.html#transformer" class="tsd-kind-icon">transformer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="jsonapiresponse.html#value" class="tsd-kind-icon">value</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,271 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>RequiredError | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="requirederror.html">RequiredError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class RequiredError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="requirederror.html#error" class="tsd-signature-type">Error</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">RequiredError</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="requirederror.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="requirederror.html#field" class="tsd-kind-icon">field</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="requirederror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="requirederror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="requirederror.html#stack" class="tsd-kind-icon">stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="requirederror.html#error" class="tsd-kind-icon">Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Required<wbr>Error<span class="tsd-signature-symbol">(</span>field<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, msg<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="requirederror.html" class="tsd-signature-type">RequiredError</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L115">client/src/generated/runtime.ts:115</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>field: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> msg: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="requirederror.html" class="tsd-signature-type">RequiredError</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="field" class="tsd-anchor"></a>
|
||||
<h3>field</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L116">client/src/generated/runtime.ts:116</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="requirederror.html">RequiredError</a>.<a href="requirederror.html#message">message</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:974</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"RequiredError"</span><span class="tsd-signature-symbol"> = "RequiredError"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides Error.name</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L115">client/src/generated/runtime.ts:115</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="stack" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="requirederror.html">RequiredError</a>.<a href="requirederror.html#stack">stack</a></p>
|
||||
<ul>
|
||||
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:984</li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="requirederror.html" class="tsd-kind-icon">Required<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="requirederror.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="requirederror.html#field" class="tsd-kind-icon">field</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="requirederror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a href="requirederror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="requirederror.html#stack" class="tsd-kind-icon">stack</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a href="requirederror.html#error" class="tsd-kind-icon">Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,432 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>SearchApi | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="searchapi.html">SearchApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class SearchApi</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">SearchApi</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/searchapiinterface.html" class="tsd-signature-type">SearchApiInterface</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="searchapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="searchapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="searchapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="searchapi.html#searchbyid" class="tsd-kind-icon">search<wbr>ById</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="searchapi.html#searchbyidraw" class="tsd-kind-icon">search<wbr>ById<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="searchapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="searchapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="searchapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Search<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="searchapi.html" class="tsd-signature-type">SearchApi</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="searchapi.html" class="tsd-signature-type">SearchApi</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="searchbyid" class="tsd-anchor"></a>
|
||||
<h3>search<wbr>ById</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">search<wbr>ById<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/searchbyidrequest.html" class="tsd-signature-type">SearchByIdRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/searchapiinterface.html">SearchApiInterface</a>.<a href="../interfaces/searchapiinterface.html#searchbyid">searchById</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SearchApi.ts#L79">client/src/generated/apis/SearchApi.ts:79</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Search blocks, transactions, contracts, or accounts by hash/ID
|
||||
Search</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/searchbyidrequest.html" class="tsd-signature-type">SearchByIdRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="searchbyidraw" class="tsd-anchor"></a>
|
||||
<h3>search<wbr>ById<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">search<wbr>ById<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/searchbyidrequest.html" class="tsd-signature-type">SearchByIdRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/searchapiinterface.html">SearchApiInterface</a>.<a href="../interfaces/searchapiinterface.html#searchbyidraw">searchByIdRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SearchApi.ts#L56">client/src/generated/apis/SearchApi.ts:56</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Search blocks, transactions, contracts, or accounts by hash/ID
|
||||
Search</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/searchbyidrequest.html" class="tsd-signature-type">SearchByIdRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="searchapi.html" class="tsd-kind-icon">Search<wbr>Api</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="searchapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="searchapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="searchapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="searchapi.html#searchbyid" class="tsd-kind-icon">search<wbr>ById</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="searchapi.html#searchbyidraw" class="tsd-kind-icon">search<wbr>ById<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="searchapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="searchapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="searchapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,772 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>SmartContractsApi | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="smartcontractsapi.html">SmartContractsApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class SmartContractsApi</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">SmartContractsApi</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/smartcontractsapiinterface.html" class="tsd-signature-type">SmartContractsApiInterface</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="smartcontractsapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="smartcontractsapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#callreadonlyfunction" class="tsd-kind-icon">call<wbr>Read<wbr>Only<wbr>Function</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#callreadonlyfunctionraw" class="tsd-kind-icon">call<wbr>Read<wbr>Only<wbr>Function<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontractbyid" class="tsd-kind-icon">get<wbr>Contract<wbr>ById</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontractbyidraw" class="tsd-kind-icon">get<wbr>Contract<wbr>ById<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontractdatamapentry" class="tsd-kind-icon">get<wbr>Contract<wbr>Data<wbr>Map<wbr>Entry</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontractdatamapentryraw" class="tsd-kind-icon">get<wbr>Contract<wbr>Data<wbr>Map<wbr>Entry<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontracteventsbyid" class="tsd-kind-icon">get<wbr>Contract<wbr>Events<wbr>ById</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontracteventsbyidraw" class="tsd-kind-icon">get<wbr>Contract<wbr>Events<wbr>ById<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontractinterface" class="tsd-kind-icon">get<wbr>Contract<wbr>Interface</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontractinterfaceraw" class="tsd-kind-icon">get<wbr>Contract<wbr>Interface<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontractsource" class="tsd-kind-icon">get<wbr>Contract<wbr>Source</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="smartcontractsapi.html#getcontractsourceraw" class="tsd-kind-icon">get<wbr>Contract<wbr>Source<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="smartcontractsapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="smartcontractsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="smartcontractsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="smartcontractsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Smart<wbr>Contracts<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="smartcontractsapi.html" class="tsd-signature-type">SmartContractsApi</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="smartcontractsapi.html" class="tsd-signature-type">SmartContractsApi</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="callreadonlyfunction" class="tsd-anchor"></a>
|
||||
<h3>call<wbr>Read<wbr>Only<wbr>Function</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">call<wbr>Read<wbr>Only<wbr>Function<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/callreadonlyfunctionrequest.html" class="tsd-signature-type">CallReadOnlyFunctionRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/readonlyfunctionsuccessresponse.html" class="tsd-signature-type">ReadOnlyFunctionSuccessResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#callreadonlyfunction">callReadOnlyFunction</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L247">client/src/generated/apis/SmartContractsApi.ts:247</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Call a read-only public function on a given smart contract. The smart contract and function are specified using the URL path. The arguments and the simulated tx-sender are supplied via the POST body in the following JSON format:
|
||||
Call read-only function</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/callreadonlyfunctionrequest.html" class="tsd-signature-type">CallReadOnlyFunctionRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/readonlyfunctionsuccessresponse.html" class="tsd-signature-type">ReadOnlyFunctionSuccessResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="callreadonlyfunctionraw" class="tsd-anchor"></a>
|
||||
<h3>call<wbr>Read<wbr>Only<wbr>Function<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">call<wbr>Read<wbr>Only<wbr>Function<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/callreadonlyfunctionrequest.html" class="tsd-signature-type">CallReadOnlyFunctionRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/readonlyfunctionsuccessresponse.html" class="tsd-signature-type">ReadOnlyFunctionSuccessResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#callreadonlyfunctionraw">callReadOnlyFunctionRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L205">client/src/generated/apis/SmartContractsApi.ts:205</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Call a read-only public function on a given smart contract. The smart contract and function are specified using the URL path. The arguments and the simulated tx-sender are supplied via the POST body in the following JSON format:
|
||||
Call read-only function</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/callreadonlyfunctionrequest.html" class="tsd-signature-type">CallReadOnlyFunctionRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/readonlyfunctionsuccessresponse.html" class="tsd-signature-type">ReadOnlyFunctionSuccessResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontractbyid" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>ById</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>ById<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontractbyidrequest.html" class="tsd-signature-type">GetContractByIdRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontractbyid">getContractById</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L279">client/src/generated/apis/SmartContractsApi.ts:279</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get contract info using the contract ID
|
||||
Get contract info</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontractbyidrequest.html" class="tsd-signature-type">GetContractByIdRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontractbyidraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>ById<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>ById<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontractbyidrequest.html" class="tsd-signature-type">GetContractByIdRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontractbyidraw">getContractByIdRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L256">client/src/generated/apis/SmartContractsApi.ts:256</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get contract info using the contract ID
|
||||
Get contract info</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontractbyidrequest.html" class="tsd-signature-type">GetContractByIdRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontractdatamapentry" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>Data<wbr>Map<wbr>Entry</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Data<wbr>Map<wbr>Entry<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontractdatamapentryrequest.html" class="tsd-signature-type">GetContractDataMapEntryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mapentryresponse.html" class="tsd-signature-type">MapEntryResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontractdatamapentry">getContractDataMapEntry</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L334">client/src/generated/apis/SmartContractsApi.ts:334</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name]. The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom. In the response, <code>data</code> is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.
|
||||
Get specific data-map inside a contract</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontractdatamapentryrequest.html" class="tsd-signature-type">GetContractDataMapEntryRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mapentryresponse.html" class="tsd-signature-type">MapEntryResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontractdatamapentryraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>Data<wbr>Map<wbr>Entry<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Data<wbr>Map<wbr>Entry<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontractdatamapentryrequest.html" class="tsd-signature-type">GetContractDataMapEntryRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/mapentryresponse.html" class="tsd-signature-type">MapEntryResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontractdatamapentryraw">getContractDataMapEntryRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L288">client/src/generated/apis/SmartContractsApi.ts:288</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name]. The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom. In the response, <code>data</code> is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.
|
||||
Get specific data-map inside a contract</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontractdatamapentryrequest.html" class="tsd-signature-type">GetContractDataMapEntryRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/mapentryresponse.html" class="tsd-signature-type">MapEntryResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontracteventsbyid" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>Events<wbr>ById</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Events<wbr>ById<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontracteventsbyidrequest.html" class="tsd-signature-type">GetContractEventsByIdRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontracteventsbyid">getContractEventsById</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L374">client/src/generated/apis/SmartContractsApi.ts:374</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get contract events using a contract ID
|
||||
Get contract events</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontracteventsbyidrequest.html" class="tsd-signature-type">GetContractEventsByIdRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontracteventsbyidraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>Events<wbr>ById<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Events<wbr>ById<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontracteventsbyidrequest.html" class="tsd-signature-type">GetContractEventsByIdRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontracteventsbyidraw">getContractEventsByIdRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L343">client/src/generated/apis/SmartContractsApi.ts:343</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get contract events using a contract ID
|
||||
Get contract events</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontracteventsbyidrequest.html" class="tsd-signature-type">GetContractEventsByIdRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontractinterface" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>Interface</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Interface<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontractinterfacerequest.html" class="tsd-signature-type">GetContractInterfaceRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/contractinterfaceresponse.html" class="tsd-signature-type">ContractInterfaceResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontractinterface">getContractInterface</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L414">client/src/generated/apis/SmartContractsApi.ts:414</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get contract interface using a <code>contract_address</code> and <code>contract name</code>
|
||||
Get contract interface</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontractinterfacerequest.html" class="tsd-signature-type">GetContractInterfaceRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/contractinterfaceresponse.html" class="tsd-signature-type">ContractInterfaceResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontractinterfaceraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>Interface<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Interface<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontractinterfacerequest.html" class="tsd-signature-type">GetContractInterfaceRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/contractinterfaceresponse.html" class="tsd-signature-type">ContractInterfaceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontractinterfaceraw">getContractInterfaceRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L383">client/src/generated/apis/SmartContractsApi.ts:383</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get contract interface using a <code>contract_address</code> and <code>contract name</code>
|
||||
Get contract interface</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontractinterfacerequest.html" class="tsd-signature-type">GetContractInterfaceRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/contractinterfaceresponse.html" class="tsd-signature-type">ContractInterfaceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontractsource" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>Source</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Source<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontractsourcerequest.html" class="tsd-signature-type">GetContractSourceRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/contractsourceresponse.html" class="tsd-signature-type">ContractSourceResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontractsource">getContractSource</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L458">client/src/generated/apis/SmartContractsApi.ts:458</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
||||
Get contract source</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontractsourcerequest.html" class="tsd-signature-type">GetContractSourceRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/contractsourceresponse.html" class="tsd-signature-type">ContractSourceResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcontractsourceraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Contract<wbr>Source<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Source<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getcontractsourcerequest.html" class="tsd-signature-type">GetContractSourceRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/contractsourceresponse.html" class="tsd-signature-type">ContractSourceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/smartcontractsapiinterface.html">SmartContractsApiInterface</a>.<a href="../interfaces/smartcontractsapiinterface.html#getcontractsourceraw">getContractSourceRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/SmartContractsApi.ts#L423">client/src/generated/apis/SmartContractsApi.ts:423</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data
|
||||
Get contract source</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getcontractsourcerequest.html" class="tsd-signature-type">GetContractSourceRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/contractsourceresponse.html" class="tsd-signature-type">ContractSourceResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="smartcontractsapi.html" class="tsd-kind-icon">Smart<wbr>Contracts<wbr>Api</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="smartcontractsapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="smartcontractsapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#callreadonlyfunction" class="tsd-kind-icon">call<wbr>Read<wbr>Only<wbr>Function</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#callreadonlyfunctionraw" class="tsd-kind-icon">call<wbr>Read<wbr>Only<wbr>Function<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontractbyid" class="tsd-kind-icon">get<wbr>Contract<wbr>ById</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontractbyidraw" class="tsd-kind-icon">get<wbr>Contract<wbr>ById<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontractdatamapentry" class="tsd-kind-icon">get<wbr>Contract<wbr>Data<wbr>Map<wbr>Entry</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontractdatamapentryraw" class="tsd-kind-icon">get<wbr>Contract<wbr>Data<wbr>Map<wbr>Entry<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontracteventsbyid" class="tsd-kind-icon">get<wbr>Contract<wbr>Events<wbr>ById</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontracteventsbyidraw" class="tsd-kind-icon">get<wbr>Contract<wbr>Events<wbr>ById<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontractinterface" class="tsd-kind-icon">get<wbr>Contract<wbr>Interface</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontractinterfaceraw" class="tsd-kind-icon">get<wbr>Contract<wbr>Interface<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontractsource" class="tsd-kind-icon">get<wbr>Contract<wbr>Source</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="smartcontractsapi.html#getcontractsourceraw" class="tsd-kind-icon">get<wbr>Contract<wbr>Source<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="smartcontractsapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="smartcontractsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="smartcontractsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="smartcontractsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,488 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>StacksApiWebSocketClient | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="stacksapiwebsocketclient.html">StacksApiWebSocketClient</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class StacksApiWebSocketClient</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">StacksApiWebSocketClient</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="stacksapiwebsocketclient.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stacksapiwebsocketclient.html#eventemitter" class="tsd-kind-icon">event<wbr>Emitter</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stacksapiwebsocketclient.html#idcursor" class="tsd-kind-icon">id<wbr>Cursor</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stacksapiwebsocketclient.html#pendingrequests" class="tsd-kind-icon">pending<wbr>Requests</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stacksapiwebsocketclient.html#websocket" class="tsd-kind-icon">web<wbr>Socket</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacksapiwebsocketclient.html#handlenotification" class="tsd-kind-icon">handle<wbr>Notification</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="stacksapiwebsocketclient.html#rpccall" class="tsd-kind-icon">rpc<wbr>Call</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacksapiwebsocketclient.html#subscribeaddressbalanceupdates" class="tsd-kind-icon">subscribe<wbr>Address<wbr>Balance<wbr>Updates</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacksapiwebsocketclient.html#subscribeaddresstransactions" class="tsd-kind-icon">subscribe<wbr>Address<wbr>Transactions</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stacksapiwebsocketclient.html#subscribetxupdates" class="tsd-kind-icon">subscribe<wbr>TxUpdates</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="stacksapiwebsocketclient.html#connect" class="tsd-kind-icon">connect</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Stacks<wbr>Api<wbr>Web<wbr>Socket<wbr>Client<span class="tsd-signature-symbol">(</span>webSocket<span class="tsd-signature-symbol">: </span><a href="../globals.html#iwebsocket" class="tsd-signature-type">IWebSocket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="stacksapiwebsocketclient.html" class="tsd-signature-type">StacksApiWebSocketClient</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L56">client/src/ws/index.ts:56</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>webSocket: <a href="../globals.html#iwebsocket" class="tsd-signature-type">IWebSocket</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="stacksapiwebsocketclient.html" class="tsd-signature-type">StacksApiWebSocketClient</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="eventemitter" class="tsd-anchor"></a>
|
||||
<h3>event<wbr>Emitter</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">event<wbr>Emitter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>addressBalanceUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcAddressBalanceNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>addressTxUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcAddressTxNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>txUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcTxUpdateNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new EventEmitter<{txUpdate: (event: RpcTxUpdateNotificationParams) => any;addressTxUpdate: (event: RpcAddressTxNotificationParams) => void;addressBalanceUpdate: (event: RpcAddressBalanceNotificationParams) => void;}>()</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L28">client/src/ws/index.ts:28</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="idcursor" class="tsd-anchor"></a>
|
||||
<h3>id<wbr>Cursor</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">id<wbr>Cursor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L22">client/src/ws/index.ts:22</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="pendingrequests" class="tsd-anchor"></a>
|
||||
<h3>pending<wbr>Requests</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">pending<wbr>Requests<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ID</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>reject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>resolve<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Map<JsonRpcLite.ID,{ resolve: (result: any) => void; reject: (error: any) => void }>()</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L23">client/src/ws/index.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="websocket" class="tsd-anchor"></a>
|
||||
<h3>web<wbr>Socket</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">web<wbr>Socket<span class="tsd-signature-symbol">:</span> <a href="../globals.html#iwebsocket" class="tsd-signature-type">IWebSocket</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L21">client/src/ws/index.ts:21</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="handlenotification" class="tsd-anchor"></a>
|
||||
<h3>handle<wbr>Notification</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">handle<wbr>Notification<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NotificationObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L83">client/src/ws/index.ts:83</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>data: <span class="tsd-signature-type">NotificationObject</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
||||
<a name="rpccall" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagPrivate">Private</span> rpc<wbr>Call</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
||||
<li class="tsd-signature tsd-kind-icon">rpc<wbr>Call<TResult><span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TResult</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L101">client/src/ws/index.ts:101</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>TResult</h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>method: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>params: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TResult</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="subscribeaddressbalanceupdates" class="tsd-anchor"></a>
|
||||
<h3>subscribe<wbr>Address<wbr>Balance<wbr>Updates</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>Address<wbr>Balance<wbr>Updates<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcAddressBalanceNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/subscription.html" class="tsd-signature-type">Subscription</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L149">client/src/ws/index.ts:149</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>update: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcAddressBalanceNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcAddressBalanceNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">RpcAddressBalanceNotificationParams</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/subscription.html" class="tsd-signature-type">Subscription</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="subscribeaddresstransactions" class="tsd-anchor"></a>
|
||||
<h3>subscribe<wbr>Address<wbr>Transactions</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>Address<wbr>Transactions<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcAddressTxNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/subscription.html" class="tsd-signature-type">Subscription</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L129">client/src/ws/index.ts:129</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>address: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>update: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcAddressTxNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcAddressTxNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">RpcAddressTxNotificationParams</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/subscription.html" class="tsd-signature-type">Subscription</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="subscribetxupdates" class="tsd-anchor"></a>
|
||||
<h3>subscribe<wbr>TxUpdates</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">subscribe<wbr>TxUpdates<span class="tsd-signature-symbol">(</span>txId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcTxUpdateNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/subscription.html" class="tsd-signature-type">Subscription</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L109">client/src/ws/index.ts:109</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>txId: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>update: <span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcTxUpdateNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RpcTxUpdateNotificationParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">RpcTxUpdateNotificationParams</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/subscription.html" class="tsd-signature-type">Subscription</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a name="connect" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> connect</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="stacksapiwebsocketclient.html" class="tsd-signature-type">StacksApiWebSocketClient</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/ws/index.ts#L34">client/src/ws/index.ts:34</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> url: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="stacksapiwebsocketclient.html" class="tsd-signature-type">StacksApiWebSocketClient</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html" class="tsd-kind-icon">Stacks<wbr>Api<wbr>Web<wbr>Socket<wbr>Client</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html#eventemitter" class="tsd-kind-icon">event<wbr>Emitter</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html#idcursor" class="tsd-kind-icon">id<wbr>Cursor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html#pendingrequests" class="tsd-kind-icon">pending<wbr>Requests</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html#websocket" class="tsd-kind-icon">web<wbr>Socket</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html#handlenotification" class="tsd-kind-icon">handle<wbr>Notification</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private">
|
||||
<a href="stacksapiwebsocketclient.html#rpccall" class="tsd-kind-icon">rpc<wbr>Call</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html#subscribeaddressbalanceupdates" class="tsd-kind-icon">subscribe<wbr>Address<wbr>Balance<wbr>Updates</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html#subscribeaddresstransactions" class="tsd-kind-icon">subscribe<wbr>Address<wbr>Transactions</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="stacksapiwebsocketclient.html#subscribetxupdates" class="tsd-kind-icon">subscribe<wbr>TxUpdates</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a href="stacksapiwebsocketclient.html#connect" class="tsd-kind-icon">connect</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,233 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>TextApiResponse | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="textapiresponse.html">TextApiResponse</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class TextApiResponse</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">TextApiResponse</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="textapiresponse.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="textapiresponse.html#raw" class="tsd-kind-icon">raw</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="textapiresponse.html#value" class="tsd-kind-icon">value</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Text<wbr>Api<wbr>Response<span class="tsd-signature-symbol">(</span>raw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="textapiresponse.html" class="tsd-signature-type">TextApiResponse</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L310">client/src/generated/runtime.ts:310</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>raw: <span class="tsd-signature-type">Response</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="textapiresponse.html" class="tsd-signature-type">TextApiResponse</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="raw" class="tsd-anchor"></a>
|
||||
<h3>raw</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Response</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L311">client/src/generated/runtime.ts:311</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="value" class="tsd-anchor"></a>
|
||||
<h3>value</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L313">client/src/generated/runtime.ts:313</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="textapiresponse.html" class="tsd-kind-icon">Text<wbr>Api<wbr>Response</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="textapiresponse.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="textapiresponse.html#raw" class="tsd-kind-icon">raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="textapiresponse.html#value" class="tsd-kind-icon">value</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,636 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>TransactionsApi | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="transactionsapi.html">TransactionsApi</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class TransactionsApi</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="baseapi.html" class="tsd-signature-type">BaseAPI</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">TransactionsApi</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel">
|
||||
<h3>Implements</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li><a href="../interfaces/transactionsapiinterface.html" class="tsd-signature-type">TransactionsApiInterface</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="transactionsapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="transactionsapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionsapi.html#getmempooltransactionlist" class="tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionsapi.html#getmempooltransactionlistraw" class="tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionsapi.html#gettransactionbyid" class="tsd-kind-icon">get<wbr>Transaction<wbr>ById</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionsapi.html#gettransactionbyidraw" class="tsd-kind-icon">get<wbr>Transaction<wbr>ById<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionsapi.html#gettransactionlist" class="tsd-kind-icon">get<wbr>Transaction<wbr>List</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionsapi.html#gettransactionlistraw" class="tsd-kind-icon">get<wbr>Transaction<wbr>List<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionsapi.html#postcorenodetransactions" class="tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionsapi.html#postcorenodetransactionsraw" class="tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions<wbr>Raw</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="transactionsapi.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="transactionsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="transactionsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="transactionsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Transactions<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transactionsapi.html" class="tsd-signature-type">TransactionsApi</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L25">client/src/generated/runtime.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> configuration: <a href="configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> = new Configuration()</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="transactionsapi.html" class="tsd-signature-type">TransactionsApi</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="configuration" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="configuration.html" class="tsd-signature-type">Configuration</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#configuration">configuration</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L27">client/src/generated/runtime.ts:27</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getmempooltransactionlist" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Mempool<wbr>Transaction<wbr>List</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getmempooltransactionlistrequest.html" class="tsd-signature-type">GetMempoolTransactionListRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mempooltransactionlistresponse.html" class="tsd-signature-type">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/transactionsapiinterface.html#getmempooltransactionlist">getMempoolTransactionList</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/TransactionsApi.ts#L182">client/src/generated/apis/TransactionsApi.ts:182</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all recently-broadcast mempool transactions
|
||||
Get mempool transactions</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getmempooltransactionlistrequest.html" class="tsd-signature-type">GetMempoolTransactionListRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/mempooltransactionlistresponse.html" class="tsd-signature-type">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getmempooltransactionlistraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/getmempooltransactionlistrequest.html" class="tsd-signature-type">GetMempoolTransactionListRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/mempooltransactionlistresponse.html" class="tsd-signature-type">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/transactionsapiinterface.html#getmempooltransactionlistraw">getMempoolTransactionListRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/TransactionsApi.ts#L143">client/src/generated/apis/TransactionsApi.ts:143</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all recently-broadcast mempool transactions
|
||||
Get mempool transactions</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/getmempooltransactionlistrequest.html" class="tsd-signature-type">GetMempoolTransactionListRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/mempooltransactionlistresponse.html" class="tsd-signature-type">MempoolTransactionListResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="gettransactionbyid" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Transaction<wbr>ById</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>ById<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/gettransactionbyidrequest.html" class="tsd-signature-type">GetTransactionByIdRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/transactionsapiinterface.html#gettransactionbyid">getTransactionById</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/TransactionsApi.ts#L222">client/src/generated/apis/TransactionsApi.ts:222</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a specific transaction by ID <code>import type { Transaction } from \'@blockstack/stacks-blockchain-api-types\';</code>
|
||||
Get transaction</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/gettransactionbyidrequest.html" class="tsd-signature-type">GetTransactionByIdRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="gettransactionbyidraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Transaction<wbr>ById<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>ById<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/gettransactionbyidrequest.html" class="tsd-signature-type">GetTransactionByIdRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/transactionsapiinterface.html#gettransactionbyidraw">getTransactionByIdRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/TransactionsApi.ts#L191">client/src/generated/apis/TransactionsApi.ts:191</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a specific transaction by ID <code>import type { Transaction } from \'@blockstack/stacks-blockchain-api-types\';</code>
|
||||
Get transaction</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/gettransactionbyidrequest.html" class="tsd-signature-type">GetTransactionByIdRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="gettransactionlist" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Transaction<wbr>List</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>List<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/gettransactionlistrequest.html" class="tsd-signature-type">GetTransactionListRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/transactionresults.html" class="tsd-signature-type">TransactionResults</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/transactionsapiinterface.html#gettransactionlist">getTransactionList</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/TransactionsApi.ts#L262">client/src/generated/apis/TransactionsApi.ts:262</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all recently mined transactions If using TypeScript, import typings for this response from our types package: <code>import type { TransactionResults } from \'@blockstack/stacks-blockchain-api-types\';</code>
|
||||
Get recent transactions</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/gettransactionlistrequest.html" class="tsd-signature-type">GetTransactionListRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/transactionresults.html" class="tsd-signature-type">TransactionResults</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="gettransactionlistraw" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Transaction<wbr>List<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Transaction<wbr>List<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/gettransactionlistrequest.html" class="tsd-signature-type">GetTransactionListRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/transactionresults.html" class="tsd-signature-type">TransactionResults</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/transactionsapiinterface.html#gettransactionlistraw">getTransactionListRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/TransactionsApi.ts#L231">client/src/generated/apis/TransactionsApi.ts:231</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all recently mined transactions If using TypeScript, import typings for this response from our types package: <code>import type { TransactionResults } from \'@blockstack/stacks-blockchain-api-types\';</code>
|
||||
Get recent transactions</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/gettransactionlistrequest.html" class="tsd-signature-type">GetTransactionListRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/transactionresults.html" class="tsd-signature-type">TransactionResults</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="postcorenodetransactions" class="tsd-anchor"></a>
|
||||
<h3>post<wbr>Core<wbr>Node<wbr>Transactions</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/postcorenodetransactionsrequest.html" class="tsd-signature-type">PostCoreNodeTransactionsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/transactionsapiinterface.html#postcorenodetransactions">postCoreNodeTransactions</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/TransactionsApi.ts#L293">client/src/generated/apis/TransactionsApi.ts:293</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Broadcast raw transactions on the network. You can use the <a href="https://github.com/blockstack/stacks.js">@stacks/transactions</a> project to generate a raw transaction payload.
|
||||
Broadcast raw transaction</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/postcorenodetransactionsrequest.html" class="tsd-signature-type">PostCoreNodeTransactionsRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="postcorenodetransactionsraw" class="tsd-anchor"></a>
|
||||
<h3>post<wbr>Core<wbr>Node<wbr>Transactions<wbr>Raw</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/postcorenodetransactionsrequest.html" class="tsd-signature-type">PostCoreNodeTransactionsRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/transactionsapiinterface.html">TransactionsApiInterface</a>.<a href="../interfaces/transactionsapiinterface.html#postcorenodetransactionsraw">postCoreNodeTransactionsRaw</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/apis/TransactionsApi.ts#L271">client/src/generated/apis/TransactionsApi.ts:271</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Broadcast raw transactions on the network. You can use the <a href="https://github.com/blockstack/stacks.js">@stacks/transactions</a> project to generate a raw transaction payload.
|
||||
Broadcast raw transaction</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>requestParameters: <a href="../interfaces/postcorenodetransactionsrequest.html" class="tsd-signature-type">PostCoreNodeTransactionsRequest</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/apiresponse.html" class="tsd-signature-type">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#request">request</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L47">client/src/generated/runtime.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>context: <a href="../interfaces/requestopts.html" class="tsd-signature-type">RequestOpts</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withmiddleware">withMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L31">client/src/generated/runtime.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/middleware.html" class="tsd-signature-type">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Post<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L42">client/src/generated/runtime.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"post"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a name="withpremiddleware" class="tsd-anchor"></a>
|
||||
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, <span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="baseapi.html">BaseAPI</a>.<a href="baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L37">client/src/generated/runtime.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><a href="baseapi.html" class="tsd-signature-type">BaseAPI</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>this: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Middleware</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"pre"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="transactionsapi.html" class="tsd-kind-icon">Transactions<wbr>Api</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="transactionsapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="transactionsapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="transactionsapi.html#getmempooltransactionlist" class="tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="transactionsapi.html#getmempooltransactionlistraw" class="tsd-kind-icon">get<wbr>Mempool<wbr>Transaction<wbr>List<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="transactionsapi.html#gettransactionbyid" class="tsd-kind-icon">get<wbr>Transaction<wbr>ById</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="transactionsapi.html#gettransactionbyidraw" class="tsd-kind-icon">get<wbr>Transaction<wbr>ById<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="transactionsapi.html#gettransactionlist" class="tsd-kind-icon">get<wbr>Transaction<wbr>List</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="transactionsapi.html#gettransactionlistraw" class="tsd-kind-icon">get<wbr>Transaction<wbr>List<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="transactionsapi.html#postcorenodetransactions" class="tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="transactionsapi.html#postcorenodetransactionsraw" class="tsd-kind-icon">post<wbr>Core<wbr>Node<wbr>Transactions<wbr>Raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="transactionsapi.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="transactionsapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="transactionsapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
||||
<a href="transactionsapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,233 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>VoidApiResponse | @stacks/blockchain-api-client</title>
|
||||
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">@stacks/blockchain-api-client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="voidapiresponse.html">VoidApiResponse</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class VoidApiResponse</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">VoidApiResponse</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="voidapiresponse.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="voidapiresponse.html#raw" class="tsd-kind-icon">raw</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="voidapiresponse.html#value" class="tsd-kind-icon">value</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Void<wbr>Api<wbr>Response<span class="tsd-signature-symbol">(</span>raw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="voidapiresponse.html" class="tsd-signature-type">VoidApiResponse</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L294">client/src/generated/runtime.ts:294</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>raw: <span class="tsd-signature-type">Response</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="voidapiresponse.html" class="tsd-signature-type">VoidApiResponse</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="raw" class="tsd-anchor"></a>
|
||||
<h3>raw</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Response</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L295">client/src/generated/runtime.ts:295</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="value" class="tsd-anchor"></a>
|
||||
<h3>value</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-sidecar/blob/83c3ccd/client/src/generated/runtime.ts#L297">client/src/generated/runtime.ts:297</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="voidapiresponse.html" class="tsd-kind-icon">Void<wbr>Api<wbr>Response</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="voidapiresponse.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="voidapiresponse.html#raw" class="tsd-kind-icon">raw</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="voidapiresponse.html#value" class="tsd-kind-icon">value</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user