/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/extended": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * API status * @description Retrieves the running status of the Stacks Blockchain API, including the server version and current chain tip information. */ get: operations["get_status"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tx/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get recent transactions * @deprecated * @description Retrieves all recently mined transactions. **Deprecated:** use `GET /extended/v3/transactions` instead. */ get: operations["get_transaction_list"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tx/multiple": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get list of details for transactions * @deprecated * @description Retrieves a list of transactions for a given list of transaction IDs. **Deprecated:** use `GET /extended/v3/transactions/batch` instead. Note two differences: the v3 endpoint returns mined transactions only, so use `GET /extended/v3/transactions/{tx_id}` for a transaction that may still be in the mempool; and it returns a `results` array rather than a map keyed by transaction id, so ids that do not resolve are absent from the response instead of being reported as `found: false`. */ get: operations["get_tx_list_details"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tx/mempool": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get mempool transactions * @deprecated * @description Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation. * * If you need to monitor new transactions, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/main/client) for real-time updates. * * **Deprecated:** use `GET /extended/v3/mempool/transactions` instead. */ get: operations["get_mempool_transaction_list"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tx/mempool/stats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get statistics for mempool transactions * @description Queries for transactions counts, age (by block height), fees (simple average), and size. * All results broken down by transaction type and percentiles (p25, p50, p75, p95). */ get: operations["get_mempool_transaction_stats"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tx/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Transaction Events * @deprecated * @description Retrieves the list of events filtered by principal (STX address or Smart Contract ID), transaction id or event types. * The list of event types is ('smart_contract_log', 'stx_lock', 'stx_asset', 'fungible_token_asset', 'non_fungible_token_asset'). * * **Deprecated:** this endpoint has no direct v3 replacement. */ get: operations["get_filtered_events"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tx/{tx_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get transaction * @deprecated * @description Retrieves transaction details for a given transaction ID. **Deprecated:** use `GET /extended/v3/transactions/{tx_id}` instead. */ get: operations["get_transaction_by_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tx/{tx_id}/raw": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get raw transaction * @deprecated * @description Retrieves a hex encoded serialized transaction for a given ID. **Deprecated:** use the Stacks node RPC endpoint `GET /v3/transaction/{tx_id}` to fetch a single raw transaction instead. */ get: operations["get_raw_transaction_by_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tx/block/{block_hash}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Transactions by block hash * @deprecated * @description Retrieves a list of all transactions within a block for a given block hash. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead. */ get: operations["get_transactions_by_block_hash"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tx/block_height/{height}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Transactions by block height * @deprecated * @description Retrieves all transactions within a block at a given height. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead. */ get: operations["get_transactions_by_block_height"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/stx_supply/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get total and unlocked STX supply * @deprecated * @description Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/block-production/stacking). **This endpoint is deprecated in favor of the v3 `get_stx_total_supply` endpoint (`/extended/v3/tokens/stx/supply`), which returns amounts in micro-STX (µSTX).** */ get: operations["get_stx_supply"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/stx_supply/total/plain": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get total STX supply in plain text format * @deprecated * @description Retrieves the total circulating STX token supply as plain text. **This endpoint is deprecated in favor of the v3 `get_stx_total_supply` endpoint (`/extended/v3/tokens/stx/supply`), which returns amounts in micro-STX (µSTX).** */ get: operations["get_stx_supply_total_supply_plain"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/stx_supply/circulating/plain": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get circulating STX supply in plain text format * @deprecated * @description Retrieves the STX tokens currently in circulation that have been unlocked as plain text. **This endpoint is deprecated in favor of the v3 `get_stx_total_supply` endpoint (`/extended/v3/tokens/stx/supply`), which returns amounts in micro-STX (µSTX).** */ get: operations["get_stx_supply_circulating_plain"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/stx_supply/legacy_format": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API) * @deprecated * @description Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **This endpoint is deprecated in favor of the v3 `get_stx_total_supply` endpoint (`/extended/v3/tokens/stx/supply`), which returns amounts in micro-STX (µSTX).** */ get: operations["get_total_stx_supply_legacy_format"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/info/network_block_times": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the network target block time * @deprecated * @description Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet. **Deprecated:** this endpoint returns hardcoded legacy values that no longer reflect actual Stacks block production since the Nakamoto upgrade. */ get: operations["get_network_block_times"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/info/network_block_time/{network}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a given network's target block time * @deprecated * @description Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet. **Deprecated:** this endpoint returns hardcoded legacy values that no longer reflect actual Stacks block production since the Nakamoto upgrade. */ get: operations["get_network_block_time_by_network"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tokens/nft/holdings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Non-Fungible Token holdings * @deprecated * @description Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID). * Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token. * * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft). * * **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/nft` instead. */ get: operations["get_nft_holdings"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tokens/nft/history": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Non-Fungible Token history * @deprecated * @description Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset. * * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft). */ get: operations["get_nft_history"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tokens/nft/mints": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Non-Fungible Token mints * @deprecated * @description Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed. * * More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft). */ get: operations["get_nft_mints"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/tokens/ft/{token}/holders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fungible token holders * @deprecated * @description Retrieves the list of Fungible Token holders for a given token ID. Specify `stx` for the `token` parameter to get the list of STX holders. **Deprecated:** use `GET /extended/v3/tokens/ft/{asset_identifier}/holders` (or `GET /extended/v3/tokens/stx/holders` for STX) instead. The `total_supply` field moved to `GET /extended/v3/tokens/ft/{asset_identifier}/supply`. */ get: operations["get_ft_holders"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/contract/by_trait": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get contracts by trait * @deprecated * @description Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens. **Deprecated:** this endpoint has no direct v3 replacement. */ get: operations["get_contracts_by_trait"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/contract/{contract_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get contract info * @deprecated * @description Retrieves details of a contract with a given `contract_id`. **Deprecated:** use `GET /extended/v3/smart-contracts/{contract_id}` instead. For the contract ABI, use the Stacks node RPC endpoint `GET /v2/contracts/interface/{address}/{name}`. */ get: operations["get_contract_by_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/contract/{contract_id}/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get contract events * @deprecated * @description **NOTE:** This endpoint is deprecated in favor of `get_smart_contract_logs`. * * Retrieves a list of events that have been triggered by a given `contract_id` */ get: operations["get_contract_events_by_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/fee_rate/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Fetch fee rate * @deprecated * @description **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](/api/get-approximate-fees-for-a-given-transaction). * * Retrieves estimated fee rate. */ post: operations["fetch_fee_rate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/block/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get recent blocks * @deprecated * @description Retrieves a list of recently mined blocks. **This endpoint is deprecated in favor of `get_blocks`.** */ get: operations["get_block_list"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/block/by_height/{height}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get block by height * @deprecated * @description Retrieves block details of a specific block at a given block height. **This endpoint is deprecated in favor of `get_block`.** */ get: operations["get_block_by_height"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/block/by_burn_block_height/{burn_block_height}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get block by burnchain height * @deprecated * @description Retrieves block details of a specific block for a given burn chain height. **This endpoint is deprecated in favor of `get_blocks_by_burn_block`.** */ get: operations["get_block_by_burn_block_height"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/block/{hash}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get block by hash * @deprecated * @description Retrieves block details of a specific block for a given chain height. **This endpoint is deprecated in favor of `get_block`.** */ get: operations["get_block_by_hash"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/block/by_burn_block_hash/{burn_block_hash}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get block by burnchain block hash * @deprecated * @description Retrieves block details of a specific block for a given burnchain block hash. **This endpoint is deprecated in favor of `get_blocks_by_burn_block`.** */ get: operations["get_block_by_burn_block_hash"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/burnchain/reward_slot_holders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get recent reward slot holders * @deprecated * @description Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments. **Deprecated:** this endpoint serves historical pox-4 and earlier data only. */ get: operations["get_burnchain_reward_slot_holders"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/burnchain/reward_slot_holders/{address}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get recent reward slot holder entries for the given address * @deprecated * @description Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address. **Deprecated:** this endpoint serves historical pox-4 and earlier data only. */ get: operations["get_burnchain_reward_slot_holders_by_address"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/burnchain/rewards": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get recent burnchain reward recipients * @deprecated * @description Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info. **Deprecated:** this endpoint serves historical pox-4 and earlier data only. */ get: operations["get_burnchain_reward_list"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/burnchain/rewards/{address}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get recent burnchain reward for the given recipient * @deprecated * @description Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info. **Deprecated:** this endpoint serves historical pox-4 and earlier data only. */ get: operations["get_burnchain_reward_list_by_address"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/burnchain/rewards/{address}/total": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get total burnchain rewards for the given recipient * @deprecated * @description Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address`. **Deprecated:** this endpoint serves historical pox-4 and earlier data only. */ get: operations["get_burnchain_rewards_total_by_address"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/address/{principal}/stx": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get account STX balance * @deprecated * @description Retrieves STX token balance for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead. */ get: operations["get_account_stx_balance"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/address/{principal}/balances": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get account balances * @deprecated * @description Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx`, `GET /extended/v3/principals/{principal}/balances/ft`, and `GET /extended/v3/principals/{principal}/balances/nft` instead. */ get: operations["get_account_balance"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/address/{principal}/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get account transactions * @deprecated * @description Retrieves a list of all Transactions for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead. */ get: operations["get_account_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/address/{principal}/{tx_id}/with_transfers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get account transaction information for specific transaction * @deprecated * @description Retrieves transaction details for a given Transaction Id, for a given account or contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead. */ get: operations["get_single_transaction_with_transfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/address/{principal}/transactions_with_transfers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get account transactions including STX transfers for each transaction. * @deprecated * @description Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead. */ get: operations["get_account_transactions_with_transfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/address/{principal}/assets": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get account assets * @deprecated * @description Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. **Deprecated:** this endpoint has no direct v3 replacement; the closest equivalent is `GET /extended/v3/principals/{principal}/balance-changes`. */ get: operations["get_account_assets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/address/{principal}/stx_inbound": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get inbound STX transfers * @deprecated * @description Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions at the `send-many-memo` bulk sending contract. **Deprecated:** use `GET /extended/v3/principals/{principal}/transfers/stx/inbound` (`get_principal_inbound_stx_transfers`) instead. */ get: operations["get_account_inbound"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/address/{principal}/mempool": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Transactions for address * @deprecated * @description Retrieves all transactions for a given address that are currently in mempool. **Deprecated:** use `GET /extended/v3/principals/{principal}/mempool/transactions` instead. */ get: operations["get_address_mempool_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/address/{principal}/nonces": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the latest nonce used by an account * @deprecated * @description Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions. **Deprecated:** use `GET /extended/v3/principals/{principal}/nonces` instead. */ get: operations["get_account_nonces"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/search/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Search * @description Search blocks, transactions, contracts, or accounts by hash/ID */ get: operations["search_by_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/{pox}/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get latest PoX events * @deprecated * @description Retrieves the most recent PoX events. **Deprecated:** Historical pox-4 and earlier data only. No pox-5 replacement; there is no global pox-5 event feed. */ get: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { pox: "pox2" | "pox3" | "pox4"; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/{pox}/tx/{tx_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get PoX events for a transaction * @deprecated * @description Retrieves the PoX events produced by a given transaction. **Deprecated:** Historical pox-4 and earlier data only. No pox-5 replacement; v3 transaction events do not carry decoded pox operations. */ get: { parameters: { query?: never; header?: never; path: { pox: "pox2" | "pox3" | "pox4"; tx_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/{pox}/stacker/{principal}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get events for a stacking address * @deprecated * @description Retrieves the PoX events for a given stacker principal. **Deprecated:** Historical pox-4 and earlier data only. For a principal's current pox-5 position see /extended/v3/principals/{principal}/staking; there is no pox-5 event history equivalent. */ get: { parameters: { query?: never; header?: never; path: { pox: "pox2" | "pox3" | "pox4"; principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/{pox}/{pool_principal}/delegations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Stacking pool members * @deprecated * @description Retrieves the list of stacking pool members for a given delegator principal. **Deprecated:** Historical pox-4 and earlier data only. See /extended/v3/staking/signers/{principal}/stakers for the pox-5 equivalent. */ get: operations["get_pool_delegations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/faucets/btc": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Get BTC regtest tokens * @description Add 0.01 BTC token to the specified regtest BTC address. * * The endpoint returns the transaction ID, which you can use to view the transaction in a regtest Bitcoin block * explorer. The tokens are delivered once the transaction has been included in a block. * * **Note:** This is a Bitcoin regtest-only endpoint. This endpoint will not work on the Bitcoin mainnet. */ post: operations["run_faucet_btc"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/faucets/btc/{address}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get BTC balance for address * @deprecated * @description Get the BTC balance for an address. **This endpoint is deprecated.** */ get: operations["get_btc_balance"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/faucets/stx": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Get STX testnet tokens * @description Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with `ST`. If the `stacking` * parameter is set to `true`, the faucet will add the required number of tokens for individual stacking to the * specified testnet address. * * The endpoint returns the transaction ID, which you can use to view the transaction in the * [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has * been included in an anchor block. * * A common reason for failed faucet transactions is that the faucet has run out of tokens. If you are experiencing * failed faucet transactions to a testnet address, you can get help in [Discord](https://stacks.chat). * * **Note:** This is a testnet only endpoint. This endpoint will not work on the mainnet. */ post: operations["run_faucet_stx"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v1/faucets/sbtc": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Get sBTC testnet tokens * @description Add sBTC tokens to the specified testnet address. The endpoint performs a SIP-010 `transfer` * contract call on the configured testnet sBTC token contract. Testnet STX addresses begin with `ST`. * * The endpoint returns the transaction ID, which you can use to view the transaction in the * [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has * been included in a block. * * **Note:** This is a testnet only endpoint. This endpoint will not work on mainnet. */ post: operations["run_faucet_sbtc"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/blocks/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get blocks * @description Retrieves a list of recently mined blocks */ get: operations["get_blocks"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/blocks/average-times": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get average block times * @description Retrieves average block times (in seconds) */ get: operations["get_average_block_times"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/blocks/by-block-time/{timestamp}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get block by block time * @description Retrieves the most recent block mined at or before a given Unix timestamp (in seconds) */ get: operations["get_block_by_block_time"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/blocks/{height_or_hash}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get block * @description Retrieves a single block */ get: operations["get_block"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/blocks/{height_or_hash}/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get transactions by block * @deprecated * @description Retrieves transactions confirmed in a single block. **Deprecated:** use `GET /extended/v3/blocks/{height_or_hash}/transactions` instead. */ get: operations["get_transactions_by_block"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/blocks/{height_or_hash}/signer-signatures": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get signer signatures for block * @description Retrieves the signer signatures (an array of signature byte strings) in a single block */ get: operations["get_signer_signatures_for_block"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/burn-blocks/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get burn blocks * @description Retrieves a list of recent burn blocks */ get: operations["get_burn_blocks"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/burn-blocks/{height_or_hash}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get burn block * @description Retrieves a single burn block */ get: operations["get_burn_block"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/burn-blocks/{height_or_hash}/blocks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get blocks by burn block * @description Retrieves a list of blocks confirmed by a specific burn block */ get: operations["get_blocks_by_burn_block"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/burn-blocks/{height_or_hash}/pox-transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get PoX transactions by burn block * @description Retrieves a list of PoX transactions confirmed by a specific burn block */ get: operations["get_burn_block_pox_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/block-tenures/{tenure_height}/blocks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get blocks by tenure * @description Retrieves blocks confirmed in a block tenure */ get: operations["get_tenure_blocks"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/smart-contracts/status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get smart contracts status * @description Retrieves the deployment status of multiple smart contracts. */ get: operations["get_smart_contracts_status"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/smart-contracts/{contract_id}/logs": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get smart contract logs * @description Retrieves contract log events for a given smart contract. */ get: operations["get_smart_contract_logs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/mempool/fees": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get mempool transaction fee priorities * @description Returns estimated fee priorities (in micro-STX) for all transactions that are currently in the mempool. Also returns priorities separated by transaction type. */ get: operations["get_mempool_fee_priorities"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/pox/cycles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get PoX cycles * @description Retrieves a list of PoX cycles */ get: operations["get_pox_cycles"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/pox/cycles/{cycle_number}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get PoX cycle * @description Retrieves details for a PoX cycle */ get: operations["get_pox_cycle"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/pox/cycles/{cycle_number}/signers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get signers in PoX cycle * @description Retrieves a list of signers in a PoX cycle */ get: operations["get_pox_cycle_signers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get signer in PoX cycle * @description Retrieves details for a signer in a PoX cycle */ get: operations["get_pox_cycle_signer"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get stackers for signer in PoX cycle * @description Retrieves a list of stackers for a signer in a PoX cycle */ get: operations["get_pox_cycle_signer_stackers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/addresses/{address}/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get address transactions * @deprecated * @description Retrieves a paginated list of confirmed transactions sent or received by a STX address or Smart Contract ID, alongside the total amount of STX sent or received and the number of STX, FT and NFT transfers contained within each transaction. * * More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types). * * **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions` instead. */ get: operations["get_address_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/addresses/{address}/transactions/{tx_id}/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get events for an address transaction * @deprecated * @description Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction. **Deprecated:** use `GET /extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes` instead. */ get: operations["get_address_transaction_events"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/addresses/{principal}/balances/stx": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal STX balance * @deprecated * @description Retrieves STX account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/stx` instead. */ get: operations["get_principal_stx_balance"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/addresses/{principal}/balances/ft": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal FT balances * @deprecated * @description Retrieves Fungible-token account balance information for a given Address or Contract Identifier. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft` instead. */ get: operations["get_principal_ft_balances"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/addresses/{principal}/balances/ft/{token}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal FT balance * @deprecated * @description Retrieves a specific fungible-token balance for a given principal. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/ft/{asset_identifier}` instead. */ get: operations["get_principal_ft_balance"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v2/addresses/{burnchain_address}/pox-transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get PoX transactions for a burnchain address * @description Retrieves a list of PoX transactions */ get: operations["get_burnchain_address_pox_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/blocks/{height_or_hash}/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get block transactions * @description Retrieves transactions confirmed in a single block */ get: operations["get_block_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/mempool/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get mempool transactions * @description Retrieves a list of recently broadcasted transactions */ get: operations["get_mempool_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal transactions * @description Returns a list of confirmed transactions sent or received by a Stacks principal, including the transaction summary, the involvement of the principal in the transaction, and the balances affected by the transaction. */ get: operations["get_principal_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/transfers/stx/inbound": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get inbound STX transfers * @description Returns the individual inbound STX events crediting a principal. Includes native stx-transfer transactions, `send-many-memo` bulk-send legs, any other STX transfer event crediting the principal, and STX mints (which have a null `sender`), each with its own sender, amount, and memo. A transaction that credits the principal multiple times yields one result per event. */ get: operations["get_principal_inbound_stx_transfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/transfers/stx/outbound": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get outbound STX transfers * @description Returns the individual outbound STX events debiting a principal. Includes native stx-transfer transactions, `send-many-memo` bulk-send legs, any other STX transfer event debiting the principal, and STX burns (which have a null `recipient`), each with its own recipient, amount, and memo. A transaction that debits the principal multiple times yields one result per event. */ get: operations["get_principal_outbound_stx_transfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/transfers/ft/{asset_identifier}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get fungible token transfers * @description Returns a principal's transfer history for a single fungible token as one feed, newest first, combining the events that credit it and the events that debit it. Includes mints (which have a null `sender`) and burns (which have a null `recipient`). A transaction that moves the token several times for this principal yields one result per event. Amounts are in the token's own base units. */ get: operations["get_principal_ft_transfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/transactions/{tx_id}/balance-changes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal transaction balance changes * @description Returns the balance changes for a principal's transaction */ get: operations["get_principal_transaction_balance_changes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/balance-changes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal balance changes * @description Returns the balance changes for a principal across one or more transactions, as a single paginated flat array ordered by chain position descending then by asset. */ get: operations["get_principal_balance_changes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/staking": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal staking summary * @description A one-call overview of a principal's staking: its pox-5 STX-staking position (locked STX and its sBTC rewards) plus aggregate totals across all of its bond positions. The per-bond breakdown is paginated at `/principals/:principal/staking/bonds`. */ get: operations["get_principal_staking_summary"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/staking/bonds": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal bond positions * @description Get a principal's bond positions — its enrollment, lock, status, and sBTC rewards in each bond it participates in. */ get: operations["get_principal_bond_positions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/balances/stx": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal STX balance * @description Get a principal's STX balance: its total and spendable (available) balance, any locked STX, and the projected balance from pending mempool transactions. */ get: operations["get_principal_balances_stx"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/balances/ft": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal FT balances * @description Get a principal's fungible-token balances, sorted by balance descending. */ get: operations["get_principal_balances_ft"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/balances/ft/{asset_identifier}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal FT balance * @description Get a principal's balance of a single fungible token. Returns a zero balance if the principal does not currently hold the token. */ get: operations["get_principal_balance_ft"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/balances/nft": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal NFT balances * @description Get the non-fungible token instances currently owned by a principal, ordered by asset identifier and value. Optionally filtered to a single asset class via `asset_identifier`. */ get: operations["get_principal_balances_nft"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/nonces": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal nonces * @description Get a Stacks account's latest nonce state by inspecting its confirmed transactions and the mempool, including the nonce to use for its next transaction. Only standard principals have nonces; contract principals are not valid. */ get: operations["get_principal_nonces"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/principals/{principal}/mempool/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get principal mempool transactions * @description Returns a list of pending mempool transactions that involve a principal — as the sender, a token-transfer recipient, the deployed contract, or the called contract. */ get: operations["get_principal_mempool_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/smart-contracts/{contract_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get smart contract * @description Retrieves a deployed smart contract, along with the transaction that deployed it. Only successfully deployed contracts are returned; a contract id whose deploy transaction failed is not found. */ get: operations["get_smart_contract"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/bonds": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get bonds * @description Get bonds */ get: operations["get_bonds"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/bonds/{bond_index}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get bond * @description Get bond */ get: operations["get_bond"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/bonds/{bond_index}/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get bond events * @description A bond's pox-5 event log, newest first: setup, allowlist additions, registrations and registration updates, early exits (`announce-l1-early-exit`, and `unstake-sbtc` with a `new_amount_sats` of 0), partial sBTC unstakes, reward distributions, and staker reward claims. */ get: operations["get_bond_events"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/bonds/{bond_index}/allowlist": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get bond allowlist entries * @description Get bond allowlist entries */ get: operations["get_bond_allowlist_entries"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/bonds/{bond_index}/allowlist/{principal}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get bond allowlist entry * @description Get bond allowlist entry */ get: operations["get_bond_allowlist_entry"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/bonds/{bond_index}/registrations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get bond registrations * @description Get bond registrations */ get: operations["get_bond_registrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/bonds/{bond_index}/registrations/{principal}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get bond registration * @description Get bond registration */ get: operations["get_bond_registration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/cycles/{cycle_number}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get staking cycle * @description A summary of staking for one PoX reward cycle. */ get: operations["get_staking_cycle"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/cycles/{cycle_number}/signers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get cycle signers * @description Get the signer set of a PoX cycle, including each signer's weight, staked amount, and the signer manager contracts whose registered signing key was this key when the cycle's reward set was calculated. */ get: operations["get_cycle_signers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/rewards": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get network staking reward totals * @description Get the total Bitcoin generated by staking on the Stacks network across all history, along with the total BTC burned by block commits. Values are in satoshis and always reflect the latest ingested chain state. */ get: operations["get_staking_rewards"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/signers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get staking signers * @description Get the all-time registry of pox-5 staking signers: every signer principal that has ever registered a signer key, with its most recently registered key. Registrants are never removed from this registry, even if they are no longer part of the current cycle's signer set. */ get: operations["get_staking_signers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/signers/{principal}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get staking signer * @description Get a registered pox-5 staking signer along with the details of the transaction that registered its current key. */ get: operations["get_staking_signer"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/staking/signers/{principal}/stakers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get staking signer stakers * @description List the stakers that belong to a pox-5 signer, across both direct STX staking and BTC/sBTC bond staking. Each entry indicates which staking type(s) the staker participates in under this signer. */ get: operations["get_staking_signer_stakers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/tokens/stx/supply": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get total STX supply * @description Retrieves the total liquid STX supply in micro-STX (µSTX) at the current chain tip: all STX minted (including vesting schedule unlocks) plus matured miner coinbase rewards, minus burned STX. */ get: operations["get_stx_total_supply"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/tokens/stx/holders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get STX holders * @description Retrieves the principals holding STX, sorted by balance descending. Balances are the total µSTX held, including any STX locked for stacking — they are not the spendable balance reported as `available` by a principal's STX balance. */ get: operations["get_stx_holders"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/tokens/ft/{asset_identifier}/holders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get fungible token holders * @description Retrieves the principals holding a given fungible token, sorted by balance descending. Balances are in the token's own base units. */ get: operations["get_fungible_token_holders"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/tokens/ft/{asset_identifier}/supply": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get total fungible token supply * @description Retrieves the total supply of a fungible token: the sum of every holder balance, equivalent to the token's mints minus its burns. Returns a zero supply for a token with no recorded balances. */ get: operations["get_ft_total_supply"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/tokens/nft/{asset_identifier}/{value}/history": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get non-fungible token history * @description Retrieves the event history of a single non-fungible token instance, newest first. Useful for determining an asset's ownership history. Mints have a null `sender` and burns a null `recipient`. The instance is addressed by a SIP-009 token id, or by its serialized Clarity value when the collection is not keyed by a `uint`. */ get: operations["get_nft_instance_history"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get transactions * @description Retrieves a list of recently mined transactions */ get: operations["get_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/transactions/batch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a batch of transactions * @description Retrieves the summaries of up to 20 mined transactions in a single call, given their transaction ids. Provide them as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). Results are returned in canonical chain order (newest first), not in the order the ids were supplied. Only transactions mined in the canonical chain are returned: an id that is unknown, non-canonical, or still in the mempool is absent from `results` rather than reported as an error, so compare the response against the ids you sent to find the ones that did not resolve. Use `GET /extended/v3/transactions/{tx_id}` for a single transaction, which also covers mempool transactions. */ get: operations["get_transactions_batch"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/transactions/{tx_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get transaction * @description Retrieves details for a given transaction, including both mined and mempool transactions */ get: operations["get_transaction"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/extended/v3/transactions/{tx_id}/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get transaction events * @description Retrieves events for a given transaction ID */ get: operations["get_transaction_events"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/names/{name}/zonefile/{zoneFileHash}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Historical Zone File * @deprecated * @description Retrieves the historical zonefile specified by the username and zone hash. **Deprecated:** BNS endpoints are no longer maintained. */ get: operations["get_historical_zone_file"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/names/{name}/subdomains": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Name Subdomains * @deprecated * @description Retrieves the list of subdomains for a specific name. **Deprecated:** BNS endpoints are no longer maintained. */ get: operations["fetch_subdomains_list_for_name"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/names/{name}/zonefile": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Zone File * @deprecated * @description Retrieves a user's raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files. **Deprecated:** BNS endpoints are no longer maintained. */ get: operations["fetch_zone_file"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/names/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get All Names * @deprecated * @description Retrieves a list of all names known to the node. **Deprecated:** BNS endpoints are no longer maintained. */ get: operations["get_all_names"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/names/{name}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Name Details * @deprecated * @description Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`. **Deprecated:** BNS endpoints are no longer maintained. */ get: operations["get_name_info"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/namespaces/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get All Namespaces * @deprecated * @description Retrieves a list of all namespaces known to the node. **Deprecated:** BNS endpoints are no longer maintained. */ get: operations["get_all_namespaces"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/namespaces/{tld}/names": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Namespace Names * @deprecated * @description Retrieves a list of names within a given namespace. **Deprecated:** BNS endpoints are no longer maintained. */ get: operations["get_namespace_names"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/addresses/{blockchain}/{address}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Names Owned by Address * @deprecated * @description Retrieves a list of names owned by the address provided. **Deprecated:** use `GET /extended/v3/principals/{principal}/balances/nft` instead, filtered to the BNS asset identifier. Note that this returns only NFT-backed names, not subdomains or names imported from Blockstack v1. */ get: operations["get_names_owned_by_address"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v2/prices/namespaces/{tld}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Namespace Price * @deprecated * @description Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency. **Deprecated:** BNS endpoints are no longer maintained. */ get: operations["get_namespace_price"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v2/prices/names/{name}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Name Price * @deprecated * @description Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency. **Deprecated:** BNS endpoints are no longer maintained. */ get: operations["get_name_price"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: never; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { get_status: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description the server version that is currently running */ server_version: string; /** @description the current server status */ status: string; chain_tip?: { /** @description the current block height */ block_height: number; /** @description the current block hash */ block_hash: string; /** @description the current index block hash */ index_block_hash: string; /** @description the current burn chain block height */ burn_block_height: number; } | null; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_transaction_list: { parameters: { query?: { /** @description Result offset */ offset?: number; /** @description Results per page */ limit?: number; type?: ("coinbase" | "token_transfer" | "smart_contract" | "contract_call" | "poison_microblock" | "tenure_change")[]; order?: "asc" | "desc"; /** @description Option to sort results by block height, timestamp, or fee */ sort_by?: "block_height" | "burn_block_time" | "fee"; /** @description Option to filter results by sender address */ from_address?: string; /** @description Option to filter results by recipient address */ to_address?: string; /** * @description Filter by transactions after this timestamp (unix timestamp in seconds) * @example 1704067200 */ start_time?: number; /** * @description Filter by transactions before this timestamp (unix timestamp in seconds) * @example 1706745599 */ end_time?: number; /** * @description Option to filter results by contract ID * @example SP000000000000000000002Q6VF78.pox-4 */ contract_id?: string; /** * @description Filter by contract call transactions involving this function name * @example delegate-stx */ function_name?: string; /** * @description Filter by transactions with this nonce * @example 123 */ nonce?: number; /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ exclude_function_args?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description List of transactions */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_tx_list_details: { parameters: { query: { tx_id: string[]; /** @description Results per page */ event_limit?: number; /** @description Result offset */ event_offset?: number; /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ exclude_function_args?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { [key: string]: { /** @enum {boolean} */ found: true; result: ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }) | ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }); } | { /** @enum {boolean} */ found: false; result: { tx_id: string; }; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_mempool_transaction_list: { parameters: { query?: { /** * @description STX Address * @example SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP */ sender_address?: string; /** * @description STX Address * @example SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP */ recipient_address?: string; /** * @description STX Address * @example SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP */ address?: string; /** @description Option to sort results by transaction age, size, or fee rate. */ order_by?: "age" | "size" | "fee"; /** @description Results order */ order?: "asc" | "desc"; /** @description Result offset */ offset?: number; /** @description Results per page */ limit?: number; /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ exclude_function_args?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description List of mempool transactions */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_mempool_transaction_stats: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description GET request that returns stats on mempool transactions */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Number of tranasction in the mempool, broken down by transaction type. */ tx_type_counts: { [key: string]: number; }; /** @description The simple mean (average) transaction fee, broken down by transaction type. Note that this does not factor in actual execution costs. The average fee is not a reliable metric for calculating a fee for a new transaction. */ tx_simple_fee_averages: { [key: string]: { p25: number | null; p50: number | null; p75: number | null; p95: number | null; } & { [key: string]: unknown; }; }; /** @description The average time (in blocks) that transactions have lived in the mempool. The start block height is simply the current chain-tip of when the attached Stacks node receives the transaction. This timing can be different across Stacks nodes / API instances due to propagation timing differences in the p2p network. */ tx_ages: { [key: string]: { p25: number | null; p50: number | null; p75: number | null; p95: number | null; } & { [key: string]: unknown; }; }; /** @description The average byte size of transactions in the mempool, broken down by transaction type. */ tx_byte_sizes: { [key: string]: { p25: number | null; p50: number | null; p75: number | null; p95: number | null; } & { [key: string]: unknown; }; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_filtered_events: { parameters: { query?: { /** * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id?: string; address?: string; type?: ("smart_contract_log" | "stx_lock" | "stx_asset" | "fungible_token_asset" | "non_fungible_token_asset")[]; /** @description Result offset */ offset?: number; /** @description Results per page */ limit?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_transaction_by_id: { parameters: { query?: { /** @description Results per page */ event_limit?: number; /** @description Result offset */ event_offset?: number; /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ exclude_function_args?: boolean; }; header?: never; path: { /** * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }) | ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }); }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_raw_transaction_by_id: { parameters: { query?: { /** @description Results per page */ event_limit?: number; /** @description Result offset */ event_offset?: number; }; header?: never; path: { /** * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description GET raw transaction */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { raw_tx: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_transactions_by_block_hash: { parameters: { query?: { /** @description Result offset */ offset?: number; /** @description Results per page */ limit?: number; /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ exclude_function_args?: boolean; }; header?: never; path: { block_hash: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description List of transactions */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_transactions_by_block_height: { parameters: { query?: { /** @description Result offset */ offset?: number; /** @description Results per page */ limit?: number; /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ exclude_function_args?: boolean; }; header?: never; path: { /** * @description Block height * @example 777678 */ height: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description List of transactions */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_stx_supply: { parameters: { query?: { /** * @description Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value. Note that the `block height` is referred to the stacks blockchain. * @example 777678 */ height?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description GET request that returns network target block times */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description String quoted decimal number of the percentage of STX that have unlocked */ unlocked_percent: string; /** @description String quoted decimal number of the total circulating number of STX (at the input block height if provided, otherwise the current block height) */ total_stx: string; /** @description String quoted decimal number of total circulating STX supply in year 2050. STX supply grows approx 0.3% annually thereafter in perpetuity. */ total_stx_year_2050: string; /** @description String quoted decimal number of the STX that have been mined or unlocked */ unlocked_stx: string; /** @description The block height at which this information was queried */ block_height: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_stx_supply_total_supply_plain: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": string; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_stx_supply_circulating_plain: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": string; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_total_stx_supply_legacy_format: { parameters: { query?: { /** * @description Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value. Note that the `block height` is referred to the stacks blockchain. * @example 777678 */ height?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description GET request that returns network target block times */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description String quoted decimal number of the percentage of STX that have unlocked */ unlockedPercent: string; /** @description String quoted decimal number of the total circulating number of STX (at the input block height if provided, otherwise the current block height) */ totalStacks: string; /** @description Same as `totalStacks` but formatted with comma thousands separators */ totalStacksFormatted: string; /** @description String quoted decimal number of total circulating STX supply in year 2050. STX supply grows approx 0.3% annually thereafter in perpetuity. */ totalStacksYear2050: string; /** @description Same as `totalStacksYear2050` but formatted with comma thousands separators */ totalStacksYear2050Formatted: string; /** @description String quoted decimal number of the STX that have been mined or unlocked */ unlockedSupply: string; /** @description Same as `unlockedSupply` but formatted with comma thousands separators */ unlockedSupplyFormatted: string; /** @description The block height at which this information was queried */ blockHeight: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_network_block_times: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description GET request that returns network target block times */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { mainnet: { target_block_time: number; }; testnet: { target_block_time: number; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_network_block_time_by_network: { parameters: { query?: never; header?: never; path: { network: "testnet" | "mainnet"; }; cookie?: never; }; requestBody?: never; responses: { /** @description GET request that target block time for a given network */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { target_block_time: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_nft_holdings: { parameters: { query: { principal: string; asset_identifiers?: string[]; /** @description max number of tokens to fetch */ limit?: number; /** @description index of first tokens to fetch */ offset?: number; /** @description whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times. */ tx_metadata: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description List of Non-Fungible Token holdings */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ asset_identifier: string; /** @description Non-Fungible Token value */ value: { /** @description Hex string representing the identifier of the Non-Fungible Token */ hex: string; /** @description Readable string of the Non-Fungible Token identifier */ repr: string; }; block_height: number; tx_id: string; } | { asset_identifier: string; /** @description Non-Fungible Token value */ value: { /** @description Hex string representing the identifier of the Non-Fungible Token */ hex: string; /** @description Readable string of the Non-Fungible Token identifier */ repr: string; }; block_height: number; tx: { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_nft_history: { parameters: { query: { /** * @description asset class identifier * @example SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild */ asset_identifier: string; /** * @description hex representation of the token's unique value * @example 0x0100000000000000000000000000000803 */ value: string; /** @description max number of events to fetch */ limit?: number; /** @description index of first event to fetch */ offset?: number; /** @description whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times. */ tx_metadata: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description List of Non-Fungible Token history events */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ sender?: string | null; recipient?: string; event_index: number; asset_event_type: string; tx_id: string; } | { sender?: string | null; recipient?: string; event_index: number; asset_event_type: string; tx: { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_nft_mints: { parameters: { query: { /** * @description asset class identifier * @example SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild */ asset_identifier: string; /** @description max number of events to fetch */ limit?: number; /** @description index of first event to fetch */ offset?: number; /** @description whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times. */ tx_metadata: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description List of Non-Fungible Token mint events for an asset identifier */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ recipient?: string; event_index: number; /** @description Non-Fungible Token value */ value: { /** @description Hex string representing the identifier of the Non-Fungible Token */ hex: string; /** @description Readable string of the Non-Fungible Token identifier */ repr: string; }; tx_id: string; } | { recipient?: string; event_index: number; /** @description Non-Fungible Token value */ value: { /** @description Hex string representing the identifier of the Non-Fungible Token */ hex: string; /** @description Readable string of the Non-Fungible Token identifier */ repr: string; }; tx: { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_ft_holders: { parameters: { query?: { /** @description max number of holders to fetch */ limit?: number; /** @description index of first holder to fetch */ offset?: number; }; header?: never; path: { /** @description fungible token identifier */ token: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * @description The total supply of the token (the sum of all balances) * @example 5817609278457 */ total_supply: string; /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** * @description Principal of the token holder * @example SP3G2QZHYDZPJ2FBN2V2MB74T5ZQ6FQK2P5QJ2K6 */ address: string; /** * @description The balance of the token held by the address * @example 174823763 */ balance: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_contracts_by_trait: { parameters: { query: { /** @description JSON abi of the trait. */ trait_abi: string; /** @description max number of contracts fetch */ limit?: number; /** @description index of first contract event to fetch */ offset?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description GET list of contracts */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; results: { tx_id: string; canonical: boolean; contract_id: string; block_height: number; clarity_version: number | null; source_code: string; abi: string | null; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_contract_by_id: { parameters: { query?: never; header?: never; path: { /** * @description Contract identifier formatted as `.` * @example SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C.satoshibles */ contract_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description A Smart Contract Detail */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { tx_id: string; canonical: boolean; contract_id: string; block_height: number; clarity_version: number | null; source_code: string; abi: string | null; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_contract_events_by_id: { parameters: { query?: { /** @description max number of events to fetch */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { /** * @description Contract identifier formatted as `.` * @example SP6P4EJF0VG8V0RB3TQQKJBHDQKEF6NVRD1KZE3C.satoshibles */ contract_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description List of events */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { limit: number; offset: number; results: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; fetch_fee_rate: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Request to fetch fee for a transaction */ requestBody: { content: { "application/json": { /** @description A serialized transaction */ transaction: string; }; }; }; responses: { /** @description Get fee rate information. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { fee_rate: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_block_list: { parameters: { query?: { /** @description max number of blocks to fetch */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description GET request that returns blocks */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; /** @description List of transactions included in the block */ txs: string[]; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_hash: string; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_sequence: number; /** @description List of microblocks that were accepted in this anchor block. Not every anchored block will have a accepted all (or any) of the previously streamed microblocks. Microblocks that were orphaned are not included in this list. */ microblocks_accepted: string[]; /** @description List of microblocks that were streamed/produced by this anchor block's miner. This list only includes microblocks that were accepted in the following anchor block. Microblocks that were orphaned are not included in this list. */ microblocks_streamed: string[]; /** @description List of txs counts in each accepted microblock */ microblock_tx_count: { [key: string]: number; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_block_by_height: { parameters: { query?: never; header?: never; path: { /** * @description Height of the block * @example 10000 */ height: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description A block */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; /** @description List of transactions included in the block */ txs: string[]; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_hash: string; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_sequence: number; /** @description List of microblocks that were accepted in this anchor block. Not every anchored block will have a accepted all (or any) of the previously streamed microblocks. Microblocks that were orphaned are not included in this list. */ microblocks_accepted: string[]; /** @description List of microblocks that were streamed/produced by this anchor block's miner. This list only includes microblocks that were accepted in the following anchor block. Microblocks that were orphaned are not included in this list. */ microblocks_streamed: string[]; /** @description List of txs counts in each accepted microblock */ microblock_tx_count: { [key: string]: number; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_block_by_burn_block_height: { parameters: { query?: never; header?: never; path: { /** * @description Height of the burn chain block * @example 744603 */ burn_block_height: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description A block */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; /** @description List of transactions included in the block */ txs: string[]; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_hash: string; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_sequence: number; /** @description List of microblocks that were accepted in this anchor block. Not every anchored block will have a accepted all (or any) of the previously streamed microblocks. Microblocks that were orphaned are not included in this list. */ microblocks_accepted: string[]; /** @description List of microblocks that were streamed/produced by this anchor block's miner. This list only includes microblocks that were accepted in the following anchor block. Microblocks that were orphaned are not included in this list. */ microblocks_streamed: string[]; /** @description List of txs counts in each accepted microblock */ microblock_tx_count: { [key: string]: number; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_block_by_hash: { parameters: { query?: never; header?: never; path: { /** * @description Hash of the block * @example 0x4839a8b01cfb39ffcc0d07d3db31e848d5adf5279d529ed5062300b9f353ff79 */ hash: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description A block */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; /** @description List of transactions included in the block */ txs: string[]; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_hash: string; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_sequence: number; /** @description List of microblocks that were accepted in this anchor block. Not every anchored block will have a accepted all (or any) of the previously streamed microblocks. Microblocks that were orphaned are not included in this list. */ microblocks_accepted: string[]; /** @description List of microblocks that were streamed/produced by this anchor block's miner. This list only includes microblocks that were accepted in the following anchor block. Microblocks that were orphaned are not included in this list. */ microblocks_streamed: string[]; /** @description List of txs counts in each accepted microblock */ microblock_tx_count: { [key: string]: number; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_block_by_burn_block_hash: { parameters: { query?: never; header?: never; path: { /** * @description Hash of the burnchain block * @example 0x00000000000000000002bba732926cf68b6eda3e2cdbc2a85af79f10efeeeb10 */ burn_block_hash: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description A block */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; /** @description List of transactions included in the block */ txs: string[]; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_hash: string; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_sequence: number; /** @description List of microblocks that were accepted in this anchor block. Not every anchored block will have a accepted all (or any) of the previously streamed microblocks. Microblocks that were orphaned are not included in this list. */ microblocks_accepted: string[]; /** @description List of microblocks that were streamed/produced by this anchor block's miner. This list only includes microblocks that were accepted in the following anchor block. Microblocks that were orphaned are not included in this list. */ microblocks_streamed: string[]; /** @description List of txs counts in each accepted microblock */ microblock_tx_count: { [key: string]: number; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_burnchain_reward_slot_holders: { parameters: { query?: { /** @description max number of items to fetch */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** @description Set to `true` if block corresponds to the canonical burchchain tip */ canonical: boolean; /** @description The hash representing the burnchain block */ burn_block_hash: string; /** @description Height of the burnchain block */ burn_block_height: number; /** @description The recipient address that validly received PoX commitments, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) */ address: string; /** @description The index position of the reward entry, useful for ordering when there's more than one slot per burnchain block */ slot_index: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_burnchain_reward_slot_holders_by_address: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { /** * @description Reward slot holder recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format * @example 36hQtSEXBMevo5chpxhfAGiCTSC34QKgda */ address: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description List of burnchain reward recipients and amounts */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** @description Set to `true` if block corresponds to the canonical burchchain tip */ canonical: boolean; /** @description The hash representing the burnchain block */ burn_block_hash: string; /** @description Height of the burnchain block */ burn_block_height: number; /** @description The recipient address that validly received PoX commitments, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) */ address: string; /** @description The index position of the reward entry, useful for ordering when there's more than one slot per burnchain block */ slot_index: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_burnchain_reward_list: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description List of burnchain reward recipients and amounts */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { limit: number; offset: number; results: { /** @description Set to `true` if block corresponds to the canonical burchchain tip */ canonical: boolean; /** @description The hash representing the burnchain block */ burn_block_hash: string; /** @description Height of the burnchain block */ burn_block_height: number; /** @description The total amount of burnchain tokens burned for this burnchain block, in the smallest unit (e.g. satoshis for Bitcoin) */ burn_amount: string; /** @description The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) */ reward_recipient: string; /** @description The amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin) */ reward_amount: string; /** @description The index position of the reward entry, useful for ordering when there's more than one recipient per burnchain block */ reward_index: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_burnchain_reward_list_by_address: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { /** * @description Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format * @example 36hQtSEXBMevo5chpxhfAGiCTSC34QKgda */ address: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description List of burnchain reward recipients and amounts */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { limit: number; offset: number; results: { /** @description Set to `true` if block corresponds to the canonical burchchain tip */ canonical: boolean; /** @description The hash representing the burnchain block */ burn_block_hash: string; /** @description Height of the burnchain block */ burn_block_height: number; /** @description The total amount of burnchain tokens burned for this burnchain block, in the smallest unit (e.g. satoshis for Bitcoin) */ burn_amount: string; /** @description The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) */ reward_recipient: string; /** @description The amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin) */ reward_amount: string; /** @description The index position of the reward entry, useful for ordering when there's more than one recipient per burnchain block */ reward_index: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_burnchain_rewards_total_by_address: { parameters: { query?: never; header?: never; path: { /** * @description Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format * @example 36hQtSEXBMevo5chpxhfAGiCTSC34QKgda */ address: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Total burnchain rewards made to a recipient */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g. B58 encoded for Bitcoin) */ reward_recipient: string; /** @description The total amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin) */ reward_amount: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_account_stx_balance: { parameters: { query?: { /** @description Block hash or block height. Return data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. */ until_block?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description GET request that returns address balances */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { balance: string; /** @description Total STX balance considering pending mempool transactions */ estimated_balance?: string; /** @description Inbound STX balance from pending mempool transactions */ pending_balance_inbound?: string; /** @description Outbound STX balance from pending mempool transactions */ pending_balance_outbound?: string; total_sent?: string; total_received?: string; total_fees_sent?: string; total_miner_rewards_received: string; /** @description The transaction where the lock event occurred. Empty if no tokens are locked. */ lock_tx_id: string; /** @description The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked. */ locked: string; /** @description The STX chain block height of when the lock event occurred. Zero if no tokens are locked. */ lock_height: number; /** @description The burnchain block height of when the lock event occurred. Zero if no tokens are locked. */ burnchain_lock_height: number; /** @description The burnchain block height of when the tokens unlock. Zero if no tokens are locked. */ burnchain_unlock_height: number; } & { /** * AddressTokenOfferingLocked * @description Token Offering Locked */ token_offering_locked?: { /** @description Micro-STX amount still locked at current block height. */ total_locked: string; /** @description Micro-STX amount unlocked at current block height. */ total_unlocked: string; unlock_schedule: { /** @description Micro-STX amount locked at this block height. */ amount: string; block_height: number; }[]; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_account_balance: { parameters: { query?: { /** @description Block hash or block height. Return data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. */ until_block?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description GET request that returns address balances */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** StxBalance */ stx: { balance: string; /** @description Total STX balance considering pending mempool transactions */ estimated_balance?: string; /** @description Inbound STX balance from pending mempool transactions */ pending_balance_inbound?: string; /** @description Outbound STX balance from pending mempool transactions */ pending_balance_outbound?: string; total_sent?: string; total_received?: string; total_fees_sent?: string; total_miner_rewards_received: string; /** @description The transaction where the lock event occurred. Empty if no tokens are locked. */ lock_tx_id: string; /** @description The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked. */ locked: string; /** @description The STX chain block height of when the lock event occurred. Zero if no tokens are locked. */ lock_height: number; /** @description The burnchain block height of when the lock event occurred. Zero if no tokens are locked. */ burnchain_lock_height: number; /** @description The burnchain block height of when the tokens unlock. Zero if no tokens are locked. */ burnchain_unlock_height: number; }; fungible_tokens: { [key: string]: { balance: string; total_sent: string; total_received: string; }; }; non_fungible_tokens: { [key: string]: { count: string; total_sent: string; total_received: string; }; }; /** * AddressTokenOfferingLocked * @description Token Offering Locked */ token_offering_locked?: { /** @description Micro-STX amount still locked at current block height. */ total_locked: string; /** @description Micro-STX amount unlocked at current block height. */ total_unlocked: string; unlock_schedule: { /** @description Micro-STX amount locked at this block height. */ amount: string; block_height: number; }[]; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_account_transactions: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description Filter for transactions only at this given block height */ height?: number; /** @description Block hash or block height. Return data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. */ until_block?: string; /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ exclude_function_args?: boolean; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description GET request that returns account transactions */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_single_transaction_with_transfers: { parameters: { query?: never; header?: never; path: { principal: string; /** * @description Transaction ID * @example 0x34d79c7cfc2fe525438736733e501a4bf0308a5556e3e080d1e2c0858aad7448 */ tx_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Transaction with STX transfers for a given address */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { tx: { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }; /** @description Total sent from the given address, including the tx fee, in micro-STX as an integer string. */ stx_sent: string; /** @description Total received by the given address in micro-STX as an integer string. */ stx_received: string; stx_transfers: { /** @description Amount transferred in micro-STX as an integer string. */ amount: string; /** @description Principal that sent STX. This is unspecified if the STX were minted. */ sender?: string; /** @description Principal that received STX. This is unspecified if the STX were burned. */ recipient?: string; }[]; ft_transfers?: { /** @description Amount transferred as an integer string. This balance does not factor in possible SIP-010 decimals. */ amount: string; /** @description Fungible Token asset identifier. */ asset_identifier: string; /** @description Principal that sent the asset. */ sender?: string; /** @description Principal that received the asset. */ recipient?: string; }[]; nft_transfers?: { /** @description Non Fungible Token asset value. */ value: { hex: string; repr: string; }; /** @description Non Fungible Token asset identifier. */ asset_identifier: string; /** @description Principal that sent the asset. */ sender?: string; /** @description Principal that received the asset. */ recipient?: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_account_transactions_with_transfers: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description Filter for transactions only at this given block height */ height?: number; /** @description Block hash or block height. Return data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. */ until_block?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { tx: { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }; /** @description Total sent from the given address, including the tx fee, in micro-STX as an integer string. */ stx_sent: string; /** @description Total received by the given address in micro-STX as an integer string. */ stx_received: string; stx_transfers: { /** @description Amount transferred in micro-STX as an integer string. */ amount: string; /** @description Principal that sent STX. This is unspecified if the STX were minted. */ sender?: string; /** @description Principal that received STX. This is unspecified if the STX were burned. */ recipient?: string; }[]; ft_transfers?: { /** @description Amount transferred as an integer string. This balance does not factor in possible SIP-010 decimals. */ amount: string; /** @description Fungible Token asset identifier. */ asset_identifier: string; /** @description Principal that sent the asset. */ sender?: string; /** @description Principal that received the asset. */ recipient?: string; }[]; nft_transfers?: { /** @description Non Fungible Token asset value. */ value: { hex: string; repr: string; }; /** @description Non Fungible Token asset identifier. */ asset_identifier: string; /** @description Principal that sent the asset. */ sender?: string; /** @description Principal that received the asset. */ recipient?: string; }[]; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_account_assets: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description Block hash or block height. Return data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. */ until_block?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_account_inbound: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description Filter for transactions only at this given block height */ height?: number; /** @description Block hash or block height. Return data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time. */ until_block?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** @description Principal that sent this transfer */ sender: string; /** @description Transfer amount in micro-STX as integer string */ amount: string; /** @description Hex encoded memo bytes associated with the transfer */ memo: string; /** @description Block height at which this transfer occurred */ block_height: number; /** @description The transaction ID in which this transfer occurred */ tx_id: string; /** @description Indicates if the transfer is from a stx-transfer transaction or a contract-call transaction */ transfer_type: "bulk-send" | "stx-transfer" | "stx-transfer-memo"; /** @description Index of the transaction within a block */ tx_index: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_address_mempool_transactions: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ exclude_function_args?: boolean; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description List of mempool transactions */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_account_nonces: { parameters: { query?: { /** * @description Optionally get the nonce at a given block height. * @example 66119 */ block_height?: number; /** * @description Optionally get the nonce at a given block hash. Note - Use either of the query parameters but not both at a time. * @example 0x72d53f3cba39e149dcd42708e535bdae03d73e60d2fe853aaf61c0b392f521e9 */ block_hash?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The latest nonce values used by an account by inspecting the mempool and confirmed transactions */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { last_mempool_tx_nonce: number | null; last_executed_tx_nonce: number | null; /** @description The likely nonce required for creating the next transaction, based on the last nonces seen by the API. This can be incorrect if the API's mempool or transactions aren't fully synchronized, even by a small amount, or if a previous transaction is still propagating through the Stacks blockchain network when this endpoint is called. */ possible_next_nonce: number; /** @description Nonces that appear to be missing and likely causing a mempool transaction to be stuck. */ detected_missing_nonces: number[]; /** @description Nonces currently in mempool for this address. */ detected_mempool_nonces: number[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; search_by_id: { parameters: { query?: { /** @description This includes the detailed data for purticular hash in the response */ include_metadata?: boolean; }; header?: never; path: { /** * @description The hex hash string for a block or transaction, account address, or contract address * @example 0xcf8b233f19f6c07d2dc1963302d2436efd36e9afac127bf6582824a13961c06d */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @enum {boolean} */ found: true; result: { /** @description The id used to search this query. */ entity_id: string; /** @enum {string} */ entity_type: "standard_address"; /** * AddressStxBalance * @description GET request that returns address balances */ metadata?: { balance: string; /** @description Total STX balance considering pending mempool transactions */ estimated_balance?: string; /** @description Inbound STX balance from pending mempool transactions */ pending_balance_inbound?: string; /** @description Outbound STX balance from pending mempool transactions */ pending_balance_outbound?: string; total_sent?: string; total_received?: string; total_fees_sent?: string; total_miner_rewards_received: string; /** @description The transaction where the lock event occurred. Empty if no tokens are locked. */ lock_tx_id: string; /** @description The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked. */ locked: string; /** @description The STX chain block height of when the lock event occurred. Zero if no tokens are locked. */ lock_height: number; /** @description The burnchain block height of when the lock event occurred. Zero if no tokens are locked. */ burnchain_lock_height: number; /** @description The burnchain block height of when the tokens unlock. Zero if no tokens are locked. */ burnchain_unlock_height: number; } & { /** * AddressTokenOfferingLocked * @description Token Offering Locked */ token_offering_locked?: { /** @description Micro-STX amount still locked at current block height. */ total_locked: string; /** @description Micro-STX amount unlocked at current block height. */ total_unlocked: string; unlock_schedule: { /** @description Micro-STX amount locked at this block height. */ amount: string; block_height: number; }[]; }; }; } | { /** @description The id used to search this query. */ entity_id: string; /** @enum {string} */ entity_type: "block_hash"; block_data: { canonical: boolean; hash: string; parent_block_hash: string; burn_block_time: number; height: number; }; /** * Block * @description A block */ metadata?: { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; /** @description List of transactions included in the block */ txs: string[]; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_hash: string; /** @description The hash of the last streamed block that precedes this block to which this block is to be appended. Not every anchored block will have a parent microblock stream. An anchored block that does not have a parent microblock stream has the parent microblock hash set to an empty string, and the parent microblock sequence number set to -1. */ parent_microblock_sequence: number; /** @description List of microblocks that were accepted in this anchor block. Not every anchored block will have a accepted all (or any) of the previously streamed microblocks. Microblocks that were orphaned are not included in this list. */ microblocks_accepted: string[]; /** @description List of microblocks that were streamed/produced by this anchor block's miner. This list only includes microblocks that were accepted in the following anchor block. Microblocks that were orphaned are not included in this list. */ microblocks_streamed: string[]; /** @description List of txs counts in each accepted microblock */ microblock_tx_count: { [key: string]: number; }; }; } | { /** @description The id used to search this query. */ entity_id: string; /** @enum {string} */ entity_type: "contract_address"; tx_data?: { canonical?: boolean; block_hash?: string; burn_block_time?: number; block_height?: number; tx_type: string; tx_id: string; }; metadata?: ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }) | ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }); } | { /** @description The id used to search this query. */ entity_id: string; /** @enum {string} */ entity_type: "mempool_tx_id"; tx_data: { tx_type: string; }; metadata?: { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Status of the transaction */ tx_status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; replaced_by_tx_id: string | null; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when the transaction broadcast was received by the node. */ receipt_time_iso: string; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }; } | { /** @description The id used to search this query. */ entity_id: string; /** @enum {string} */ entity_type: "tx_id"; tx_data: { canonical: boolean; block_hash: string; burn_block_time: number; block_height: number; tx_type: string; }; metadata?: { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }; }; }; }; }; /** @description Default Response */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @enum {boolean} */ found: false; result: { entity_type: "tx_id" | "mempool_tx_id" | "block_hash" | "standard_address" | "contract_address" | "unknown_hash" | "invalid_term"; }; error: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_pool_delegations: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description If specified, only delegation events after the given block will be included */ after_block?: number; height?: number; }; header?: never; path: { pox: "pox2" | "pox3" | "pox4"; /** * @description Address principal of the stacking pool delegator * @example SPSCWDV3RKV5ZRN1FQD84YE1NQFEDJ9R1F4DYQ11 */ pool_principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** @description The principal of the pool member that issued the delegation */ stacker: string; /** @description The pox-addr value specified by the stacker in the delegation operation */ pox_addr?: string; /** @description The amount of uSTX delegated by the stacker */ amount_ustx: string; /** @description The optional burnchain block unlock height that the stacker may have specified */ burn_block_unlock_height?: number; /** @description The block height at which the stacker delegation transaction was mined at */ block_height: number; /** @description The tx_id of the stacker delegation operation */ tx_id: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; run_faucet_btc: { parameters: { query?: { /** * @description A valid regtest BTC address * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts */ address?: string; /** @description Request a large amount of regtest BTC than the default */ large?: boolean; /** @description Request an extra large amount of regtest BTC than the default */ xlarge?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description A valid regtest BTC address */ address?: string; } | null; }; }; responses: { /** @description POST request that initiates a transfer of tokens to a specified Bitcoin regtest address */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * @description Indicates if the faucet call was successful * @enum {boolean} */ success: true; /** @description The transaction ID for the faucet call */ txid: string; /** @description Raw transaction in hex string representation */ raw_tx: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @enum {boolean} */ success: false; /** @description Error message */ error: string; }; }; }; }; }; get_btc_balance: { parameters: { query?: never; header?: never; path: { /** * @description A valid regtest BTC address * @example 2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts */ address: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Address balance in BTC */ balance: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @enum {boolean} */ success: false; /** @description Error message */ error: string; }; }; }; }; }; run_faucet_stx: { parameters: { query?: { /** * @description A valid testnet STX address * @example ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ */ address?: string; /** @description Request the amount of STX tokens needed for individual address stacking */ stacking?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description [Deprecated -- use query param rather than POST body] A valid testnet STX address */ address?: string; } | null; }; }; responses: { /** @description POST request that initiates a transfer of tokens to a specified testnet address */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * @description Indicates if the faucet call was successful * @enum {boolean} */ success: true; /** @description The transaction ID for the faucet call */ txId: string; /** @description Raw transaction in hex string representation */ txRaw: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** * @description Indicates if the faucet call was successful * @enum {boolean} */ success: false; /** @description Error message */ error: string; help?: string; }; }; }; }; }; run_faucet_sbtc: { parameters: { query?: { /** * @description A valid testnet STX address * @example ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ */ address?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description POST request that initiates a transfer of tokens to a specified testnet address */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * @description Indicates if the faucet call was successful * @enum {boolean} */ success: true; /** @description The transaction ID for the faucet call */ txId: string; /** @description Raw transaction in hex string representation */ txRaw: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** * @description Indicates if the faucet call was successful * @enum {boolean} */ success: false; /** @description Error message */ error: string; }; }; }; }; }; get_blocks: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description Cursor for block pagination */ cursor?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; next_cursor: string | null; prev_cursor: string | null; cursor: string | null; results: { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Index block hash of the parent block */ parent_index_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Number of transactions included in the block */ tx_count: number; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_average_block_times: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Average block times over the last hour (in seconds) */ last_1h: number; /** @description Average block times over the last 24 hours (in seconds) */ last_24h: number; /** @description Average block times over the last 7 days (in seconds) */ last_7d: number; /** @description Average block times over the last 30 days (in seconds) */ last_30d: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_block_by_block_time: { parameters: { query?: never; header?: never; path: { /** * @description Unix timestamp (in seconds) * @example 1677731361 */ timestamp: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Index block hash of the parent block */ parent_index_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Number of transactions included in the block */ tx_count: number; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_block: { parameters: { query?: never; header?: never; path: { height_or_hash: "latest" | string | number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Index block hash of the parent block */ parent_index_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Number of transactions included in the block */ tx_count: number; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_transactions_by_block: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { height_or_hash: "latest" | string | number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_signer_signatures_for_block: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { height_or_hash: "latest" | string | number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: string[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_burn_blocks: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Hashes of the Stacks blocks included in the burn block */ stacks_blocks: string[]; /** @description Average time between blocks in seconds. Returns 0 if there is only one block in the burn block. */ avg_block_time: number; /** @description Total number of transactions in the Stacks blocks associated with this burn block */ total_tx_count: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_burn_block: { parameters: { query?: never; header?: never; path: { height_or_hash: "latest" | string | number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Hashes of the Stacks blocks included in the burn block */ stacks_blocks: string[]; /** @description Average time between blocks in seconds. Returns 0 if there is only one block in the burn block. */ avg_block_time: number; /** @description Total number of transactions in the Stacks blocks associated with this burn block */ total_tx_count: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_blocks_by_burn_block: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { height_or_hash: "latest" | string | number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Index block hash of the parent block */ parent_index_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Number of transactions included in the block */ tx_count: number; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_burn_block_pox_transactions: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { height_or_hash: "latest" | string | number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** @description Height of the burn block */ burn_block_height: number; /** @description Hash of the burn block */ burn_block_hash: string; /** @description Transaction ID */ tx_id: string; /** @description Recipient address */ recipient: string; /** @description UTXO index */ utxo_idx: number; /** @description Amount */ amount: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_tenure_blocks: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description Cursor for block pagination */ cursor?: string; }; header?: never; path: { /** * @description Block tenure height * @example 165453 */ tenure_height: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; next_cursor: string | null; prev_cursor: string | null; cursor: string | null; results: { /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Height of the block */ height: number; /** @description Hash representing the block */ hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description The tenure height (AKA coinbase height) of this block */ tenure_height: number; /** @description The only hash that can uniquely identify an anchored block or an unconfirmed state trie */ index_block_hash: string; /** @description Hash of the parent block */ parent_block_hash: string; /** @description Index block hash of the parent block */ parent_index_block_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ burn_block_time_iso: string; /** @description Hash of the anchor chain block */ burn_block_hash: string; /** @description Height of the anchor chain block */ burn_block_height: number; /** @description Anchor chain transaction ID */ miner_txid: string; /** @description Number of transactions included in the block */ tx_count: number; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_smart_contracts_status: { parameters: { query: { contract_id: string[] | string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { [key: string]: { /** @enum {boolean} */ found: true; result: { /** @description Smart contract deployment transaction status */ status: string; /** @description Deployment transaction ID */ tx_id: string; /** @description Smart contract ID */ contract_id: string; /** @description Height of the transaction confirmation block */ block_height?: number; }; } | { /** @enum {boolean} */ found: false; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_smart_contract_logs: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description Cursor for transaction event pagination (block_height:microblock_sequence:tx_index:event_index) */ cursor?: string; }; header?: never; path: { /** * @description Contract identifier formatted as `.` * @example SP000000000000000000002Q6VF78.pox-3 */ contract_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; next_cursor: string | null; prev_cursor: string | null; cursor: string | null; results: ({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_mempool_fee_priorities: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { all: { no_priority: number; low_priority: number; medium_priority: number; high_priority: number; }; token_transfer?: { no_priority: number; low_priority: number; medium_priority: number; high_priority: number; }; contract_call?: { no_priority: number; low_priority: number; medium_priority: number; high_priority: number; }; smart_contract?: { no_priority: number; low_priority: number; medium_priority: number; high_priority: number; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_pox_cycles: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { block_height: number; index_block_hash: string; cycle_number: number; total_weight: number; total_stacked_amount: string; total_signers: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_pox_cycle: { parameters: { query?: never; header?: never; path: { /** @description PoX cycle number */ cycle_number: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { block_height: number; index_block_hash: string; cycle_number: number; total_weight: number; total_stacked_amount: string; total_signers: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_pox_cycle_signers: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { /** @description PoX cycle number */ cycle_number: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { signing_key: string; /** @description The Stacks address derived from the signing_key. */ signer_address: string; weight: number; stacked_amount: string; weight_percent: number; stacked_amount_percent: number; /** @description The number of solo stackers associated with this signer. */ solo_stacker_count: number; /** @description The number of pooled stackers associated with this signer. */ pooled_stacker_count: number; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_pox_cycle_signer: { parameters: { query?: never; header?: never; path: { /** @description PoX cycle number */ cycle_number: number; /** * @description Signer key * @example 0x038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d */ signer_key: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { signing_key: string; /** @description The Stacks address derived from the signing_key. */ signer_address: string; weight: number; stacked_amount: string; weight_percent: number; stacked_amount_percent: number; /** @description The number of solo stackers associated with this signer. */ solo_stacker_count: number; /** @description The number of pooled stackers associated with this signer. */ pooled_stacker_count: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_pox_cycle_signer_stackers: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { /** @description PoX cycle number */ cycle_number: number; /** * @description Signer key * @example 0x038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d */ signer_key: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { stacker_address: string; stacked_amount: string; pox_address: string; stacker_type: "solo" | "pooled"; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_address_transactions: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ exclude_function_args?: boolean; }; header?: never; path: { address: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; next_cursor: string | null; prev_cursor: string | null; cursor: string | null; results: { tx: { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "token_transfer"; token_transfer: { recipient_address: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; /** @description Hex encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string) */ memo: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Clarity code of the smart contract being deployed */ source_code: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; /** @description Function definition, including function name and type as well as parameter names and types */ function_signature: string; function_args?: { hex: string; repr: string; name: string; type: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "poison_microblock"; poison_microblock: { /** @description Hex encoded microblock header */ microblock_header_1: string; /** @description Hex encoded microblock header */ microblock_header_2: string; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "coinbase"; coinbase_payload: { /** @description Hex encoded 32-byte scratch space for block leader's use */ data: string; alt_recipient?: string | null; vrf_proof?: string | null; }; } | { /** @description Transaction ID */ tx_id: string; /** @description Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on. */ nonce: number; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description Address of the transaction initiator */ sender_address: string; sponsor_nonce?: number; /** @description Denotes whether the originating account is the same as the paying account */ sponsored: boolean; sponsor_address?: string; post_condition_mode: "allow" | "deny" | "originator"; post_conditions: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description `on_chain_only`: the transaction MUST be included in an anchored block, `off_chain_only`: the transaction MUST be included in a microblock, `any`: the leader can choose where to include the transaction. */ anchor_mode: "on_chain_only" | "off_chain_only" | "any"; /** @description Hash of the blocked this transactions was associated with */ block_hash: string; /** @description Height of the block this transactions was associated with */ block_height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined. */ block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ burn_block_time: number; /** @description Height of the anchor burn block. */ burn_block_height: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined. */ burn_block_time_iso: string; /** @description Unix timestamp (in seconds) indicating when this parent block was mined */ parent_burn_block_time: number; /** @description An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined. */ parent_burn_block_time_iso: string; /** @description Set to `true` if block corresponds to the canonical chain tip */ canonical: boolean; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; /** @description Status of the transaction */ tx_status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @description Result of the transaction. For contract calls, this will show the value returned by the call. For other transaction types, this will return a boolean indicating the success of the transaction. */ tx_result: { /** @description Hex string representing the value fo the transaction result */ hex: string; /** @description Readable string of the transaction result */ repr: string; }; /** @description Number of transaction events */ event_count: number; /** @description Hash of the previous block. */ parent_block_hash: string; /** @description True if the transaction is included in a microblock that has not been confirmed by an anchor block. Microblocks were removed in the Nakamoto upgrade, so this is always `false`. */ is_unanchored: boolean; /** @description The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be an empty string. */ microblock_hash: string; /** @description The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock) then this value will be 2147483647 (0x7fffffff, the max int32 value), this value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index). */ microblock_sequence: number; /** @description Set to `true` if microblock is anchored in the canonical chain tip, `false` if the transaction was orphaned in a micro-fork. */ microblock_canonical: boolean; /** @description Execution cost read count. */ execution_cost_read_count: number; /** @description Execution cost read length. */ execution_cost_read_length: number; /** @description Execution cost runtime. */ execution_cost_runtime: number; /** @description Execution cost write count. */ execution_cost_write_count: number; /** @description Execution cost write length. */ execution_cost_write_length: number; vm_error: string | null; events: (({ event_index: number; } & { /** @enum {string} */ event_type: "smart_contract_log"; tx_id: string; contract_log: { contract_id: string; topic: string; value: { hex: string; repr: string; }; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_lock"; tx_id: string; stx_lock_event: { locked_amount: string; unlock_height: number; locked_address: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "stx_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; sender: string; recipient: string; amount: string; memo?: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; amount: string; }; }) | ({ event_index: number; } & { /** @enum {string} */ event_type: "non_fungible_token_asset"; tx_id: string; asset: { asset_event_type: "transfer" | "mint" | "burn"; asset_id: string; sender: string; recipient: string; value: { hex: string; repr: string; }; }; }))[]; /** @enum {string} */ tx_type: "tenure_change"; tenure_change_payload: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; }; /** @description Total sent from the given address, including the tx fee, in micro-STX as an integer string. */ stx_sent: string; /** @description Total received by the given address in micro-STX as an integer string. */ stx_received: string; events: { stx: { transfer: number; mint: number; burn: number; }; ft: { transfer: number; mint: number; burn: number; }; nft: { transfer: number; mint: number; burn: number; }; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_address_transaction_events: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { address: string; /** * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: ({ /** @enum {string} */ type: "stx"; event_index: number; data: { type: "transfer" | "mint" | "burn"; /** @description Amount transferred in micro-STX as an integer string. */ amount: string; /** @description Principal that sent STX. This is unspecified if the STX were minted. */ sender?: string; /** @description Principal that received STX. This is unspecified if the STX were burned. */ recipient?: string; }; } | { /** @enum {string} */ type: "ft"; event_index: number; data: { type: "transfer" | "mint" | "burn"; /** @description Amount transferred as an integer string. This balance does not factor in possible SIP-010 decimals. */ amount: string; /** @description Fungible Token asset identifier. */ asset_identifier: string; /** @description Principal that sent the asset. */ sender?: string; /** @description Principal that received the asset. */ recipient?: string; }; } | { /** @enum {string} */ type: "nft"; event_index: number; data: { type: "transfer" | "mint" | "burn"; /** @description Non Fungible Token asset identifier. */ asset_identifier: string; value: { hex: string; repr: string; }; /** @description Principal that sent the asset. */ sender?: string; /** @description Principal that received the asset. */ recipient?: string; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_stx_balance: { parameters: { query?: { /** @description Include pending mempool transactions in the balance calculation */ include_mempool?: boolean; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { balance: string; /** @description Total STX balance considering pending mempool transactions */ estimated_balance?: string; /** @description Inbound STX balance from pending mempool transactions */ pending_balance_inbound?: string; /** @description Outbound STX balance from pending mempool transactions */ pending_balance_outbound?: string; total_sent?: string; total_received?: string; total_fees_sent?: string; total_miner_rewards_received: string; /** @description The transaction where the lock event occurred. Empty if no tokens are locked. */ lock_tx_id: string; /** @description The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked. */ locked: string; /** @description The STX chain block height of when the lock event occurred. Zero if no tokens are locked. */ lock_height: number; /** @description The burnchain block height of when the lock event occurred. Zero if no tokens are locked. */ burnchain_lock_height: number; /** @description The burnchain block height of when the tokens unlock. Zero if no tokens are locked. */ burnchain_unlock_height: number; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_ft_balances: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { token: string; balance: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_ft_balance: { parameters: { query?: never; header?: never; path: { principal: string; /** @description fungible token identifier, e.g. `SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token` */ token: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { balance: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_burnchain_address_pox_transactions: { parameters: { query?: { /** @description Results per page */ limit?: number; /** @description Result offset */ offset?: number; }; header?: never; path: { /** * @description Bitcoin Address * @example bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq */ burnchain_address: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 20 */ limit: number; /** @example 0 */ offset: number; /** @example 1 */ total: number; results: { /** @description Height of the burn block */ burn_block_height: number; /** @description Hash of the burn block */ burn_block_hash: string; /** @description Transaction ID */ tx_id: string; /** @description Recipient address */ recipient: string; /** @description UTXO index */ utxo_idx: number; /** @description Amount */ amount: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_block_transactions: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */ cursor?: string; }; header?: never; path: { height_or_hash: "latest" | string | number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: ({ /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "token_transfer"; token_transfer: { recipient: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; memo: { hex: string; repr: string; } | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "poison_microblock"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "coinbase"; coinbase: { alt_recipient: string | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "tenure_change"; tenure_change: { /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_mempool_transactions: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating mempool transactions. Format: receipt_time:tx_id */ cursor?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: ({ /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "token_transfer"; token_transfer: { recipient: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; memo: { hex: string; repr: string; } | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "poison_microblock"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "coinbase"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "tenure_change"; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_transactions: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */ cursor?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { transaction: { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "token_transfer"; token_transfer: { recipient: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; memo: { hex: string; repr: string; } | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "poison_microblock"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "coinbase"; coinbase: { alt_recipient: string | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "tenure_change"; tenure_change: { /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; }; }; /** @description How the principal is involved in the transaction. */ involvement: "sender" | "sponsor" | "affected"; balance_changes: { stx: { /** @description Total sent from the given address, including the tx fee, in micro-STX as an integer string. */ sent: string; /** @description Total received by the given address in micro-STX as an integer string. */ received: string; /** @description Net change in the principal's STX balance in micro-STX as an integer string. */ net: string; }; }; affected_balances: { /** @description Whether the principal's STX balance was affected by the transaction */ stx: boolean; /** @description Whether the principal's FT balance was affected by the transaction */ ft: boolean; /** @description Whether the principal's NFT balance was affected by the transaction */ nft: boolean; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_inbound_stx_transfers: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index */ cursor?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { sender: (string) | null; recipient: (string) | null; /** * Amount * @description Amount * @example 1000000 */ amount: string; memo: { hex: string; repr: string; } | null; transaction: { /** * Transaction ID * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_outbound_stx_transfers: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index */ cursor?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { sender: (string) | null; recipient: (string) | null; /** * Amount * @description Amount * @example 1000000 */ amount: string; memo: { hex: string; repr: string; } | null; transaction: { /** * Transaction ID * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_ft_transfers: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index */ cursor?: string; }; header?: never; path: { principal: string; /** * @description Asset Identifier * @example SP000000000000000000002Q6VF78.pox-3::stx-token */ asset_identifier: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { sender: (string) | null; recipient: (string) | null; /** * Amount * @description Transfer amount, in the token's own base units * @example 1000000 */ amount: string; transaction: { /** * Transaction ID * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_transaction_balance_changes: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating principal transaction balance changes. Format: `:` where `asset_type` is a numeric tag (1=STX, 2=FT, 3=NFT) and `asset_identifier` is `` for STX or a fully-qualified Clarity asset id such as `SP000…contract-name::asset-name` for FT/NFT. */ cursor?: string; }; header?: never; path: { principal: string; /** * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { asset: { /** @enum {string} */ type: "stx"; } | { /** @description The asset type that was affected by the balance change. */ type: "ft" | "nft"; /** @description The identifier of the asset that was affected by the balance change. */ identifier: string; }; balance_change: { /** @description Amount sent by the principal */ sent: string; /** @description Amount received by the principal */ received: string; /** @description Net balance change for the principal */ net: string; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_balance_changes: { parameters: { query: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating principal balance changes across multiple transactions. Format: `::::`. */ cursor?: string; /** @description Transaction ids to query balance changes for. Provide as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). */ tx_id: string[]; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { /** * Transaction ID * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; asset: { /** @enum {string} */ type: "stx"; } | { /** @description The asset type that was affected by the balance change. */ type: "ft" | "nft"; /** @description The identifier of the asset that was affected by the balance change. */ identifier: string; }; balance_change: { /** @description Amount sent by the principal */ sent: string; /** @description Amount received by the principal */ received: string; /** @description Net balance change for the principal */ net: string; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_staking_summary: { parameters: { query?: never; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { stx: { /** @description The amount of uSTX currently locked in pox-5 STX staking */ locked: string; rewards: { btc: { /** @description The lifetime sBTC reward sats accrued to this position */ accrued: string; /** @description The lifetime sBTC reward sats already claimed against this position */ claimed: string; /** @description The sBTC reward sats currently claimable (accrued minus claimed) */ claimable: string; }; }; }; bonds: { /** @description Number of bonds this principal has a position in */ count: number; locked: { /** @description Total BTC locked across all bond positions */ btc: string; /** @description Total STX locked across all bond positions */ stx: string; }; rewards: { btc: { /** @description The lifetime sBTC reward sats accrued to this position */ accrued: string; /** @description The lifetime sBTC reward sats already claimed against this position */ claimed: string; /** @description The sBTC reward sats currently claimable (accrued minus claimed) */ claimable: string; }; }; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_bond_positions: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating bonds. Format: bond_index */ cursor?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; status: "enrolled" | "running" | "early_exit" | "unlocked" | "rolled_over"; /** @description Whether the position is active */ active: boolean; enrollment: { /** * Transaction ID * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; btc_lockup: { /** @description The amount of BTC that is locked up for this principal */ amount: string; }; }; locked: { /** @description The amount of BTC locked in this bond position */ btc: string; /** @description The amount of STX locked in this bond position */ stx: string; }; rewards: { btc: { /** @description The lifetime sBTC reward sats accrued to this position */ accrued: string; /** @description The lifetime sBTC reward sats already claimed against this position */ claimed: string; /** @description The sBTC reward sats currently claimable (accrued minus claimed) */ claimable: string; }; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_balances_stx: { parameters: { query?: never; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Total micro-STX balance (available plus locked) */ balance: string; /** @description Spendable micro-STX balance (balance minus locked) */ available: string; locked: { /** @description The amount of locked micro-STX */ amount: string; /** @description The PoX contract version that created the lock (e.g. 4, 5) */ pox_version: number; /** * Transaction ID * @description Transaction ID */ lock_tx_id: string; /** @description The Stacks block height at which the lock was created */ stacks_lock_height: number; /** @description The burnchain block height at which the lock was created */ burn_lock_height: number; /** @description The burnchain block height at which the locked STX unlocks */ burn_unlock_height: number; } | null; mempool: { /** @description Estimated spendable micro-STX balance once pending mempool txs confirm */ estimated_balance: string; /** @description Pending inbound micro-STX from the mempool */ inbound: string; /** @description Pending outbound micro-STX from the mempool (transfers plus fees) */ outbound: string; } | null; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_balances_ft: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating FT balances (sorted by balance, descending). Format: balance:asset_identifier */ cursor?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 100 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { /** * @description Fungible token asset identifier * @example SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token */ asset_identifier: string; /** @description The principal's balance of this token, as a string-quoted integer in base units */ balance: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_balance_ft: { parameters: { query?: never; header?: never; path: { principal: string; /** * @description Asset Identifier * @example SP000000000000000000002Q6VF78.pox-3::stx-token */ asset_identifier: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * @description Fungible token asset identifier * @example SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token::sbtc-token */ asset_identifier: string; /** @description The principal's balance of this token, as a string-quoted integer in base units */ balance: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_balances_nft: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating NFT balances (sorted by asset identifier then value). Format: value:asset_identifier */ cursor?: string; /** * @description Return only the instances of this non-fungible token asset class. For example, BNS names are held as `SP000000000000000000002Q6VF78.bns::names` on mainnet. * @example SP000000000000000000002Q6VF78.pox-3::stx-token */ asset_identifier?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 100 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { /** * @description Non-fungible token asset identifier * @example SP2X0TZ59D5SZ8ACQ6YMCHHNR2ZN51Z32E2CJ173.the-explorer-guild::The-Explorer-Guild */ asset_identifier: string; /** @description The NFT instance identifier, as a Clarity value */ value: { hex: string; repr: string; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_nonces: { parameters: { query?: never; header?: never; path: { /** * @description Stacks Address * @example SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP */ principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The nonce to use for this principal's next transaction, derived from the latest confirmed and mempool nonces. May be inaccurate if the API is not fully synchronized. */ next_nonce: number; last_confirmed_nonce: number | null; /** PrincipalMempoolNonces */ mempool: { last_nonce: number | null; /** @description Intermediate nonces found in the mempool between the last confirmed nonce and the highest mempool nonce. */ pending_nonces: number[]; /** @description Expected intermediate nonces between the last confirmed nonce and the highest mempool nonce that are absent from the mempool — likely stalling transactions. */ missing_nonces: number[]; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_principal_mempool_transactions: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating mempool transactions. Format: receipt_time:tx_id */ cursor?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: ({ /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "token_transfer"; token_transfer: { recipient: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; memo: { hex: string; repr: string; } | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "poison_microblock"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "coinbase"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @enum {string} */ type: "tenure_change"; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_smart_contract: { parameters: { query?: { /** @description Heavy fields to include in the response. */ include?: "source_code"[]; }; header?: never; path: { /** * @description Smart Contract ID * @example SP000000000000000000002Q6VF78.pox-3 */ contract_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * Smart Contract ID * @description Smart Contract ID * @example SP000000000000000000002Q6VF78.pox-3 */ contract_id: string; clarity_version: number | null; /** * Transaction ID * @description ID of the transaction that deployed this contract * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description The Clarity source code of the contract. Only present when requested via the `include=source_code` query param. */ source_code?: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_bonds: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating bonds. Format: bond_index */ cursor?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { /** @description The index of the bond in the PoX-5 bond list */ index: number; /** @enum {string} */ pox_version: "pox5"; status: "upcoming" | "active" | "unlocked"; parameters: { /** @description The target yield rate (APY) in basis points */ target_rate_bps: number; /** @description This is a representation of the STXBTC price. The value represents "uSTX per 100 sats" */ stx_value_ratio: number; /** @description The amount of STX that must be locked relative to BTC, in equal-valued terms (ie in USD terms). This value is represented in basis points. */ minimum_stx_ratio: number; /** @description The total capacity of BTC that can be locked up for this bond */ btc_capacity: string; }; registrations: { /** @description The number of entries in the allowlist for this bond */ allowed_count: number; /** @description The number of registrations for this bond */ registered_count: number; }; schedule: { activation: { /** @description The Bitcoin height of this point in the bond lifecycle */ bitcoin_height: number; /** @description The PoX cycle of this point in the bond lifecycle */ pox_cycle: number; }; unlock: { /** @description The Bitcoin height of this point in the bond lifecycle */ bitcoin_height: number; /** @description The PoX cycle of this point in the bond lifecycle */ pox_cycle: number; }; }; balances: { locked: { /** @description The total amount of BTC that is locked up for this bond */ btc: string; /** @description The total amount of STX that is locked up for this bond */ stx: string; }; paid_out: { /** @description The total amount of BTC that has been paid out for this bond */ btc: string; }; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_bond: { parameters: { query?: never; header?: never; path: { /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The index of the bond in the PoX-5 bond list */ index: number; /** @enum {string} */ pox_version: "pox5"; status: "upcoming" | "active" | "unlocked"; parameters: { /** @description The target yield rate (APY) in basis points */ target_rate_bps: number; /** @description This is a representation of the STXBTC price. The value represents "uSTX per 100 sats" */ stx_value_ratio: number; /** @description The amount of STX that must be locked relative to BTC, in equal-valued terms (ie in USD terms). This value is represented in basis points. */ minimum_stx_ratio: number; /** @description The total capacity of BTC that can be locked up for this bond */ btc_capacity: string; }; registrations: { /** @description The number of entries in the allowlist for this bond */ allowed_count: number; /** @description The number of registrations for this bond */ registered_count: number; }; schedule: { activation: { /** @description The Bitcoin height of this point in the bond lifecycle */ bitcoin_height: number; /** @description The PoX cycle of this point in the bond lifecycle */ pox_cycle: number; }; unlock: { /** @description The Bitcoin height of this point in the bond lifecycle */ bitcoin_height: number; /** @description The PoX cycle of this point in the bond lifecycle */ pox_cycle: number; }; }; balances: { locked: { /** @description The total amount of BTC that is locked up for this bond */ btc: string; /** @description The total amount of STX that is locked up for this bond */ stx: string; }; paid_out: { /** @description The total amount of BTC that has been paid out for this bond */ btc: string; }; }; transaction: { /** @description The transaction ID that created the bond */ tx_id: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_bond_events: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index */ cursor?: string; }; header?: never; path: { /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: ({ /** @enum {string} */ name: "setup-bond"; /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; transaction: { /** * Transaction ID * @description Transaction ID */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; data: { parameters: { /** @description The target yield rate (APY) in basis points */ target_rate_bps: number; /** @description This is a representation of the STXBTC price. The value represents "uSTX per 100 sats" */ stx_value_ratio: number; /** @description The amount of STX that must be locked relative to BTC, in equal-valued terms (ie in USD terms). This value is represented in basis points. */ minimum_stx_ratio: number; }; /** @description Hex string of the Bitcoin script subscript guarding the early-exit branch of the L1 lockup */ early_unlock_bytes: string; schedule: { activation: { /** @description The Bitcoin height of this point in the bond lifecycle */ bitcoin_height: number; /** @description The PoX cycle of this point in the bond lifecycle */ pox_cycle: number; }; unlock: { /** @description The Bitcoin height of this point in the bond lifecycle */ bitcoin_height: number; /** @description The PoX cycle of this point in the bond lifecycle */ pox_cycle: number; }; }; }; } | { /** @enum {string} */ name: "add-to-allowlist"; /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; transaction: { /** * Transaction ID * @description Transaction ID */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; data: { staker: string; max_sats: string; }; } | { /** @enum {string} */ name: "register-for-bond"; /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; transaction: { /** * Transaction ID * @description Transaction ID */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; data: { staker: string; signer: string; type: "l1" | "l2"; balances: { /** * Amount * @description Amount */ btc: string; /** * Amount * @description Amount */ stx: string; }; }; } | { /** @enum {string} */ name: "update-bond-registration"; /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; transaction: { /** * Transaction ID * @description Transaction ID */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; data: { staker: string; signer: string; type: "l1" | "l2"; balances: { /** * Amount * @description Amount */ btc: string; /** * Amount * @description Amount */ stx: string; }; /** @description The previous signer of the registration */ old_signer: string; }; } | { /** @enum {string} */ name: "announce-l1-early-exit"; /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; transaction: { /** * Transaction ID * @description Transaction ID */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; data: { /** @description The staker exiting the bond early */ staker: string; /** @description The signer the staker was staked under */ signer: string; /** @description The sats released by the early exit */ released: { /** * Amount * @description Amount */ btc: string; }; }; } | { /** @enum {string} */ name: "unstake-sbtc"; /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; transaction: { /** * Transaction ID * @description Transaction ID */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; data: { /** @description The staker withdrawing sBTC from the bond */ staker: string; /** @description The signer the staker was staked under */ signer: string; /** @description The sats withdrawn */ withdrawn: { /** * Amount * @description Amount */ btc: string; }; /** @description The sBTC shares remaining after the withdrawal; 0 indicates a full early exit */ remaining: { /** * Amount * @description Amount */ btc: string; }; }; } | { /** @enum {string} */ name: "bond-distribution"; /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; transaction: { /** * Transaction ID * @description Transaction ID */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; data: { /** @description The `calculate-rewards` call this distribution was emitted by, from the `calculate-rewards` event in the same transaction. */ calculation: { /** @description The Bitcoin height the rewards were calculated for: the start of the distribution period, which can differ from the height of the block carrying this event. */ bitcoin_height: number; /** @description The PoX reward cycle the calculation (and this distribution) books to */ reward_cycle: number; }; /** @description The bond's target reward for this calculation, in sats */ target_yield: string; /** @description The rewards earned by this bond this calculation */ rewards: { /** * Amount * @description Amount */ btc: string; }; /** @description The sats staked in the bond at calculation time */ staked: { /** * Amount * @description Amount */ btc: string; }; /** @description The per-sat rewards accrued this calculation, as a 1e18 fixed-point integer */ accrued_rewards_per_sat: string; /** @description The running per-sat reward total for the bond after this calculation, as a 1e18 fixed-point integer */ cumulative_rewards_per_sat: string; }; } | { /** @enum {string} */ name: "claim-staker-rewards-for-signer"; /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; transaction: { /** * Transaction ID * @description Transaction ID */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; data: { /** @description The signer manager that claimed on behalf of the staker */ signer_manager: string; /** @description The staker the rewards were claimed for */ staker: string; /** @description The PoX reward cycle claimed */ reward_cycle: number; /** @description The sats claimed */ claimed: { /** * Amount * @description Amount */ btc: string; }; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_bond_allowlist_entries: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */ cursor?: string; }; header?: never; path: { /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { staker: string; max_sats: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_bond_allowlist_entry: { parameters: { query?: never; header?: never; path: { /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { staker: string; max_sats: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_bond_registrations: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */ cursor?: string; }; header?: never; path: { /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { staker: string; signer: string; type: "l1" | "l2"; balances: { /** * Amount * @description Amount * @example 1000000 */ btc: string; /** * Amount * @description Amount * @example 1000000 */ stx: string; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_bond_registration: { parameters: { query?: never; header?: never; path: { /** @description The index of the bond in the PoX-5 bond list */ bond_index: number; principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { staker: string; signer: string; type: "l1" | "l2"; balances: { /** * Amount * @description Amount */ btc: string; /** * Amount * @description Amount */ stx: string; }; l1_lockup: { /** @description The proven L1 lockup transactions */ transactions: { /** * Transaction ID * @description Transaction ID */ tx_id: string; /** @description The output index of the proven L1 lockup */ output_index: number; }[]; }; } | { staker: string; signer: string; type: "l1" | "l2"; balances: { /** * Amount * @description Amount */ btc: string; /** * Amount * @description Amount */ stx: string; }; l2_lockup: { /** * Transaction ID * @description Transaction ID */ tx_id: string; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_staking_cycle: { parameters: { query?: never; header?: never; path: { /** @description A PoX cycle number (up to nine digits), or one of `current` (the cycle containing the current Bitcoin tip), `previous`, or `next`. The prepare phase at the end of a cycle belongs to that cycle. */ cycle_number: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * @description The PoX reward cycle number * @example 143 */ number: number; /** @description Where the cycle stands relative to the current Bitcoin tip. */ status: "upcoming" | "reward_phase" | "prepare_phase" | "finished"; /** @description The Bitcoin heights delimiting the cycle, inclusive: its first block, the first block of its prepare phase, and its last block. */ schedule: { start: { /** @description The Bitcoin height of this point */ bitcoin_height: number; }; prepare_phase_start: { /** @description The Bitcoin height of this point */ bitcoin_height: number; }; end: { /** @description The Bitcoin height of this point */ bitcoin_height: number; }; }; /** @description The assets locked by staking for this cycle */ locked: { stx: { /** * Amount * @description STX locked in STX-only staking that counts for this cycle, in µSTX. * @example 1000000 */ stx_only: string; /** * Amount * @description STX locked across the bonds covering this cycle, in µSTX. * @example 1000000 */ bonds: string; /** * Amount * @description Sum of `stx_only` and `bonds`, in µSTX. * @example 1000000 */ total: string; }; btc: { /** * Amount * @description BTC locked across the bonds covering this cycle, in satoshis (proven Bitcoin L1 lockups and sBTC lockups). For a finished cycle this is the BTC staked per bond at the cycle's latest reward distribution; otherwise the bonds' running locked totals. * @example 1000000 */ total: string; /** * Amount * @description Of `total`, the satoshis locked through proven Bitcoin L1 lockups. * @example 1000000 */ native: string; /** * Amount * @description Of `total`, the satoshis locked through sBTC lockups. * @example 1000000 */ sbtc: string; }; }; /** @description Who participates in the cycle */ participants: { stakers: { /** @description Principals whose STX-only stake counts for this cycle. */ stx_only: number; /** @description Principals holding a position in a bond covering this cycle. */ bonds: number; }; signers: number | null; }; /** @description The pox-5 bonds active during this cycle */ bonds: { /** @description Bonds whose term covers this cycle */ total: number; /** @description Their bond indexes, ascending */ indexes: number[]; }; /** @description The rewards generated by this cycle */ rewards: { btc: { /** * Amount * @description sBTC rewards booked to this cycle by the pox-5 reward distributions run so far, in satoshis. Distributions run periodically within a cycle, so this grows while the cycle is active; it equals the sum of the `waterfall` entries. * @example 1000000 */ total: string; /** @description How the accrued rewards were split, in payout order */ waterfall: { /** * Amount * @description The share paid to bond participants, in satoshis. * @example 1000000 */ bonds: string; /** * Amount * @description The share paid to STX-only stakers, in satoshis. * @example 1000000 */ stx_only: string; /** * Amount * @description The share deposited into the protocol reserve, in satoshis. * @example 1000000 */ reserve_deposit: string; }; /** * Amount * @description sBTC claimed from the pox-5 contract by signer managers for this cycle so far, in satoshis. Claims trail distributions and can keep growing after the cycle ends. * @example 1000000 */ claimed: string; }; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_cycle_signers: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating a cycle's signers (sorted by weight descending, then signing key). Format: signing key */ cursor?: string; }; header?: never; path: { /** @description A PoX cycle number (up to nine digits), or one of `current` (the cycle containing the current Bitcoin tip), `previous`, or `next`. The prepare phase at the end of a cycle belongs to that cycle. */ cycle_number: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 100 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { /** * @description The signing key in the cycle's reward set, as a `0x`-prefixed hex string * @example 0x038e3c4529395611be9abf6fa3b6987e81d402385e3d605a073f42f407565a4a3d */ signing_key: string; /** @description The signer's voting weight in the cycle */ weight: { amount: number; /** @description Percentage of the cycle's total signer weight */ percent: number; }; /** @description The uSTX staked behind this signer in the cycle */ staked_stx: { amount: string; /** @description Percentage of the cycle's total staked STX */ percent: number; }; /** @description The signer manager contracts whose registered signing key (via `register-signer`) was this key when the cycle's reward set was calculated. */ signer_managers: { signer_manager: string; /** @description The position of the `register-signer` event that bound this key to the manager. */ registered_at: { /** @description Stacks block height of the `register-signer` event */ block_height: number; /** @description Bitcoin block height of the `register-signer` event */ bitcoin_block_height: number; /** * Transaction ID * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; }; /** @description The manager's live `grant-signer-key` authorizations (granted and not revoked). A grant authorizes a future `register-signer` for that key but does not rotate the key by itself. */ granted_keys: { /** @description The granted signing key, as a `0x`-prefixed hex string */ signer_key: string; /** @description The grant's auth id as a decimal string */ auth_id: string; /** * Transaction ID * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; }[]; /** @description Whether a live `grant-signer-key` authorization currently exists for the registered key. */ grant_active: boolean; pending_key_update: { /** @description The newly registered signing key, as a `0x`-prefixed hex string */ signer_key: string; /** @description The PoX cycle in which the new key takes effect */ effective_cycle: number; /** * Transaction ID * @description Transaction ID */ tx_id: string; } | null; }[]; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_staking_rewards: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { btc: { /** * Amount * @description Total Bitcoin generated by staking on the Stacks network, in satoshis, counted as the BTC paid by block commits to reward recipients: stacker reward addresses directly through pox-4, and the sBTC peg custody address from pox-5 on (whose inflows fund the sBTC staking rewards distributed through the pox-5 contract). * @example 9232234450122 */ reward_amount: string; /** * Amount * @description Total BTC burned by block commits, in satoshis, including pox-1 through pox-4 prepare-phase burns. Excludes the 2.0-era PoX sunset-ramp surcharge (bitcoin blocks ~766050-781551), which the node never reported. pox-5 commits do not burn. * @example 184023450122 */ burn_amount: string; /** * Amount * @description Sum of `reward_amount` and `burn_amount`, in satoshis: the total BTC block commits have spent toward staking across all history, whether paid to recipients or burned. * @example 9416257900244 */ total_amount: string; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_staking_signers: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating staking signers (sorted by signer). Format: signer principal */ cursor?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 100 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { signer: string; /** * @description The registered compressed secp256k1 public key, as a `0x`-prefixed hex string * @example 0x03a0f9e1... */ signer_key: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_staking_signer: { parameters: { query?: never; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { signer: string; /** * @description The registered compressed secp256k1 public key, as a `0x`-prefixed hex string * @example 0x03a0f9e1... */ signer_key: string; transaction: { /** * Transaction ID * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_staking_signer_stakers: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating a signer's stakers (sorted by staker). Format: staker principal */ cursor?: string; }; header?: never; path: { principal: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 100 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { staker: string; /** * @description The staking types this staker participates in under this signer: `stx` for direct pox-5 STX staking, `btc` for BTC/sBTC bond staking. A staker doing both has both entries. * @example [ * "stx" * ] */ types: ("stx" | "btc")[]; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_stx_total_supply: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * Amount * @description Total liquid STX supply as a string-quoted integer of micro-STX (µSTX): all STX minted (including vesting schedule unlocks) plus matured miner coinbase rewards, minus burned STX * @example 1470469916700000 */ total: string; /** * Amount * @description Projected total STX supply in the year 2050, as a string-quoted integer of micro-STX (µSTX). * @example 2318000000000000 */ projected_total_2050: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_stx_holders: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal */ cursor?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 100 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { principal: string; /** * Amount * @description The holder's balance, as a string-quoted integer in the token's own base units * @example 174823763 */ balance: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_fungible_token_holders: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal */ cursor?: string; }; header?: never; path: { /** * @description Asset Identifier * @example SP000000000000000000002Q6VF78.pox-3::stx-token */ asset_identifier: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 100 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { principal: string; /** * Amount * @description The holder's balance, as a string-quoted integer in the token's own base units * @example 174823763 */ balance: string; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_ft_total_supply: { parameters: { query?: never; header?: never; path: { /** * @description Asset Identifier * @example SP000000000000000000002Q6VF78.pox-3::stx-token */ asset_identifier: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * Asset Identifier * @description Asset Identifier * @example SP000000000000000000002Q6VF78.pox-3::stx-token */ asset_identifier: string; /** * Amount * @description Total supply of the token, as a string-quoted integer in the token's own base units. * @example 5817609278457 */ total: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_nft_instance_history: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index */ cursor?: string; }; header?: never; path: { /** * @description Asset Identifier * @example SP000000000000000000002Q6VF78.pox-3::stx-token */ asset_identifier: string; /** @description The token instance's identifier, either as a plain integer (a SIP-009 token id, which is serialized as a Clarity `uint`) or as a `0x`-prefixed serialized Clarity value. */ value: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 50 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: { sender: (string) | null; recipient: (string) | null; transaction: { /** * Transaction ID * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; /** @description Index of the event within the transaction */ event_index: number; }; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_transactions: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating transactions. Format: block_height:microblock_sequence:tx_index */ cursor?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: ({ /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "token_transfer"; token_transfer: { recipient: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; memo: { hex: string; repr: string; } | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "poison_microblock"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "coinbase"; coinbase: { alt_recipient: string | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "tenure_change"; tenure_change: { /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_transactions_batch: { parameters: { query: { /** @description Transaction ids to fetch summaries for. Provide as repeated querystring values (`?tx_id=A&tx_id=B`) or as a single comma-separated value (`?tx_id=A,B`). */ tx_id: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { results: ({ /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "token_transfer"; token_transfer: { recipient: string; /** @description Transfer amount as Integer string (64-bit unsigned integer) */ amount: string; memo: { hex: string; repr: string; } | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "smart_contract"; smart_contract: { clarity_version: number | null; /** @description Contract identifier formatted as `.` */ contract_id: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "contract_call"; contract_call: { /** @description Contract identifier formatted as `.` */ contract_id: string; /** @description Name of the Clarity function to be invoked */ function_name: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "poison_microblock"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "coinbase"; coinbase: { alt_recipient: string | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; /** @enum {string} */ type: "tenure_change"; tenure_change: { /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_transaction: { parameters: { query?: { /** @description Heavy fields to include in the response. Omitted by default to keep the payload lean. Provide as repeated querystring values (`?include=A&include=B`) or as a single comma-separated value (`?include=A,B`). */ include?: ("function_args" | "source_code" | "post_conditions" | "result")[]; }; header?: never; path: { /** * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": ({ /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; parent_block: { /** @description Hash of the parent block */ hash: string; /** @description Index block hash of the parent block */ index_hash: string; }; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description Number of events in the transaction */ event_count: number; execution_cost: { /** @description Number of reads in the transaction */ read_count: number; /** @description Length of reads in the transaction */ read_length: number; /** @description Runtime of the transaction */ runtime: number; /** @description Number of writes in the transaction */ write_count: number; /** @description Length of writes in the transaction */ write_length: number; }; vm_error: string | null; result?: { hex: string; repr: string; }; /** @enum {string} */ type: "token_transfer"; token_transfer: { /** @description Recipient of the token transfer */ recipient: string; /** @description Amount of the token transfer */ amount: string; memo: { hex: string; repr: string; } | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; parent_block: { /** @description Hash of the parent block */ hash: string; /** @description Index block hash of the parent block */ index_hash: string; }; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description Number of events in the transaction */ event_count: number; execution_cost: { /** @description Number of reads in the transaction */ read_count: number; /** @description Length of reads in the transaction */ read_length: number; /** @description Runtime of the transaction */ runtime: number; /** @description Number of writes in the transaction */ write_count: number; /** @description Length of writes in the transaction */ write_length: number; }; vm_error: string | null; result?: { hex: string; repr: string; }; /** @enum {string} */ type: "smart_contract"; smart_contract: { /** @description Contract ID of the smart contract */ contract_id: string; clarity_version: number | null; /** @description Source code of the smart contract. Only present when requested via the `include=source_code` query param. */ source_code?: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; parent_block: { /** @description Hash of the parent block */ hash: string; /** @description Index block hash of the parent block */ index_hash: string; }; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description Number of events in the transaction */ event_count: number; execution_cost: { /** @description Number of reads in the transaction */ read_count: number; /** @description Length of reads in the transaction */ read_length: number; /** @description Runtime of the transaction */ runtime: number; /** @description Number of writes in the transaction */ write_count: number; /** @description Length of writes in the transaction */ write_length: number; }; vm_error: string | null; result?: { hex: string; repr: string; }; /** @enum {string} */ type: "contract_call"; contract_call: { /** @description Contract ID of the contract call */ contract_id: string; /** @description Function name of the contract call */ function_name: string; /** @description List of arguments used to invoke the function. Only present when requested via the `include=function_args` query param. */ function_args?: { hex: string; repr: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; parent_block: { /** @description Hash of the parent block */ hash: string; /** @description Index block hash of the parent block */ index_hash: string; }; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description Number of events in the transaction */ event_count: number; execution_cost: { /** @description Number of reads in the transaction */ read_count: number; /** @description Length of reads in the transaction */ read_length: number; /** @description Runtime of the transaction */ runtime: number; /** @description Number of writes in the transaction */ write_count: number; /** @description Length of writes in the transaction */ write_length: number; }; vm_error: string | null; result?: { hex: string; repr: string; }; /** @enum {string} */ type: "poison_microblock"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; parent_block: { /** @description Hash of the parent block */ hash: string; /** @description Index block hash of the parent block */ index_hash: string; }; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description Number of events in the transaction */ event_count: number; execution_cost: { /** @description Number of reads in the transaction */ read_count: number; /** @description Length of reads in the transaction */ read_length: number; /** @description Runtime of the transaction */ runtime: number; /** @description Number of writes in the transaction */ write_count: number; /** @description Length of writes in the transaction */ write_length: number; }; vm_error: string | null; result?: { hex: string; repr: string; }; /** @enum {string} */ type: "tenure_change"; tenure_change: { /** @description Consensus hash of this tenure. Corresponds to the sortition in which the miner of this block was chosen. */ tenure_consensus_hash: string; /** @description Consensus hash of the previous tenure. Corresponds to the sortition of the previous winning block-commit. */ prev_tenure_consensus_hash: string; /** @description Current consensus hash on the underlying burnchain. Corresponds to the last-seen sortition. */ burn_view_consensus_hash: string; /** @description (Hex string) Stacks Block hash */ previous_tenure_end: string; /** @description The number of blocks produced in the previous tenure. */ previous_tenure_blocks: number; /** @description Cause of change in mining tenure. Depending on cause, tenure can be ended or extended. */ cause: "block_found" | "extended" | "extended_runtime" | "extended_read_count" | "extended_read_length" | "extended_write_count" | "extended_write_length"; /** @description (Hex string) The ECDSA public key hash of the current tenure. */ pubkey_hash: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; block: { /** @description Height of the block this transactions was associated with */ height: number; /** @description Hash of the blocked this transactions was associated with */ hash: string; /** @description Hash of the index block this transactions was associated with */ index_hash: string; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; /** @description Index of the transaction, indicating the order. Starts at `0` and increases with each transaction */ tx_index: number; }; bitcoin_block: { /** @description Height of the anchor burn block. */ height: number; /** @description Unix timestamp (in seconds) indicating when this block was mined. */ time: number; }; /** @description Status of the transaction */ status: "success" | "abort_by_response" | "abort_by_post_condition" | "problematic_skipped"; parent_block: { /** @description Hash of the parent block */ hash: string; /** @description Index block hash of the parent block */ index_hash: string; }; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; /** @description Number of events in the transaction */ event_count: number; execution_cost: { /** @description Number of reads in the transaction */ read_count: number; /** @description Length of reads in the transaction */ read_length: number; /** @description Runtime of the transaction */ runtime: number; /** @description Number of writes in the transaction */ write_count: number; /** @description Length of writes in the transaction */ write_length: number; }; vm_error: string | null; result?: { hex: string; repr: string; }; /** @enum {string} */ type: "coinbase"; coinbase: { /** @description Payload of the coinbase transaction */ payload: string; alt_recipient: string | null; vrf_proof: string | null; }; }) | ({ /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; replaced_by_tx_id: string | null; /** @enum {string} */ type: "token_transfer"; token_transfer: { /** @description Recipient of the token transfer */ recipient: string; /** @description Amount of the token transfer */ amount: string; memo: { hex: string; repr: string; } | null; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; replaced_by_tx_id: string | null; /** @enum {string} */ type: "smart_contract"; smart_contract: { /** @description Contract ID of the smart contract */ contract_id: string; clarity_version: number | null; /** @description Source code of the smart contract. Only present when requested via the `include=source_code` query param. */ source_code?: string; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; replaced_by_tx_id: string | null; /** @enum {string} */ type: "contract_call"; contract_call: { /** @description Contract ID of the contract call */ contract_id: string; /** @description Function name of the contract call */ function_name: string; /** @description List of arguments used to invoke the function. Only present when requested via the `include=function_args` query param. */ function_args?: { hex: string; repr: string; }[]; }; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; replaced_by_tx_id: string | null; /** @enum {string} */ type: "poison_microblock"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; replaced_by_tx_id: string | null; /** @enum {string} */ type: "tenure_change"; } | { /** @description Transaction ID */ tx_id: string; sender: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; }; sponsor: { /** @description Address of the transaction initiator */ address: string; /** @description Nonce of the transaction initiator */ nonce: number; } | null; /** @description Transaction fee as Integer string (64-bit unsigned integer). */ fee_rate: string; /** @description A unix timestamp (in seconds) indicating when the transaction broadcast was received by the node. */ receipt_time: number; /** @description Height of the block this transaction was received by the node */ receipt_block_height: number; /** @description Status of the mempool transaction */ status: "pending" | "dropped_replace_by_fee" | "dropped_replace_across_fork" | "dropped_too_expensive" | "dropped_stale_garbage_collect" | "dropped_problematic"; /** @description Post condition mode of the transaction. Only present when requested via the `include=post_conditions` query param. */ post_condition_mode?: "allow" | "deny" | "originator"; /** @description Only present when requested via the `include=post_conditions` query param. */ post_conditions?: ({ principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "stx"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "fungible"; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent" | "not_sent" | "maybe_sent"; /** @enum {string} */ type: "non_fungible"; asset_value: { hex: string; repr: string; }; asset: { asset_name: string; contract_address: string; contract_name: string; }; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "sent_equal_to" | "sent_greater_than" | "sent_greater_than_or_equal_to" | "sent_less_than" | "sent_less_than_or_equal_to"; amount: string; /** @enum {string} */ type: "staking"; } | { principal: { /** @enum {string} */ type_id: "principal_origin"; } | { /** @enum {string} */ type_id: "principal_standard"; address: string; } | { /** @enum {string} */ type_id: "principal_contract"; address: string; contract_name: string; }; condition_code: "not_performed" | "maybe_performed" | "performed"; /** @enum {string} */ type: "pox"; })[]; replaced_by_tx_id: string | null; /** @enum {string} */ type: "coinbase"; }); }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_transaction_events: { parameters: { query?: { /** @description Number of results per page */ limit?: number; /** @description Cursor for paginating transaction events. Format: event_index */ cursor?: string; }; header?: never; path: { /** * @description Transaction ID * @example 0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6 */ tx_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example 1 */ total: number; /** * @description Number of results per page * @default 20 */ limit: number; cursor: { next: string | null; previous: string | null; current: string | null; }; results: ({ event_index: number; /** @enum {string} */ type: "contract_log"; contract_log: { /** * Smart Contract ID * @description Smart Contract ID */ contract_id: string; /** @enum {string} */ topic: "print"; value: { hex: string; repr: string; }; }; } | { event_index: number; /** @enum {string} */ type: "stx_lock"; stx_lock: { /** * Amount * @description Amount */ amount: string; /** * Block height * @description Block height */ unlock_bitcoin_height: number; address: string; }; } | { event_index: number; /** @enum {string} */ type: "stx_asset"; stx_asset: { /** @enum {string} */ type: "transfer"; sender: string; recipient: string; /** * Amount * @description Amount */ amount: string; memo: { hex: string; repr: string; } | null; } | { /** @enum {string} */ type: "mint"; recipient: string; /** * Amount * @description Amount */ amount: string; } | { /** @enum {string} */ type: "burn"; sender: string; /** * Amount * @description Amount */ amount: string; }; } | { event_index: number; /** @enum {string} */ type: "ft_asset"; ft_asset: { /** @enum {string} */ type: "transfer"; /** * Asset Identifier * @description Asset Identifier */ asset_identifier: string; sender: string; recipient: string; /** * Amount * @description Amount */ amount: string; } | { /** @enum {string} */ type: "mint"; recipient: string; /** * Asset Identifier * @description Asset Identifier */ asset_identifier: string; /** * Amount * @description Amount */ amount: string; } | { /** @enum {string} */ type: "burn"; sender: string; /** * Asset Identifier * @description Asset Identifier */ asset_identifier: string; /** * Amount * @description Amount */ amount: string; }; } | { event_index: number; /** @enum {string} */ type: "nft_asset"; nft_asset: { /** @enum {string} */ type: "transfer"; /** * Asset Identifier * @description Asset Identifier */ asset_identifier: string; sender: string; recipient: string; value: { hex: string; repr: string; }; } | { /** @enum {string} */ type: "mint"; recipient: string; /** * Asset Identifier * @description Asset Identifier */ asset_identifier: string; value: { hex: string; repr: string; }; } | { /** @enum {string} */ type: "burn"; sender: string; /** * Asset Identifier * @description Asset Identifier */ asset_identifier: string; value: { hex: string; repr: string; }; }; })[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_historical_zone_file: { parameters: { query?: never; header?: never; path: { /** * @description fully-qualified name * @example muneeb.id */ name: string; /** * @description zone file hash * @example b100a68235244b012854a95f9114695679002af9 */ zoneFileHash: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Fetches the historical zonefile specified by the username and zone hash. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { zonefile: string; }; }; }; /** @description Error */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; }; }; }; }; }; fetch_subdomains_list_for_name: { parameters: { query?: never; header?: never; path: { /** * @description fully-qualified name * @example id.blockstack */ name: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Fetch a list of subdomains in a name. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string[]; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; fetch_zone_file: { parameters: { query?: never; header?: never; path: { /** * @description fully-qualified name * @example bar.test */ name: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Fetch a user's raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example $ORIGIN bar.test * $TTL 3600 * _https._tcp URI 10 1 "https://gaia.blockstack.org/hub/17Zijx61Sp7SbVfRTdETo7PhizJHYEUxbY/profile.json" * */ zonefile: string; }; }; }; /** @description Error */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { /** @example Invalid name or subdomain */ error: string; }; }; }; }; }; get_all_names: { parameters: { query?: { /** @description names are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter. */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Fetch a list of all names known to the node. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string[]; }; }; /** @description Error */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; }; }; }; }; }; get_name_info: { parameters: { query?: never; header?: never; path: { /** * @description fully-qualified name * @example muneeb.id */ name: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Get name details */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { address: string; /** @example stacks */ blockchain: string; expire_block?: number; grace_period?: number; last_txid: string; resolver?: string; status: string; zonefile?: string; zonefile_hash: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { [key: string]: string; }; }; }; }; }; get_all_namespaces: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** * BnsGetAllNamespacesResponse * @description Fetch a list of all namespaces known to the node. */ namespaces: string[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_namespace_names: { parameters: { query?: { /** * @description namespace values are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter. * @example 22 */ page?: number; }; header?: never; path: { /** * @description the namespace to fetch names from. * @example id */ tld: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Fetch a list of names from the namespace. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string[]; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { [key: string]: string; }; }; }; }; }; get_names_owned_by_address: { parameters: { query?: never; header?: never; path: { /** * @description the layer-1 blockchain for the address * @example stacks */ blockchain: string; /** * @description the address to lookup * @example SP2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKNRV9EJ7 */ address: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Retrieves a list of names owned by the address provided. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { names: string[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_namespace_price: { parameters: { query?: never; header?: never; path: { /** * @description the namespace to fetch price for * @example id */ tld: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Fetch price for namespace. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { units: string; amount: string; }; }; }; /** @description Error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; get_name_price: { parameters: { query?: never; header?: never; path: { /** * @description the name to query price information for * @example muneeb.id */ name: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Fetch price for name. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { units: string; amount: string; }; }; }; /** @description Error */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { error: string; message?: string; } & { [key: string]: unknown; }; }; }; }; }; }