From 153aa162e5a3d581e6af29b94e2fbfd388bfc0cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Pradel?= Date: Sat, 25 Oct 2025 17:50:16 +0200 Subject: [PATCH] fix: fix broken docs links to new docs --- README.md | 2 +- client/src/generated/schema.d.ts | 70 ++++++++++++++++++++++++++++---- src/api/routes/address.ts | 6 +-- src/api/routes/stx-supply.ts | 2 +- src/api/routes/tokens.ts | 6 +-- src/api/routes/v2/addresses.ts | 4 +- src/api/schemas/openapi.ts | 10 ++--- 7 files changed, 77 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 81f0a68e1d..301ef20330 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Get started at https://docs.hiro.so/clarinet/getting-started The docker image `hirosystems/stacks-blockchain-api` is recommended when running the API in a mainnet or testnet environment. -Note that this image cannot be ran standalone. Other services need to be configured correctly and running. For more information check out [this guide on how to run a node](https://docs.stacks.co/guides-and-tutorials/nodes-and-miners). +Note that this image cannot be ran standalone. Other services need to be configured correctly and running. For more information check out [this guide on how to run a node](https://docs.stacks.co/operate). ## Development quick start diff --git a/client/src/generated/schema.d.ts b/client/src/generated/schema.d.ts index e110639842..a26d5a2d09 100644 --- a/client/src/generated/schema.d.ts +++ b/client/src/generated/schema.d.ts @@ -223,7 +223,7 @@ export interface paths { }; /** * Get total and unlocked STX supply - * @description Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). + * @description Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/block-production/stacking). */ get: operations["get_stx_supply"]; put?: never; @@ -349,7 +349,7 @@ export interface paths { * @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/write-smart-contracts/tokens#non-fungible-tokens-nfts). + * 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_holdings"]; put?: never; @@ -371,7 +371,7 @@ export interface paths { * Non-Fungible Token history * @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/write-smart-contracts/tokens#non-fungible-tokens-nfts). + * 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; @@ -393,7 +393,7 @@ export interface paths { * Non-Fungible Token mints * @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/write-smart-contracts/tokens#non-fungible-tokens-nfts). + * 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; @@ -844,7 +844,7 @@ export interface paths { * @deprecated * @description **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions). * - * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types). + * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types). * * If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. */ @@ -1541,7 +1541,7 @@ export interface paths { * Get address transactions * @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/understand-stacks/transactions#types). + * More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types). */ get: operations["get_address_transactions"]; put?: never; @@ -1945,6 +1945,8 @@ export interface operations { * @example 123 */ nonce?: number; + /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ + exclude_function_args?: boolean; }; header?: never; path?: never; @@ -3302,6 +3304,8 @@ export interface operations { * @example true */ unanchored?: boolean; + /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ + exclude_function_args?: boolean; }; header?: never; path?: never; @@ -4709,6 +4713,7 @@ export interface operations { 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. */ @@ -4808,6 +4813,7 @@ export interface operations { 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. */ @@ -4907,6 +4913,7 @@ export interface operations { 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. */ @@ -5013,6 +5020,7 @@ export interface operations { 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. */ @@ -5111,6 +5119,7 @@ export interface operations { 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. */ @@ -5209,6 +5218,7 @@ export interface operations { 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. */ @@ -5289,6 +5299,8 @@ export interface operations { 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; @@ -5395,6 +5407,7 @@ export interface operations { 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. */ @@ -5494,6 +5507,7 @@ export interface operations { 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. */ @@ -5593,6 +5607,7 @@ export interface operations { 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. */ @@ -5699,6 +5714,7 @@ export interface operations { 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. */ @@ -5797,6 +5813,7 @@ export interface operations { 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. */ @@ -5895,6 +5912,7 @@ export interface operations { 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. */ @@ -6140,6 +6158,8 @@ export interface operations { * @example true */ unanchored?: boolean; + /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ + exclude_function_args?: boolean; }; header?: never; path: { @@ -7549,6 +7569,7 @@ export interface operations { 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. */ @@ -7648,6 +7669,7 @@ export interface operations { 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. */ @@ -7747,6 +7769,7 @@ export interface operations { 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. */ @@ -7853,6 +7876,7 @@ export interface operations { 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. */ @@ -7951,6 +7975,7 @@ export interface operations { 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. */ @@ -8049,6 +8074,7 @@ export interface operations { 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. */ @@ -8144,6 +8170,8 @@ export interface operations { 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: { @@ -9497,6 +9525,8 @@ export interface operations { 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: { @@ -18018,6 +18048,8 @@ export interface operations { unanchored?: boolean; /** @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: { @@ -22353,6 +22385,8 @@ export interface operations { * @example true */ unanchored?: boolean; + /** @description Exclude function_args from contract call responses for smaller transaction sizes. */ + exclude_function_args?: boolean; }; header?: never; path: { @@ -22461,6 +22495,7 @@ export interface operations { 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. */ @@ -22560,6 +22595,7 @@ export interface operations { 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. */ @@ -22659,6 +22695,7 @@ export interface operations { 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. */ @@ -22765,6 +22802,7 @@ export interface operations { 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. */ @@ -22863,6 +22901,7 @@ export interface operations { 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. */ @@ -22961,6 +23000,7 @@ export interface operations { 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. */ @@ -24605,6 +24645,7 @@ export interface operations { 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. */ @@ -24704,6 +24745,7 @@ export interface operations { 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. */ @@ -24803,6 +24845,7 @@ export interface operations { 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. */ @@ -24909,6 +24952,7 @@ export interface operations { 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. */ @@ -25007,6 +25051,7 @@ export interface operations { 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. */ @@ -25105,6 +25150,7 @@ export interface operations { 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. */ @@ -25222,6 +25268,7 @@ export interface operations { 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. */ @@ -25321,6 +25368,7 @@ export interface operations { 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. */ @@ -25420,6 +25468,7 @@ export interface operations { 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. */ @@ -25526,6 +25575,7 @@ export interface operations { 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. */ @@ -25624,6 +25674,7 @@ export interface operations { 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. */ @@ -25722,6 +25773,7 @@ export interface operations { 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. */ @@ -27347,7 +27399,7 @@ export interface operations { limit?: number; /** @description Result offset */ offset?: number; - /** @description Cursor for pagination */ + /** @description Cursor for block pagination */ cursor?: string; }; header?: never; @@ -29165,7 +29217,7 @@ export interface operations { limit?: number; /** @description Result offset */ offset?: number; - /** @description Cursor for pagination */ + /** @description Cursor for block pagination */ cursor?: string; }; header?: never; @@ -29651,6 +29703,8 @@ export interface operations { 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: { diff --git a/src/api/routes/address.ts b/src/api/routes/address.ts index 63fa9ca9de..600f3b3951 100644 --- a/src/api/routes/address.ts +++ b/src/api/routes/address.ts @@ -96,7 +96,7 @@ export const AddressRoutes: FastifyPluginAsync< operationId: 'get_account_stx_balance', summary: 'Get account STX balance', description: `**NOTE:** This endpoint is deprecated in favor of [Get address STX balance](/api/get-principal-stx-balance). - + Retrieves STX token balance for a given Address or Contract Identifier.`, tags: ['Accounts'], params: Type.Object({ @@ -167,7 +167,7 @@ export const AddressRoutes: FastifyPluginAsync< operationId: 'get_account_balance', summary: 'Get account balances', description: `**NOTE:** This endpoint is deprecated in favor of [Get address FT balances](/api/get-principal-ft-balances). - + 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.`, tags: ['Accounts'], params: Type.Object({ @@ -276,7 +276,7 @@ export const AddressRoutes: FastifyPluginAsync< summary: 'Get account transactions', description: `**NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions). - Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types). + Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types). If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.`, tags: ['Accounts'], diff --git a/src/api/routes/stx-supply.ts b/src/api/routes/stx-supply.ts index 52c45321fe..34ef3e51b9 100644 --- a/src/api/routes/stx-supply.ts +++ b/src/api/routes/stx-supply.ts @@ -52,7 +52,7 @@ export const StxSupplyRoutes: FastifyPluginAsync< schema: { operationId: 'get_stx_supply', summary: 'Get total and unlocked STX supply', - description: `Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).`, + description: `Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/block-production/stacking).`, tags: ['Info'], querystring: Type.Object({ height: Type.Optional( diff --git a/src/api/routes/tokens.ts b/src/api/routes/tokens.ts index e978bb8129..05096139e8 100644 --- a/src/api/routes/tokens.ts +++ b/src/api/routes/tokens.ts @@ -35,7 +35,7 @@ export const TokenRoutes: FastifyPluginAsync< 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/write-smart-contracts/tokens#non-fungible-tokens-nfts).`, + More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).`, tags: ['Non-Fungible Tokens'], querystring: Type.Object({ principal: PrincipalSchema, @@ -141,7 +141,7 @@ export const TokenRoutes: FastifyPluginAsync< summary: 'Non-Fungible Token history', 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/write-smart-contracts/tokens#non-fungible-tokens-nfts).`, + More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).`, tags: ['Non-Fungible Tokens'], querystring: Type.Object({ asset_identifier: Type.String({ @@ -256,7 +256,7 @@ export const TokenRoutes: FastifyPluginAsync< summary: 'Non-Fungible Token mints', 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/write-smart-contracts/tokens#non-fungible-tokens-nfts).`, + More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/build/create-tokens/creating-a-nft).`, tags: ['Non-Fungible Tokens'], querystring: Type.Object({ asset_identifier: Type.String({ diff --git a/src/api/routes/v2/addresses.ts b/src/api/routes/v2/addresses.ts index e7f175a8a4..33dd6da5df 100644 --- a/src/api/routes/v2/addresses.ts +++ b/src/api/routes/v2/addresses.ts @@ -44,8 +44,8 @@ export const AddressRoutesV2: FastifyPluginAsync< operationId: 'get_address_transactions', summary: 'Get address transactions', 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/understand-stacks/transactions#types).`, + + More information on Transaction types can be found [here](https://docs.stacks.co/transactions/how-transactions-work#types).`, tags: ['Transactions'], params: AddressParamsSchema, querystring: Type.Object({ diff --git a/src/api/schemas/openapi.ts b/src/api/schemas/openapi.ts index ca6038e006..a484ab68f0 100644 --- a/src/api/schemas/openapi.ts +++ b/src/api/schemas/openapi.ts @@ -26,7 +26,7 @@ export const OpenApiSchemaOptions: SwaggerOptions = { description: 'Read-only endpoints to obtain Stacks account details', externalDocs: { description: 'Stacks Documentation - Accounts', - url: 'https://docs.stacks.co/understand-stacks/accounts', + url: 'https://docs.stacks.co/network-fundamentals/accounts', }, }, { name: 'Blocks', description: 'Read-only endpoints to obtain Stacks block details' }, @@ -54,7 +54,7 @@ export const OpenApiSchemaOptions: SwaggerOptions = { description: 'Read-only endpoints realted to the Blockchain Naming System on Stacks', externalDocs: { description: 'Stacks Documentation - Blockchain Naming System', - url: 'https://docs.stacks.co/build-apps/references/bns', + url: 'https://docs.stacks.co/network-fundamentals/bitcoin-name-system', }, }, { @@ -62,7 +62,7 @@ export const OpenApiSchemaOptions: SwaggerOptions = { description: 'Read-only endpoints to obtain non-fungible token details', externalDocs: { description: 'Stacks Documentation - Tokens', - url: 'https://docs.stacks.co/write-smart-contracts/tokens', + url: 'https://docs.stacks.co/build/create-tokens', }, }, { @@ -83,7 +83,7 @@ export const OpenApiSchemaOptions: SwaggerOptions = { description: 'Read-only endpoints to obtain Clarity smart contract details', externalDocs: { description: 'Stacks Documentation - Clarity Smart Contracts', - url: 'https://docs.stacks.co/write-smart-contracts/overview', + url: 'https://docs.stacks.co/clarity/overview', }, }, { @@ -91,7 +91,7 @@ export const OpenApiSchemaOptions: SwaggerOptions = { description: 'Read-only endpoints to obtain Stacking reward details', externalDocs: { description: 'Stacks Documentation - Stacking', - url: 'https://docs.stacks.co/understand-stacks/stacking', + url: 'https://docs.stacks.co/block-production/stacking', }, }, {