From eb8d4aa86150a93e4d6dcf0b41e0076c424529ea Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Thu, 1 May 2025 09:56:48 -0300 Subject: [PATCH 01/13] chore: update OpenAPI specification and documentation visual improvements - Updated API title to reflect rebranding to Mesh API. - Enhanced some endpoint descriptions for clarity and accuracy (network status, options, block transaction). - Added detailed descriptions for Cardano-specific transaction and block metadata. - Commented out unimplemented mempool endpoints and related documentation. - Improved Docusaurus configuration for better user experience, including last update timestamps . - Updated CSS for improved layout and styling consistency across documentation pages. --- .../rosetta-specifications-1.4.15/api.yaml | 762 ++++++++++-------- .../development/performance-measurements.md | 2 +- docs/docs/development/qa-regression.md | 2 +- docs/docusaurus.config.js | 11 + docs/package.json | 2 +- docs/src/css/custom.css | 403 ++++++--- docs/src/pages/index.js | 2 +- docs/src/pages/index.module.css | 2 + 8 files changed, 755 insertions(+), 431 deletions(-) diff --git a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml index 23f3a2b430..e9decffd7e 100644 --- a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml +++ b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml @@ -1,7 +1,7 @@ openapi: 3.0.2 info: version: 1.4.13 - title: Rosetta + title: Mesh (formerly Rosetta) API for Cardano description: Build Once. Integrate Your Blockchain Everywhere. license: name: Apache 2.0 @@ -36,7 +36,7 @@ paths: /network/status: post: summary: Get Network Status - description: This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. + description: This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list is accessible here. operationId: networkStatus tags: - Network @@ -62,7 +62,7 @@ paths: /network/options: post: summary: Get Network Options - description: This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. + description: This endpoint provides version information and supported types for the specified network. It helps users understand what features and options are available on the network they're connecting to. Each network may have different capabilities, so this endpoint allows you to discover what's supported before making other API calls. operationId: networkOptions tags: - Network @@ -114,7 +114,7 @@ paths: /block/transaction: post: summary: Get a Block Transaction - description: 'Get a transaction in a block by its Transaction Identifier. This endpoint should only be used when querying a node for a block does not return all transactions contained within it. All transactions returned by this endpoint must be appended to any transactions returned by the /block method by consumers of this data. Fetching a transaction by hash is considered an Explorer Method (which is classified under the Future Work section). This method can be used to let consumers to paginate results when the block trasactions count is too big to be returned in a single BlockResponse. Calling this endpoint requires reference to a BlockIdentifier because transaction parsing can change depending on which block contains the transaction. For example, in Bitcoin it is necessary to know which block contains a transaction to determine the destination of fee payments. Without specifying a block identifier, the node would have to infer which block to use (which could change during a re-org). Implementations that require fetching previous transactions to populate the response (ex: Previous UTXOs in Bitcoin) may find it useful to run a cache within the Rosetta server in the /data directory (on a path that does not conflict with the node).' + description: 'Get a transaction in a block by its Transaction Identifier. This endpoint should only be used when querying a node for a block does not return all transactions contained within it (e.g., only hashes are returned in /block). All transactions returned by this endpoint must be appended to any transactions returned by the /block method by consumers of this data. Calling this endpoint requires reference to a BlockIdentifier because transaction parsing (especially script context) can change depending on which block contains the transaction. Cardano transactions include inputs, outputs (which may contain native assets), certificates (e.g., staking, pool registration), withdrawals, metadata, minting information, and script witnesses. Implementations that require fetching previous transactions to populate the response (ex: UTXOs for inputs) may find it useful to run a cache.' operationId: blockTransaction tags: - Block @@ -137,62 +137,62 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' - /mempool: - post: - summary: Get All Mempool Transactions - description: Get all Transaction Identifiers in the mempool - operationId: mempool - tags: - - Mempool - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/MempoolResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /mempool/transaction: - post: - summary: Get a Mempool Transaction - description: 'Get a transaction in the mempool by its Transaction Identifier. This is a separate request than fetching a block transaction (/block/transaction) because some blockchain nodes need to know that a transaction query is for something in the mempool instead of a transaction in a block. Transactions may not be fully parsable until they are in a block (ex: may not be possible to determine the fee to pay before a transaction is executed). On this endpoint, it is ok that returned transactions are only estimates of what may actually be included in a block.' - operationId: mempoolTransaction - tags: - - Mempool - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/MempoolTransactionRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/MempoolTransactionResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + # /mempool: # TODO: Add mempool endpoint support + # post: + # summary: Get All Mempool Transactions + # description: Not implemented. + # operationId: mempool + # tags: + # - Mempool + # requestBody: + # required: true + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/NetworkRequest' + # responses: + # '200': + # description: Expected response to a valid request + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/MempoolResponse' + # '500': + # description: unexpected error + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/Error' + # /mempool/transaction: # TODO: Add mempool transaction endpoint support + # post: + # summary: Get a Mempool Transaction + # description: Not implemented. + # operationId: mempoolTransaction + # tags: + # - Mempool + # requestBody: + # required: true + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/MempoolTransactionRequest' + # responses: + # '200': + # description: Expected response to a valid request + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/MempoolTransactionResponse' + # '500': + # description: unexpected error + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/Error' /account/balance: post: summary: Get an Account's Balance - description: Get an array of all AccountBalances for an AccountIdentifier and the BlockIdentifier at which the balance lookup was performed. The BlockIdentifier must always be returned because some consumers of account balance data need to know specifically at which block the balance was calculated to compare balances they compute from operations with the balance returned by the node. It is important to note that making a balance request for an account without populating the SubAccountIdentifier should not result in the balance of all possible SubAccountIdentifiers being returned. Rather, it should result in the balance pertaining to no SubAccountIdentifiers being returned (sometimes called the liquid balance). To get all balances associated with an account, it may be necessary to perform multiple balance requests with unique AccountIdentifiers. It is also possible to perform a historical balance lookup (if the server supports it) by passing in an optional BlockIdentifier. + description: 'Get an array of all AccountBalances for an AccountIdentifier (typically a Cardano payment address `addr...`) and the BlockIdentifier at which the balance lookup was performed. Balances include ADA and any native assets (tokens) held by the account at that block. The BlockIdentifier must always be returned for reconciliation. In Cardano, accounts often consist of a payment part (controlled by payment credentials) and an optional delegation part (controlled by stake credentials/address `stake...`). This endpoint typically queries based on the payment address. Querying rewards or stake delegation status might require specific handling or different endpoints/calls. Making a balance request without populating SubAccountIdentifier should return the balance associated with the main address, not aggregated sub-balances. It is also possible to perform a historical balance lookup (if the server supports it) by passing in an optional BlockIdentifier.' operationId: accountBalance tags: - Account @@ -217,8 +217,8 @@ paths: $ref: '#/components/schemas/Error' /account/coins: post: - summary: Get an Account's Unspent Coins - description: Get an array of all unspent coins for an AccountIdentifier and the BlockIdentifier at which the lookup was performed. If your implementation does not support coins (i.e. it is for an account-based blockchain), you do not need to implement this endpoint. If you implementation does support coins (i.e. it is fro a UTXO-based blockchain), you MUST also complete the `/account/balance` endpoint. It is important to note that making a coins request for an account without populating the SubAccountIdentifier should not result in the coins of all possible SubAccountIdentifiers being returned. Rather, it should result in the coins pertaining to no SubAccountIdentifiers being returned. To get all coins associated with an account, it may be necessary to perform multiple coin requests with unique AccountIdentifiers. Optionally, an implementation may choose to support updating an AccountIdentifier's unspent coins based on the contents of the mempool. Note, using this functionality breaks any guarantee of idempotency. + summary: Get an Account's Unspent Coins (UTXOs) + description: Get an array of all unspent coins (UTXOs) for an AccountIdentifier (typically a Cardano payment address `addr...`) and the BlockIdentifier at which the lookup was performed. This endpoint is essential for UTXO-based blockchains like Cardano. Each Coin (UTXO) includes its identifier (tx_hash:index), its ADA value, and potentially native assets held within it (often returned in Coin.metadata). Implementations MUST also complete the `/account/balance` endpoint. Making a coins request without populating SubAccountIdentifier should return coins associated with the main address. Optionally, an implementation may support `include_mempool` to show coins considering pending transactions, but this breaks idempotency guarantees. operationId: accountCoins tags: - Account @@ -244,7 +244,7 @@ paths: /construction/derive: post: summary: Derive an AccountIdentifier from a PublicKey - description: Derive returns the AccountIdentifier associated with a public key. Blockchains that require an on-chain action to create an account should not implement this method. + description: Derive returns the AccountIdentifier (typically a payment address `addr...` potentially associated with a stake address `stake...`) associated with a public key and optional derivation parameters (e.g., specifying network or address type). Cardano uses hierarchical deterministic key derivation (e.g., BIP-44, CIP-1852) and different address types (Base, Enterprise, Reward). Metadata might be needed to specify the desired address type or associated staking key. operationId: constructionDerive tags: - Construction @@ -269,8 +269,8 @@ paths: $ref: '#/components/schemas/Error' /construction/preprocess: post: - summary: Create a Request to Fetch Metadata - description: Preprocess is called prior to `/construction/payloads` to construct a request for any metadata that is needed for transaction construction given (i.e. account nonce). The `options` object returned from this endpoint will be sent to the `/construction/metadata` endpoint UNMODIFIED by the caller (in an offline execution environment). If your Construction API implementation has configuration options, they MUST be specified in the `/construction/preprocess` request (in the `metadata` field). + summary: Create a Request to Fetch Metadata for Construction + description: Preprocess is called prior to `/construction/payloads` to construct a request for any metadata needed for transaction construction given the intended operations (e.g., calculating fees requires estimated transaction size, which depends on inputs, outputs, certificates etc.; deposit amounts might be needed). The `options` object returned (e.g., containing relative TTL, estimated size) will be sent to `/construction/metadata`. Configuration options (like specific era constraints) MUST be specified in the `metadata` field of this request if needed. Cardano transaction construction involves details like TTL (slot number), fees, potentially certificates, withdrawals, scripts, and native assets. operationId: constructionPreprocess tags: - Construction @@ -296,7 +296,7 @@ paths: /construction/metadata: post: summary: Get Metadata for Transaction Construction - description: Get any information required to construct a transaction for a specific network. Metadata returned here could be a recent hash to use, an account sequence number, or even arbitrary chain state. The request used when calling this endpoint is created by calling `/construction/preprocess` in an offline environment. You should NEVER assume that the request sent to this endpoint will be created by the caller or populated with any custom parameters. This must occur in `/construction/preprocess`. It is important to clarify that this endpoint should not pre-construct any transactions for the client (this should happen in `/construction/payloads`). This endpoint is left purposely unstructured because of the wide scope of metadata that could be required. + description: Get network-specific information required to construct a transaction based on the request from `/construction/preprocess`. For Cardano, this typically includes current protocol parameters (needed for fee calculation, deposit amounts, script cost models), and potentially the current slot number to calculate absolute TTL. The request is created by calling `/construction/preprocess` offline. You should NEVER assume the request sent to this endpoint will be populated with custom parameters; they must come from `/construction/preprocess`. This endpoint returns metadata like protocol parameters and calculated absolute TTL, not a pre-constructed transaction. operationId: constructionMetadata tags: - Construction @@ -322,7 +322,7 @@ paths: /construction/payloads: post: summary: Generate an Unsigned Transaction and Signing Payloads - description: Payloads is called with an array of operations and the response from `/construction/metadata`. It returns an unsigned transaction blob and a collection of payloads that must be signed by particular AccountIdentifiers using a certain SignatureType. The array of operations provided in transaction construction often times can not specify all "effects" of a transaction (consider invoked transactions in Ethereum). However, they can deterministically specify the "intent" of the transaction, which is sufficient for construction. For this reason, parsing the corresponding transaction in the Data API (when it lands on chain) will contain a superset of whatever operations were provided during construction. + description: Payloads is called with an array of intended operations and the response from `/construction/metadata`. It returns an unsigned transaction blob (typically the CBOR transaction body for Cardano) and a collection of signing payloads (hashes of the transaction body) that must be signed by specific keys (identified by AccountIdentifiers). The operations provided specify the "intent" (inputs, outputs, certificates, withdrawals, minting). Parsing the final transaction on-chain might yield a superset of these operations if intermediary steps occurred (though less common in Cardano than EVM). Cardano signing requires witnesses (signatures) for inputs, certificates, withdrawals, and potentially scripts. operationId: constructionPayloads tags: - Construction @@ -348,7 +348,7 @@ paths: /construction/combine: post: summary: Create Network Transaction from Signatures - description: Combine creates a network-specific transaction from an unsigned transaction and an array of provided signatures. The signed transaction returned from this method will be sent to the `/construction/submit` endpoint by the caller. + description: Combine creates a network-specific signed transaction from an unsigned transaction blob (the CBOR transaction body from `/construction/payloads`) and an array of provided signatures (typically forming a Cardano `TransactionWitnessSet`). The signed transaction returned (the full CBOR transaction including body and witness set) will be sent to the `/construction/submit` endpoint by the caller. operationId: constructionCombine tags: - Construction @@ -374,7 +374,7 @@ paths: /construction/parse: post: summary: Parse a Transaction - description: 'Parse is called on both unsigned and signed transactions to understand the intent of the formulated transaction. This is run as a sanity check before signing (after `/construction/payloads`) and before broadcast (after `/construction/combine`). ' + description: 'Parse is called on both unsigned (CBOR tx body) and signed (CBOR full tx) Cardano transactions to understand the intent and verify signers. This is run as a sanity check before signing (after `/construction/payloads`) and before broadcast (after `/construction/combine`). The response should detail the operations (inputs, outputs, certificates, withdrawals, minting) and the required/provided signers.' operationId: constructionParse tags: - Construction @@ -400,7 +400,7 @@ paths: /construction/hash: post: summary: Get the Hash of a Signed Transaction - description: TransactionHash returns the network-specific transaction hash for a signed transaction. + description: TransactionHash returns the network-specific transaction hash (typically Blake2b-256 of the CBOR transaction body) for a signed Cardano transaction (CBOR full transaction including body and witnesses). operationId: constructionHash tags: - Construction @@ -426,7 +426,7 @@ paths: /construction/submit: post: summary: Submit a Signed Transaction - description: Submit a pre-signed transaction to the node. This call should not block on the transaction being included in a block. Rather, it should return immediately with an indication of whether or not the transaction was included in the mempool. The transaction submission response should only return a 200 status if the submitted transaction could be included in the mempool. Otherwise, it should return an error. + description: Submit a pre-signed Cardano transaction (full CBOR transaction) to the node. This call should not block on the transaction being included in a block. Rather, it should return immediately with an indication of whether or not the transaction was accepted into the mempool. The transaction submission response should only return a 200 status if the submitted transaction could be included in the mempool. Otherwise, it should return an error detailing the rejection reason (e.g., invalid TTL, fee too low, validation error). operationId: constructionSubmit tags: - Construction @@ -449,62 +449,62 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' - /call: - post: - summary: Make a Network-Specific Procedure Call - description: Call invokes an arbitrary, network-specific procedure call with network-specific parameters. The guidance for what this endpoint should or could do is purposely left vague. In Ethereum, this could be used to invoke `eth_call` to implement an entire Rosetta API interface for some smart contract that is not parsed by the implementation creator (like a DEX). This endpoint could also be used to provide access to data that does not map to any Rosetta models instead of requiring an integrator to use some network-specific SDK and call some network-specific endpoint (like surfacing staking parameters). Call is NOT a replacement for implementing Rosetta API endpoints or mapping network-specific data to Rosetta models. Rather, it enables developers to build additional Rosetta API interfaces for things they care about without introducing complexity into a base-level Rosetta implementation. Simply put, imagine that the average integrator will use layered Rosetta API implementations that each surfaces unique data. - operationId: call - tags: - - Call - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CallRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/CallResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /events/blocks: - post: - summary: '[INDEXER] Get a range of BlockEvents' - description: '`/events/blocks` allows the caller to query a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. Following BlockEvents allows lightweight clients to update their state without needing to implement their own syncing logic (like finding the common parent in a reorg). `/events/blocks` is considered an "indexer" endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' - operationId: eventsBlocks - tags: - - Events - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/EventsBlocksRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/EventsBlocksResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + # /call: + # post: + # summary: Make a Network-Specific Procedure Call + # description: Call invokes an arbitrary, network-specific procedure call with network-specific parameters. The guidance for what this endpoint should or could do is purposely left vague. In Ethereum, this could be used to invoke `eth_call` to implement an entire Rosetta API interface for some smart contract that is not parsed by the implementation creator (like a DEX). This endpoint could also be used to provide access to data that does not map to any Rosetta models instead of requiring an integrator to use some network-specific SDK and call some network-specific endpoint (like surfacing staking parameters). Call is NOT a replacement for implementing Rosetta API endpoints or mapping network-specific data to Rosetta models. Rather, it enables developers to build additional Rosetta API interfaces for things they care about without introducing complexity into a base-level Rosetta implementation. Simply put, imagine that the average integrator will use layered Rosetta API implementations that each surfaces unique data. + # operationId: call + # tags: + # - Call + # requestBody: + # required: true + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/CallRequest' + # responses: + # '200': + # description: Expected response to a valid request + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/CallResponse' + # '500': + # description: unexpected error + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/Error' + # /events/blocks: + # post: + # summary: '[INDEXER] Get a range of BlockEvents' + # description: '`/events/blocks` allows the caller to query a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. Following BlockEvents allows lightweight clients to update their state without needing to implement their own syncing logic (like finding the common parent in a reorg). `/events/blocks` is considered an "indexer" endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' + # operationId: eventsBlocks + # tags: + # - Events + # requestBody: + # required: true + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/EventsBlocksRequest' + # responses: + # '200': + # description: Expected response to a valid request + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/EventsBlocksResponse' + # '500': + # description: unexpected error + # content: + # application/json: + # schema: + # $ref: '#/components/schemas/Error' /search/transactions: post: summary: '[INDEXER] Search for Transactions' - description: '`/search/transactions` allows the caller to search for transactions that meet certain conditions. Some conditions include matching a transaction hash, containing an operation with a certain status, or containing an operation that affects a certain account. `/search/transactions` is considered an "indexer" endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' + description: '`/search/transactions` allows the caller to search for transactions that meet certain conditions within canonical blocks. Conditions can include matching a transaction hash, involving a specific address (`AccountIdentifier.Address`), containing operations of a specific type (e.g., `StakeDelegation`) or status, or involving a specific native asset (`Currency`). `/search/transactions` is considered an indexer endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' operationId: searchTransactions tags: - Search @@ -538,26 +538,14 @@ components: properties: blockchain: type: string - example: bitcoin - network: - description: If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet. - type: string - example: mainnet - sub_network_identifier: - $ref: '#/components/schemas/SubNetworkIdentifier' - SubNetworkIdentifier: - description: In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains. - type: object - required: - - network - properties: + example: cardano network: + description: This field contains the specific network identifier for the blockchain, such as 'mainnet', 'preprod', or 'preview' for Cardano. This helps identify which network you are connecting to. type: string - example: shard 1 - metadata: - type: object - example: - producer: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' + examples: + - mainnet + - preprod + - preview BlockIdentifier: description: The block_identifier uniquely identifies a block in a particular network. type: object @@ -569,10 +557,10 @@ components: description: This is also known as the block height. type: integer format: int64 - example: 1123941 + example: 3430923 hash: type: string - example: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85' + example: '7985774c96490dfcde55b80523ac4c2dc27243a479ee8d236800ed4e1773fd8b' description: This should be normalized according to the case specified in the block_hash_case network options. PartialBlockIdentifier: type: object @@ -581,10 +569,10 @@ components: index: type: integer format: int64 - example: 1123941 + example: 3430923 hash: type: string - example: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85' + example: '7985774c96490dfcde55b80523ac4c2dc27243a479ee8d236800ed4e1773fd8b' TransactionIdentifier: description: The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool. type: object @@ -614,7 +602,7 @@ components: minimum: 0 example: 0 AccountIdentifier: - description: The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated). + description: The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated). For Cardano, the `address` field typically contains the bech32 payment address (`addr...`). The associated stake address (`stake...`) might be derivable or stored/queried separately, potentially indicated via `metadata` or specific API calls if supported. Implementations should clarify how stake addresses and rewards are handled. type: object required: - address @@ -701,9 +689,9 @@ components: type: string example: Transfer status: - description: Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. On-chain operations (operations retrieved in the `/block` and `/block/transaction` endpoints) MUST have a populated status field (anything on-chain must have succeeded or failed). However, operations provided during transaction construction (often times called "intent" in the documentation) MUST NOT have a populated status field (operations yet to be included on-chain have not yet succeeded or failed). + description: Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. Cardano transactions are generally atomic; they either succeed entirely and are included in a block or fail validation and are rejected. Therefore, the status for operations within a block transaction will typically be a single success value defined in NetworkOptionsResponse. On-chain operations (operations retrieved in the `/block` and `/block/transaction` endpoints) MUST have a populated status field. Operations provided during transaction construction (often called "intent") MUST NOT have a populated status field. type: string - example: Reverted + example: success # Example for Cardano account: $ref: '#/components/schemas/AccountIdentifier' amount: @@ -728,7 +716,7 @@ components: metadata: type: object Currency: - description: Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins). + description: Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (e.g., Lovelace for ADA) to standard units (e.g., ADA). For Cardano native assets, the `symbol` is often the asset name (or hex-encoded name), `decimals` is 0, and `metadata` contains the `policyId` and potentially the human-readable `assetName`. type: object required: - symbol @@ -759,11 +747,11 @@ components: description: TargetIndex is the index of the block that the implementation is attempting to sync to in the current stage. type: integer format: int64 - example: 150 - stage: - description: Stage is the phase of the sync process. - type: string - example: header sync + example: 3430923 + #stage: # TODO: Add stage property to SyncStatus + # description: Stage is the phase of the sync process. + # type: string + # example: header sync synced: description: synced is a boolean that indicates if an implementation has synced up to the most recent block. If this field is not populated, the caller should rely on a traditional tip timestamp comparison to determine if an implementation is synced. This field is particularly useful for quiescent blockchains (blocks only produced when there are pending transactions). In these blockchains, the most recent block could have a timestamp far behind the current time but the node could be healthy and at tip. type: boolean @@ -775,7 +763,7 @@ components: properties: peer_id: type: string - example: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' + example: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' # TODO: Add a proper example for peer_id metadata: type: object Version: @@ -813,21 +801,88 @@ components: - mempool_coins properties: operation_statuses: - description: All Operation.Status this implementation supports. Any status that is returned during parsing that is not listed here will cause client validation to error. + description: All Operation.Status this implementation supports. For Cardano, typically only a single status representing success is needed for block transactions, as failed transactions are usually rejected by the node before inclusion. type: array items: $ref: '#/components/schemas/OperationStatus' + example: + - status: 'success' + successful: true operation_types: - description: All Operation.Type this implementation supports. Any type that is returned during parsing that is not listed here will cause client validation to error. + description: All Operation.Type this implementation supports. This is crucial for Cardano, which has many distinct operation types beyond simple transfers. type: array items: type: string - example: TRANSFER + example: # Add all relevant Cardano operation types + - 'input' + - 'output' + - 'stake_registration' + - 'stake_deregistration' + - 'stake_delegation' + - 'pool_registration' + - 'pool_retirement' + - 'withdrawal' + - 'asset_mint' + - 'asset_burn' + - 'script_input' + - 'script_output' + - 'collateral_input' + - 'collateral_output' + - 'reference_input' + - 'vote_registration' # Conway era onwards + - 'vote_delegation' # Conway era onwards + - 'stake_vote_delegation' # Conway era onwards + - 'committee_hot_auth' # Conway era onwards + - 'committee_cold_resign' # Conway era onwards + - 'drep_registration' # Conway era onwards + - 'drep_deregistration' # Conway era onwards + - 'drep_update' # Conway era onwards + - 'governance_action' # Conway era onwards errors: - description: All Errors that this implementation could return. Any error that is returned during parsing that is not listed here will cause client validation to error. + description: All Errors that this implementation could return. Include Cardano-specific transaction submission errors and node query errors. type: array items: $ref: '#/components/schemas/Error' + example: # Add relevant Cardano error examples + - code: 1 # Generic Internal Server Error + message: 'Internal Server Error' + retriable: false + - code: 100 # Example: Input UTXO not found + message: 'Input UTXO Not Found' + retriable: false + description: 'One of the transaction inputs does not exist or is already spent.' + - code: 101 # Example: Fee Too Small + message: 'Fee Too Small' + retriable: false + description: 'The provided fee does not meet the minimum requirement based on transaction size and protocol parameters.' + - code: 102 # Example: TTL Exceeded + message: 'TTL Exceeded' + retriable: false + description: "The transaction's time-to-live (TTL) slot is in the past relative to the current node tip." + - code: 103 # Example: Value Not Conserved + message: 'Value Not Conserved' + retriable: false + description: 'The sum of transaction inputs (plus minting) does not equal the sum of outputs (plus burning and fee).' + - code: 104 # Example: Script Validation Failed + message: 'Script Validation Failed' + retriable: false + description: 'A Plutus script associated with the transaction failed validation.' + - code: 105 # Example: Pool Registration Error + message: 'Pool Registration Error' + retriable: false + description: 'Error related to stake pool registration parameters or deposits.' + - code: 106 # Example: Bad Inputs + message: 'Bad Inputs' + retriable: false + description: 'General error indicating invalid transaction inputs or structure (e.g., duplicate inputs).' + - code: 500 # Example: Rosetta Specification Error + message: 'Rosetta Specification Error' + retriable: false + description: 'The request or response violates the Rosetta specification based on Network Options.' + - code: 600 # Example: Node Query Error + message: 'Node Query Error' + retriable: true + description: 'Failed to query the underlying Cardano node.' historical_balance_lookup: type: boolean description: Any Rosetta implementation that supports querying the balance of an account at any height in the past should set this to true. @@ -1002,30 +1057,30 @@ components: - greater_or_equal - less_or_equal - dynamic - BlockEvent: - description: BlockEvent represents the addition or removal of a BlockIdentifier from storage. Streaming BlockEvents allows lightweight clients to update their own state without needing to implement their own syncing logic. - type: object - required: - - sequence - - block_identifier - - type - properties: - sequence: - description: sequence is the unique identifier of a BlockEvent within the context of a NetworkIdentifier. - type: integer - format: int64 - minimum: 0 - example: 5 - block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - type: - $ref: '#/components/schemas/BlockEventType' - BlockEventType: - description: BlockEventType determines if a BlockEvent represents the addition or removal of a block. - type: string - enum: - - block_added - - block_removed + # BlockEvent: + # description: BlockEvent represents the addition or removal of a BlockIdentifier from storage. Streaming BlockEvents allows lightweight clients to update their own state without needing to implement their own syncing logic. + # type: object + # required: + # - sequence + # - block_identifier + # - type + # properties: + # sequence: + # description: sequence is the unique identifier of a BlockEvent within the context of a NetworkIdentifier. + # type: integer + # format: int64 + # minimum: 0 + # example: 5 + # block_identifier: + # $ref: '#/components/schemas/BlockIdentifier' + # type: + # $ref: '#/components/schemas/BlockEventType' + # BlockEventType: + # description: BlockEventType determines if a BlockEvent represents the addition or removal of a block. + # type: string + # enum: + # - block_added + # - block_removed Operator: description: Operator is used by query-related endpoints to determine how to apply conditions. If this field is not populated, the default `and` value will be used. type: string @@ -1166,7 +1221,7 @@ components: block: $ref: '#/components/schemas/Block' other_transactions: - description: 'Some blockchains may require additional transactions to be fetched that weren''t returned in the block response (ex: block only returns transaction hashes). For blockchains with a lot of transactions in each block, this can be very useful as consumers can concurrently fetch all transactions returned.' + description: "Some blockchains may require additional transactions to be fetched that weren't returned in the block response (ex: block only returns transaction hashes). For blockchains with a lot of transactions in each block, this can be very useful as consumers can concurrently fetch all transactions returned." type: array items: $ref: '#/components/schemas/TransactionIdentifier' @@ -1192,40 +1247,40 @@ components: properties: transaction: $ref: '#/components/schemas/Transaction' - MempoolResponse: - description: A MempoolResponse contains all transaction identifiers in the mempool for a particular network_identifier. - type: object - required: - - transaction_identifiers - properties: - transaction_identifiers: - type: array - items: - $ref: '#/components/schemas/TransactionIdentifier' - MempoolTransactionRequest: - description: A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool. - type: object - required: - - network_identifier - - transaction_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - transaction_identifier: - $ref: '#/components/schemas/TransactionIdentifier' - MempoolTransactionResponse: - description: 'A MempoolTransactionResponse contains an estimate of a mempool transaction. It may not be possible to know the full impact of a transaction in the mempool (ex: fee paid).' - type: object - required: - - transaction - properties: - transaction: - $ref: '#/components/schemas/Transaction' - metadata: - type: object - example: - descendant_fees: 123923 - ancestor_count: 2 + # MempoolResponse: + # description: A MempoolResponse contains all transaction identifiers in the mempool for a particular network_identifier. + # type: object + # required: + # - transaction_identifiers + # properties: + # transaction_identifiers: + # type: array + # items: + # $ref: '#/components/schemas/TransactionIdentifier' + # MempoolTransactionRequest: + # description: A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool. + # type: object + # required: + # - network_identifier + # - transaction_identifier + # properties: + # network_identifier: + # $ref: '#/components/schemas/NetworkIdentifier' + # transaction_identifier: + # $ref: '#/components/schemas/TransactionIdentifier' + # MempoolTransactionResponse: + # description: 'A MempoolTransactionResponse contains an estimate of a mempool transaction. It may not be possible to know the full impact of a transaction in the mempool (ex: fee paid).' + # type: object + # required: + # - transaction + # properties: + # transaction: + # $ref: '#/components/schemas/Transaction' + # metadata: + # type: object + # example: + # descendant_fees: 123923 + # ancestor_count: 2 MetadataRequest: description: A MetadataRequest is utilized in any request where the only argument is optional metadata. type: object @@ -1266,14 +1321,15 @@ components: $ref: '#/components/schemas/Timestamp' genesis_block_identifier: $ref: '#/components/schemas/BlockIdentifier' - oldest_block_identifier: - $ref: '#/components/schemas/BlockIdentifier' + #oldest_block_identifier: # TODO: Add oldest_block_identifier property to SyncStatus + # description: Not implemented. + # $ref: '#/components/schemas/BlockIdentifier' sync_status: $ref: '#/components/schemas/SyncStatus' - peers: - type: array - items: - $ref: '#/components/schemas/Peer' + #peers: # TODO: Fix empty peers property in NetworkStatusResponse + # type: array + # items: + # $ref: '#/components/schemas/Peer' NetworkOptionsResponse: description: NetworkOptionsResponse contains information about the versioning of the node and the allowed operation statuses, operation types, and errors. type: object @@ -1417,6 +1473,7 @@ components: properties: signed_transaction: type: string + description: Hex-encoded CBOR bytes of the fully signed Cardano transaction, including the transaction body and the transaction witness set. This is ready for submission to the network. ConstructionParseRequest: description: ConstructionParseRequest is the input to the `/construction/parse` endpoint. It allows the caller to parse either an unsigned or signed transaction. type: object @@ -1432,7 +1489,7 @@ components: description: Signed is a boolean indicating whether the transaction is signed. transaction: type: string - description: This must be either the unsigned transaction blob returned by `/construction/payloads` or the signed transaction blob returned by `/construction/combine`. + description: This must be either the hex-encoded unsigned transaction blob (CBOR transaction body) returned by `/construction/payloads` or the hex-encoded signed transaction blob (CBOR full transaction) returned by `/construction/combine`. ConstructionParseResponse: description: ConstructionParseResponse contains an array of operations that occur in a transaction blob. This should match the array of operations provided to `/construction/preprocess` and `/construction/payloads`. type: object @@ -1454,6 +1511,9 @@ components: $ref: '#/components/schemas/AccountIdentifier' metadata: type: object + signed_transaction: + type: string + description: Hex-encoded CBOR bytes of the fully signed Cardano transaction. ConstructionHashRequest: description: ConstructionHashRequest is the input to the `/construction/hash` endpoint. type: object @@ -1476,6 +1536,7 @@ components: $ref: '#/components/schemas/NetworkIdentifier' signed_transaction: type: string + description: Hex-encoded CBOR bytes of the fully signed Cardano transaction, ready for submission. TransactionIdentifierResponse: description: TransactionIdentifierResponse contains the transaction_identifier of a transaction that was submitted to either `/construction/hash` or `/construction/submit`. type: object @@ -1486,79 +1547,79 @@ components: $ref: '#/components/schemas/TransactionIdentifier' metadata: type: object - CallRequest: - description: CallRequest is the input to the `/call` endpoint. - type: object - required: - - network_identifier - - method - - parameters - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - method: - type: string - description: Method is some network-specific procedure call. This method could map to a network-specific RPC endpoint, a method in an SDK generated from a smart contract, or some hybrid of the two. The implementation must define all available methods in the Allow object. However, it is up to the caller to determine which parameters to provide when invoking `/call`. - example: eth_call - parameters: - type: object - description: Parameters is some network-specific argument for a method. It is up to the caller to determine which parameters to provide when invoking `/call`. - example: - block_number: 23 - address: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' - CallResponse: - description: CallResponse contains the result of a `/call` invocation. - type: object - required: - - result - - idempotent - properties: - result: - type: object - description: Result contains the result of the `/call` invocation. This result will not be inspected or interpreted by Rosetta tooling and is left to the caller to decode. - example: - count: 1000 - idempotent: - type: boolean - description: Idempotent indicates that if `/call` is invoked with the same CallRequest again, at any point in time, it will return the same CallResponse. Integrators may cache the CallResponse if this is set to true to avoid making unnecessary calls to the Rosetta implementation. For this reason, implementers should be very conservative about returning true here or they could cause issues for the caller. - EventsBlocksRequest: - description: EventsBlocksRequest is utilized to fetch a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. - type: object - required: - - network_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - offset: - description: offset is the offset into the event stream to sync events from. If this field is not populated, we return the limit events backwards from tip. If this is set to 0, we start from the beginning. - type: integer - format: int64 - minimum: 0 - example: 5 - limit: - description: limit is the maximum number of events to fetch in one call. The implementation may return <= limit events. - type: integer - format: int64 - minimum: 0 - example: 5 - EventsBlocksResponse: - description: EventsBlocksResponse contains an ordered collection of BlockEvents and the max retrievable sequence. - type: object - required: - - max_sequence - - events - properties: - max_sequence: - description: max_sequence is the maximum available sequence number to fetch. - type: integer - format: int64 - minimum: 0 - example: 5 - events: - type: array - description: events is an array of BlockEvents indicating the order to add and remove blocks to maintain a canonical view of blockchain state. Lightweight clients can use this event stream to update state without implementing their own block syncing logic. - items: - $ref: '#/components/schemas/BlockEvent' + # CallRequest: + # description: CallRequest is the input to the `/call` endpoint. + # type: object + # required: + # - network_identifier + # - method + # - parameters + # properties: + # network_identifier: + # $ref: '#/components/schemas/NetworkIdentifier' + # method: + # type: string + # description: Method is some network-specific procedure call. This method could map to a network-specific RPC endpoint, a method in an SDK generated from a smart contract, or some hybrid of the two. The implementation must define all available methods in the Allow object. However, it is up to the caller to determine which parameters to provide when invoking `/call`. + # example: eth_call + # parameters: + # type: object + # description: Parameters is some network-specific argument for a method. It is up to the caller to determine which parameters to provide when invoking `/call`. + # example: + # block_number: 23 + # address: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' + # CallResponse: + # description: CallResponse contains the result of a `/call` invocation. + # type: object + # required: + # - result + # - idempotent + # properties: + # result: + # type: object + # description: Result contains the result of the `/call` invocation. This result will not be inspected or interpreted by Rosetta tooling and is left to the caller to decode. + # example: + # count: 1000 + # idempotent: + # type: boolean + # description: Idempotent indicates that if `/call` is invoked with the same CallRequest again, at any point in time, it will return the same CallResponse. Integrators may cache the CallResponse if this is set to true to avoid making unnecessary calls to the Rosetta implementation. For this reason, implementers should be very conservative about returning true here or they could cause issues for the caller. + # EventsBlocksRequest: + # description: EventsBlocksRequest is utilized to fetch a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. + # type: object + # required: + # - network_identifier + # properties: + # network_identifier: + # $ref: '#/components/schemas/NetworkIdentifier' + # offset: + # description: offset is the offset into the event stream to sync events from. If this field is not populated, we return the limit events backwards from tip. If this is set to 0, we start from the beginning. + # type: integer + # format: int64 + # minimum: 0 + # example: 5 + # limit: + # description: limit is the maximum number of events to fetch in one call. The implementation may return <= limit events. + # type: integer + # format: int64 + # minimum: 0 + # example: 5 + # EventsBlocksResponse: + # description: EventsBlocksResponse contains an ordered collection of BlockEvents and the max retrievable sequence. + # type: object + # required: + # - max_sequence + # - events + # properties: + # max_sequence: + # description: max_sequence is the maximum available sequence number to fetch. + # type: integer + # format: int64 + # minimum: 0 + # example: 5 + # events: + # type: array + # description: events is an array of BlockEvents indicating the order to add and remove blocks to maintain a canonical view of blockchain state. Lightweight clients can use this event stream to update state without implementing their own block syncing logic. + # items: + # $ref: '#/components/schemas/BlockEvent' SearchTransactionsRequest: description: SearchTransactionsRequest is used to search for transactions matching a set of provided conditions in canonical blocks. type: object @@ -1668,7 +1729,7 @@ components: address: '0x1dcc4de8dec75d7aab85b567b6' error: not base64 BlockMetadata: - description: BlockMetadata is used to provide any additional data needed for a Block. It is important to populate this object with any data a consumer will need to fully understand a Block. + description: BlockMetadata contains Cardano-specific block information, such as epoch, slot, transaction count, size, and block creator (slot leader), beyond the standard Rosetta Block fields. type: object properties: transactionsCount: @@ -1689,7 +1750,7 @@ components: type: integer format: int64 TransactionMetadata: - description: Transactions that are related to other transactions (like a cross-shard transaction) should include the tranaction_identifier of these transactions in the metadata. + description: Contains Cardano-specific transaction details beyond the core operations, such as fees, TTL, certificates, withdrawals, minting information, collateral, script data hash, and required signers. type: object properties: size: @@ -1697,14 +1758,55 @@ components: type: integer format: int64 scriptSize: - description: ScriptSize is the size of the transaction script in bytes. + description: ScriptSize is the size of the transaction script section in bytes. type: integer format: int64 + fee: + description: Transaction fee in Lovelace. + $ref: '#/components/schemas/Amount' + ttl: + description: Time-To-Live. The absolute slot number after which the transaction is no longer valid. + type: integer + format: int64 + validity_interval_start: + description: Optional absolute slot number indicating the start of the transaction's validity interval. + type: integer + format: int64 + certificates: + description: List of certificates included in the transaction (e.g., stake registration, delegation, pool registration). + type: array + items: + type: object # Define specific certificate schemas or use a generic object + description: Represents a Cardano certificate (structure varies by type). + withdrawals: + description: Map of stake addresses (`stake...`) to the amount of ADA withdrawn. + type: object + additionalProperties: + $ref: '#/components/schemas/Amount' + mint: + description: Net mint/burn amount for native assets in this transaction. Positive values for minting, negative for burning. + type: array + items: + $ref: '#/components/schemas/Amount' + collateral: + description: List of UTXO inputs provided as collateral for Plutus script execution. + type: array + items: + $ref: '#/components/schemas/CoinIdentifier' + script_data_hash: + description: Optional hash of the datums provided in the transaction witness set. + type: string + required_signers: + description: Optional list of key hashes required as signers by Plutus scripts. + type: array + items: + type: string example: size: 12378 - lockTime: 1582272577 + fee: { value: '170000', currency: { symbol: 'ADA', decimals: 6 } } + ttl: 8675309 OperationMetadata: - description: OperationMetadata is used to provide any additional data needed for an Operation. It is important to populate this object with any data a consumer will need to fully understand an Operation. + description: OperationMetadata provides Cardano-specific context for an Operation, such as withdrawal/deposit amounts, staking credentials, pool details, DRep information, voting metadata, or the native assets involved (via tokenBundle if the operation affects a UTXO). type: object properties: withdrawalAmount: @@ -1725,10 +1827,10 @@ components: description: DRep $ref: '#/components/schemas/DRepParams' epoch: - description: Epoch + description: Epoch associated with the operation, if relevant (e.g., for rewards). type: integer tokenBundle: - description: TokenBundle + description: Represents native assets associated with a UTXO output operation. Each item contains a policy ID and the amounts of tokens under that policy. type: array items: $ref: '#/components/schemas/TokenBundleItem' @@ -1770,24 +1872,26 @@ components: type: array items: $ref: '#/components/schemas/Amount' - DRepTypeParams: + DRepTypeParams: # required if id has 29 bytes, otherwise not required description: DRepTypeParams type: string + required: + - id enum: - key_hash - script_hash - no_confidence - abstain DRepParams: - description: DRep - type: object - properties: - id: - description: DRepId - type: string - type: - description: DRepType - $ref: '#/components/schemas/DRepTypeParams' + description: DRep + type: object + properties: + id: + description: DRepId + type: string + type: + description: DRepType + $ref: '#/components/schemas/DRepTypeParams' PoolRegistrationParams: description: PoolRegistrationParams type: object @@ -1951,11 +2055,14 @@ components: description: 'ChainCode ' type: string CurrencyMetadata: - description: '' + description: Contains metadata specific to a Cardano currency, particularly for native assets. type: object properties: policyId: - description: '' + description: The hex-encoded policy ID of the native asset. + type: string + assetName: + description: Optional human-readable asset name (UTF-8 encoded, then hex-encoded if needed). type: string ConstructionMetadataRequestOption: description: '' @@ -1977,24 +2084,17 @@ components: protocol_parameters: $ref: '#/components/schemas/ProtocolParameters' CoinMetadata: - description: CoinMetadata is used to provide additional data for a Coin object. It is often used to store human-readable information that a client can use to display information to a user. + description: Contains the native assets held by this UTXO (Coin). The ADA amount is represented in the main Coin.Amount field. type: object - additionalProperties: - type: array - items: - $ref: '#/components/schemas/CoinTokens' - CoinTokens: - description: | - CoinTokens contains the policyId and the tokens - it represents. - type: object - required: - - policyId - - tokens properties: - policyId: - type: string - tokens: + assets: type: array + description: List of Amounts representing native assets (excluding ADA) held by the coin. items: $ref: '#/components/schemas/Amount' + CoinTokens: + # This schema is no longer used by CoinMetadata and can potentially be removed if not used elsewhere. + description: | + DEPRECATED by simplified CoinMetadata.assets. CoinTokens contains the policyId and the tokens + it represents. + type: object diff --git a/docs/docs/development/performance-measurements.md b/docs/docs/development/performance-measurements.md index a9cf769266..e93df044c3 100644 --- a/docs/docs/development/performance-measurements.md +++ b/docs/docs/development/performance-measurements.md @@ -10,7 +10,7 @@ This page documents the performance measurements and load test results for diffe ## Load Test Results -Below you can find the load test results for various releases, comparing different deployment options. +Below you can find the load test results for various releases, comparing different deployment options. All performance tests are evaluated against a Service Level Agreement (SLA) target of 1 second response time, which we consider the acceptable threshold for API responsiveness in production environments.
diff --git a/docs/docs/development/qa-regression.md b/docs/docs/development/qa-regression.md index a97e750ebd..1644c3a352 100644 --- a/docs/docs/development/qa-regression.md +++ b/docs/docs/development/qa-regression.md @@ -8,7 +8,7 @@ description: Testing methodology and procedures for releases The following steps are performed as part of the QA process for new releases: -1. **E2E Testing**: Run the complete end-to-end test flow on preprod network using the [`e2e-tests`](https://github.com/cardano-foundation/cardano-rosetta-java/tree/main/e2e-tests) suite +1. **E2E Testing**: Run the complete end-to-end test flow on preprod network using the [`e2e_tests`](https://github.com/cardano-foundation/cardano-rosetta-java/tree/main/e2e_tests) suite - Test on both single docker and docker-compose deployments - Verify all construction API flows work correctly diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index e8c5e113ce..f087103112 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -47,6 +47,8 @@ const config = { // Remove this to remove the "edit this page" links. editUrl: 'https://github.com/cardano-foundation/cardano-rosetta-java/tree/main/docs/', + showLastUpdateAuthor: true, + showLastUpdateTime: true, exclude: [ '**/test-results/**', // Exclude all test-results directories '**/_test-results/**', // Exclude directories with underscore prefix @@ -144,6 +146,7 @@ const config = { { label: 'API Reference', route: '/cardano-rosetta-java/api', + configuration: { url: '/cardano-rosetta-java/api.yaml', hideDownloadButton: true, @@ -151,12 +154,20 @@ const config = { forceDarkModeState: 'light', withDefaultFonts: false, hideClientButton: true, + searchHotKey: 'l', + proxyUrl: 'https://proxy.scalar.com', servers: [ { url: 'http://localhost:8082', name: 'Local', }, ], + customCss: `* { + --scalar-background-1: transparent; + --scalar-font: 'Helvetica Neue', Helvetica, Arial, sans-serif; + }` + + }, }, ], diff --git a/docs/package.json b/docs/package.json index ad7552902f..a5fdb1989f 100644 --- a/docs/package.json +++ b/docs/package.json @@ -19,7 +19,7 @@ "@docusaurus/preset-classic": "3.7.0", "@docusaurus/theme-mermaid": "^3.7.0", "@mdx-js/react": "^3.0.0", - "@scalar/docusaurus": "^0.5.5", + "@scalar/docusaurus": "^0.6.3", "clsx": "^2.0.0", "prism-react-renderer": "^2.3.0", "react": "^19.0.0", diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index d8c8d161b3..038a1f897d 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -11,6 +11,12 @@ --grey-50: #F2F2F2; --t-grey-150: rgba(39, 39, 39, 0.15); + /* New layout variables (2025-04-30) */ + --content-max-width: 100%; + --ifm-font-size-base: 15px; + --ifm-line-height-base: 1.6; + --ifm-heading-margin-bottom: 0.75rem; + /* Red Colors */ --red-1000: #D64A2E; --red-50: #FEF3F1; @@ -73,7 +79,7 @@ --ifm-color-primary-lighter: #26e6ff; --ifm-color-primary-lightest: #4deb7c; - /* Dark background & text */ + /* Dark background & text - simplified bg with slight blue tint */ --ifm-background-color: #151a23; --ifm-font-color-base: var(--grey-50); --docusaurus-highlighted-code-line-bg: rgba(0, 132, 255, 0.15); @@ -84,9 +90,79 @@ --prism-color: #e6e6e6; } +/* Apply a consistent background to the body and html in dark mode */ +[data-theme='dark'] body, +[data-theme='dark'] html { + background-color: #151a23; + +} + +/* Main content background with subtle blue gradient in dark mode */ +[data-theme='dark'] #__docusaurus { + background: linear-gradient(160deg, #151a23 0%, #131926 50%, #151e2e 100%); + min-height: 100%; +} + +/* Simplify the hero in dark mode */ +[data-theme='dark'] .hero { + background-color: #171e29; +} + + +/* Remove complex background from columns */ +[data-theme='dark'] .col:before { + display: none; + +} + +/* Remove complex background from features */ +[data-theme='dark'] .features:before { + display: none; + +} + +/* Simplify footer in dark mode */ +[data-theme='dark'] .footer { + background: #131926; + border-top: 1px solid rgba(0, 132, 255, 0.1); +} + +[data-theme='dark'] .footer:before { + display: none; +} + + + /******************************************************* * Base Typography & Layout * *******************************************************/ + +/* === Layout width constraint for large screens (2025-04-30) === */ +@media (min-width: 1280px) { + + /* Constrain the navbar content */ + .navbar__inner { + max-width: var(--content-max-width); + margin: 0 8%; + } + + /* Constrain the main wrapper for the whole page content below navbar */ + .main-wrapper { + max-width: var(--content-max-width); + margin: 0 8%; + display: flex; + } + + /* Keep sidebar width fixed */ + .theme-doc-sidebar-container { + width: 300px; + min-width: 300px; + flex-shrink: 0; /* Prevent sidebar from shrinking */ + position: sticky; /* should now be relative to the centered main-wrapper */ + } + +} + h1, h2, h3, h4, h5, h6 { font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif; font-weight: 700; @@ -94,9 +170,12 @@ h1, h2, h3, h4, h5, h6 { body { font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif; font-weight: 400; + font-size: 15px; + line-height: 1.6; } .margin-left--md { margin-left: 1rem; + } /******************************************************* @@ -131,13 +210,21 @@ body { background: linear-gradient(to right, var(--red-3), var(--red-1)); } -/* Gradient circle shapes */ +/* Gradient circle shapes - simplified for better performance */ .gradient-shape { position: relative; - filter: blur(150px); + filter: blur(100px); border-radius: 50%; z-index: -1; + opacity: 0.7; } + +/* Simplified gradient shapes for dark mode with lower opacity */ +[data-theme='dark'] .gradient-shape { + opacity: 0.4; + filter: blur(120px); +} + .gradient-shape-blue-1-2 { background: linear-gradient(135deg, var(--blue-1), var(--blue-2)); } @@ -210,60 +297,122 @@ body { /******************************************************* * Hero Section * *******************************************************/ -.hero--primary { - background: linear-gradient(135deg, #0033AD 0%, #1259e3 100%); - padding: 6rem 0; +/* New minimal hero styles */ +.hero { + padding: 5rem 0 4rem; /* Adjust padding */ display: flex; align-items: center; justify-content: center; + text-align: center; /* Ensure text is centered */ + background-color: var(--grey-50); /* Very light grey for light mode */ + position: relative; + overflow: hidden; + border-radius: 0 0 30px 30px; + box-shadow: 0 5px 15px rgba(0, 0, 0, 0.05); + margin: 0 auto 3rem; } -[data-theme='dark'] .hero--primary { - color: white; - background: linear-gradient(135deg, #001e63 0%, #0a3180 100%); + +/* Add responsive width constraints for larger screens */ +@media (min-width: 1280px) { + .hero { + width: 85%; + max-width: 1400px; + margin-bottom: 4rem; + } + + /* Add subtle gradient backgrounds */ + .hero::before { + content: ''; + position: absolute; + top: 0; + left: 0; + right: 0; + height: 100%; + background: linear-gradient(180deg, rgba(0, 132, 255, 0.05) 0%, rgba(0, 132, 255, 0) 100%); + z-index: -1; + } +} + +[data-theme='dark'] .hero { + background-color: #171e29; /* Slightly off-black for dark mode */ + color: var(--grey-50); /* Ensure text is light */ + box-shadow: 0 5px 20px rgba(0, 0, 0, 0.2); + border-bottom: 1px solid rgba(0, 132, 255, 0.1); +} + +/* Add subtle accent shape to hero */ +.hero::after { + content: ''; + position: absolute; + bottom: -2px; + left: 50%; + width: 100px; + height: 4px; + transform: translateX(-50%); + background: linear-gradient(90deg, transparent, var(--blue-1000), transparent); + border-radius: 4px; +} + +[data-theme='dark'] .hero::after { + background: linear-gradient(90deg, transparent, var(--blue-1), transparent); + box-shadow: 0 0 10px rgba(0, 224, 255, 0.5); } + .hero__title { - font-size: 3.5rem; - margin-bottom: 1.5rem; - font-weight: 700; + font-size: 3rem; /* Slightly smaller */ + margin-bottom: 1rem; /* Reduced margin */ + font-weight: 600; /* Slightly lighter weight */ + color: var(--grey-1000); /* Ensure dark text in light mode */ } + .hero__subtitle { - font-size: 1.5rem; - margin-bottom: 2.5rem; - opacity: 0.9; + font-size: 1.25rem; /* Slightly smaller */ + margin-bottom: 2rem; /* Adjusted margin */ + opacity: 0.8; max-width: 600px; margin-left: auto; margin-right: auto; + color: var(--grey-800); /* Ensure slightly lighter text in light mode */ } + [data-theme='dark'] .hero__title { - color: white; + color: white; /* Explicitly white for dark mode */ } + [data-theme='dark'] .hero__subtitle { - color: rgba(255, 255, 255, 0.9); + color: var(--grey-200); /* Lighter grey for dark mode */ + opacity: 0.9; +} + +/* Button Adjustments within Hero */ +.hero .buttons { + margin-top: 2rem; /* Add some space above buttons */ } -/* Secondary & Outline Buttons */ -.button--secondary { - background-color: white; - color: #0033AD; +.hero .button--secondary { + /* Keep secondary button distinct */ + background-color: var(--ifm-color-primary); + color: white; border: none; - font-weight: 600; - transition: all 0.3s ease; + font-weight: 500; /* Slightly less bold */ + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1); } -.button--secondary:hover { - background-color: #f0f0f0; + +.hero .button--secondary:hover { + background-color: var(--ifm-color-primary-dark); transform: translateY(-2px); - box-shadow: 0 5px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0 5px 15px rgba(0, 0, 0, 0.15); } -.button--outline { - border: 1px solid white; - color: white; - font-weight: 600; - transition: all 0.3s ease; + +[data-theme='dark'] .hero .button--secondary { + background-color: var(--ifm-color-primary); + color: #151a23; /* Dark text on light blue button */ + box-shadow: 0 2px 8px rgba(0, 224, 255, 0.15); } -.button--outline:hover { - background-color: rgba(255, 255, 255, 0.1); - transform: translateY(-2px); - box-shadow: 0 5px 15px rgba(0, 0, 0, 0.1); + +[data-theme='dark'] .hero .button--secondary:hover { + background-color: var(--ifm-color-primary-light); + box-shadow: 0 5px 15px rgba(0, 224, 255, 0.25); } /******************************************************* @@ -279,10 +428,10 @@ body { display: flex; background-repeat: no-repeat; background-position: center; - background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E"); + background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z'%3E%3C/path%3E%3C/svg%3E"); } [data-theme='dark'] .header-github-link::before { - background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12z'%3E%3C/path%3E%3C/svg%3E"); + background-image: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z'%3E%3C/path%3E%3C/svg%3E"); } /******************************************************* @@ -295,9 +444,8 @@ body { background: linear-gradient(180deg, rgba(0, 132, 255, 0.05) 0%, rgba(0, 132, 255, 0) 100%); } [data-theme='dark'] .footer { - background: linear-gradient(180deg, #0f1620 0%, #0a0f16 100%); - position: relative; - z-index: 1; + background: #131926; + border-top: 1px solid rgba(0, 132, 255, 0.1); } [data-theme='dark'] .footer:before { content: ''; @@ -315,6 +463,7 @@ body { align-items: center; width: 100%; padding: 2rem 0 1.5rem; + } .footer-row { display: flex; @@ -400,6 +549,7 @@ body { /* Footer text */ .footer__links { margin-bottom: 0; + } .footer-title, .footer__title { @@ -456,7 +606,7 @@ body { background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%230084FF' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M14 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V8z'%3E%3C/path%3E%3Cpolyline points='14 2 14 8 20 8'%3E%3C/polyline%3E%3Cline x1='16' y1='13' x2='8' y2='13'%3E%3C/line%3E%3Cline x1='16' y1='17' x2='8' y2='17'%3E%3C/line%3E%3Cpolyline points='10 9 9 9 8 9'%3E%3C/polyline%3E%3C/svg%3E"); } [data-theme='light'] .footer-icon-api { - background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%230084FF' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpolyline points='16 18 22 12 16 6'%3E%3C/polyline%3E%3Cpolyline points='8 6 2 12 8 18'%3E%3C/polyline%3E%3C/svg%3E"); + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='%230084FF'%3E%3Cpath d='M17.36,20.2V14.82h1.79V22H3V14.82H4.8V20.2H17.36M6.77,14.32l0.37-1.76,8.79,1.85-0.37,1.76L6.77,14.32m1.16-4.21L8.69,8.5l8.14,3.78-0.76,1.62L7.93,10.11m2.26-3.99l1.15-1.38L17.5,10.11l-1.15,1.38L10.19,6.12m4.55-3.47L15.48,4l-4.95,6.69-1.73-1.34,4.95-6.69M7.37,19.4v-1.77h8.94v1.77H7.37Z'%3E%3C/path%3E%3C/svg%3E"); } [data-theme='light'] .footer-icon-stackoverflow { background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='%230084FF'%3E%3Cpath d='M17.36,20.2V14.82h1.79V22H3V14.82H4.8V20.2H17.36M6.77,14.32l0.37-1.76,8.79,1.85-0.37,1.76L6.77,14.32m1.16-4.21L8.69,8.5l8.14,3.78-0.76,1.62L7.93,10.11m2.26-3.99l1.15-1.38L17.5,10.11l-1.15,1.38L10.19,6.12m4.55-3.47L15.48,4l-4.95,6.69-1.73-1.34,4.95-6.69M7.37,19.4v-1.77h8.94v1.77H7.37Z'%3E%3C/path%3E%3C/svg%3E"); @@ -538,7 +688,7 @@ body { z-index: -1; } [data-theme='dark'] main { - background: linear-gradient(180deg, #151a23 0%, #0f1620 100%); + background: none; } [data-theme='dark'] .features { position: relative; @@ -558,8 +708,9 @@ body { * Navbar (Dark Mode) * *******************************************************/ [data-theme='dark'] .navbar { - background: linear-gradient(180deg, #0c111a 0%, #151a23 100%); - box-shadow: 0 1px 2px rgba(0, 0, 0, 0.3), 0 0 30px rgba(0, 0, 0, 0.2); + background-color: rgba(21, 26, 35, 0.85); + border-bottom-color: rgba(255, 255, 255, 0.1); + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.5); } [data-theme='dark'] .navbar__logo { filter: drop-shadow(0 0 4px rgba(0, 224, 255, 0.3)); @@ -596,12 +747,9 @@ body { /******************************************************* * Docs Sidebar (Dark Mode) * *******************************************************/ -[data-theme='dark'] .theme-doc-sidebar-container { - background: linear-gradient(90deg, #0c111a 0%, #0f1620 100%); - border-right: 1px solid rgba(0, 132, 255, 0.1); -} + [data-theme='dark'] .menu { - background: transparent; + padding: 0.5rem 0; } [data-theme='dark'] .menu__link { color: rgba(255, 255, 255, 0.8); @@ -613,7 +761,8 @@ body { } [data-theme='dark'] .menu__link--active { color: var(--blue-1); - background: rgba(0, 132, 255, 0.1); + background: rgba(0, 224, 255, 0.07); + border-left: 2px solid var(--blue-1); } [data-theme='dark'] .menu__list-item-collapsible:hover { background: rgba(0, 132, 255, 0.05); @@ -626,20 +775,15 @@ body { background: var(--ifm-menu-link-sublist-icon) 50% / 1.25rem 1.25rem; filter: invert(1) brightness(1.8) saturate(1.2); } +/* Remove complex border and shadow effects */ [data-theme='dark'] .menu__list-item-collapsible .menu__link--active { border-left: 2px solid var(--blue-1); - box-shadow: -2px 0 8px rgba(0, 224, 255, 0.1); } [data-theme='dark'] .menu__list .menu__list .menu__link--active { position: relative; } [data-theme='dark'] .menu__list .menu__list .menu__link--active:before { - content: ''; - position: absolute; - left: 0; top: 0; bottom: 0; - width: 2px; - background: var(--blue-1); - box-shadow: 0 0 8px rgba(0, 224, 255, 0.3); + display: none; } /******************************************************* @@ -687,6 +831,27 @@ html[data-theme='dark'] .choice-card .button--secondary { color: var(--ifm-color-emphasis-900); } +.markdown { + padding: 1.68rem; +} + +.theme-edit-this-page { + background-color: var(--ifm-color-emphasis-100); + border-radius: 12px; + padding: 8px 12px; + margin-bottom: 12px; + margin-top: 12px; + border: 1px solid var(--ifm-color-emphasis-200); + box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); + font-size: 14px; + font-weight: 500; + color: var(--ifm-color-emphasis-700); + text-decoration: none; + transition: background-color 0.2s ease, color 0.2s ease, transform 0.2s ease; + cursor: pointer; + user-select: none; +} + /******************************************************* * Tables * *******************************************************/ @@ -796,7 +961,7 @@ article td:nth-child(3) { *******************************************************/ .tabs { border-bottom: 1px solid var(--ifm-color-emphasis-200); - margin-bottom: 16px; + margin-bottom: -16px; display: flex; flex-wrap: wrap; width: 100%; @@ -804,7 +969,7 @@ article td:nth-child(3) { } .tabs__item { - margin-right: 16px; + margin-right: 2px; padding: 6px 12px; border-radius: 4px 4px 0 0; font-weight: 500; @@ -850,7 +1015,10 @@ article td:nth-child(3) { /* Fix for tab containers and scrolling */ div[role="tabpanel"] { width: 100%; - overflow-x: auto; + padding: 1rem; + border: 1px solid var(--ifm-color-emphasis-200); + border-radius: 0px 8px 8px 8px; + box-shadow: inset 0 2px 6px rgba(0, 0, 0, 0.04); } .tabs-container { @@ -922,19 +1090,18 @@ div[class*='codeBlockContainer'] pre, margin: 1.5rem 0; padding: 0.8rem; overflow: auto; - box-shadow: none; + box-shadow: 0; font-size: 0.85rem; line-height: 1.4; transition: all 0.3s ease; } /* Light mode adjustments for code blocks */ -[data-theme='light'] pre, [data-theme='light'] div[class*='codeBlockContainer'] pre, [data-theme='light'] .theme-code-block pre { - background-color: #f2f2f2 !important; /* Darker background */ + background-color: #f2f2f2 !important; border: 1px solid #e0e0e0 !important; - color: #272727 !important; /* Much darker text color */ + color: #272727 !important; } /* Prism Token Coloring - make tokens darker in light mode */ @@ -1071,37 +1238,6 @@ div[class*='codeBlockContainer'] { [data-theme='dark'] div[class*='codeBlockContainer'] pre { border: 1px solid rgba(255, 255, 255, 0.1); } -/* Light mode: remove extra borders around container */ -[data-theme='light'] div[class*='codeBlockContainer'] { - border: none !important; - box-shadow: none !important; - background: transparent !important; -} -[data-theme='light'] div[class*='codeBlockContent'] { - border: none !important; - box-shadow: none !important; - background: transparent !important; - overflow: hidden !important; - border-radius: var(--prism-border-radius) !important; -} -[data-theme='light'] pre, -[data-theme='light'] div[class*='codeBlockContainer'] pre, -[data-theme='light'] .theme-code-block pre { - margin: 0 !important; - border-radius: var(--prism-border-radius) !important; - overflow: auto !important; - padding: 0.8rem !important; - font-size: 0.85rem !important; - line-height: 1.4 !important; -} -[data-theme='light'] div[class*='codeBlock'], -[data-theme='light'] div.prism-code, -[data-theme='light'] pre.prism-code { - border: none !important; - box-shadow: none !important; - background: transparent !important; -} - /******************************************************* * Code Block Title * *******************************************************/ @@ -1206,4 +1342,79 @@ details.alert--info summary h3 { [data-theme='dark'] details.alert--info summary, [data-theme='dark'] details.alert--info summary h3 { color: inherit !important; -} \ No newline at end of file +} + +/******************************************************* + * Unified Sidebar Styling * + *******************************************************/ + +/* Base container for both sidebars */ +.sidebar-pages, +.theme-doc-sidebar-container { + background: rgba(255, 255, 255, 0.97); + padding: 1.4rem 1.4rem 1.4rem 0; +} + +/* Simplified sidebar styling for dark mode */ +[data-theme='dark'] .sidebar-pages, +[data-theme='dark'] .theme-doc-sidebar-container { + background: transparent; + border-right: 1px solid rgba(0, 132, 255, 0.07); +} + +/* All sidebar links - base styling */ +.sidebar-heading-link, +.menu__link { + display: flex; + align-items: center; + padding: 0.5rem 1rem; + font-size: 0.875rem; + line-height: 1.4; + font-weight: 400; + color: var(--grey-800); + transition: background 0.15s, color 0.15s; + border-radius: 0; + margin: 0; +} + +[data-theme='dark'] .sidebar-heading-link, +[data-theme='dark'] .menu__link { + color: var(--grey-200); +} + + +/* Parent categories */ +.sidebar-group-item__folder > .sidebar-heading-link, +.menu__list-item-collapsible > .menu__link { + font-weight: 500; + color: var(--grey-1000); +} + +[data-theme='dark'] .sidebar-group-item__folder > .sidebar-heading-link, +[data-theme='dark'] .menu__list-item-collapsible > .menu__link { + color: white; +} + +/* Method tags (POST, etc) styling */ +.sidebar-heading-type { + font-size: 0.7rem; + padding: 0.15rem 0.4rem; + border-radius: 3px; + margin-left: auto; + letter-spacing: 0.02em; + color: #3b7c36; + background: #e6f4e6; +} + +[data-theme='dark'] .sidebar-heading-type { + color: #4aad42; + background: rgba(74, 173, 66, 0.2); +} + +/* Reduce complexity in menu items */ +[data-theme='dark'] .menu__link--active { + color: var(--blue-1); + background: rgba(0, 224, 255, 0.07); + border-left: 2px solid var(--blue-1); +} + \ No newline at end of file diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js index 58006a1dd9..ebfdcf5f14 100644 --- a/docs/src/pages/index.js +++ b/docs/src/pages/index.js @@ -9,7 +9,7 @@ import styles from './index.module.css'; function HomepageHeader() { const {siteConfig} = useDocusaurusContext(); return ( -
+

{siteConfig.title}

diff --git a/docs/src/pages/index.module.css b/docs/src/pages/index.module.css index 9f71a5da77..578d3bc076 100644 --- a/docs/src/pages/index.module.css +++ b/docs/src/pages/index.module.css @@ -21,3 +21,5 @@ align-items: center; justify-content: center; } + + From 5c8fb34391fb4511c595c5b402bd7782d5d70b08 Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Wed, 7 May 2025 21:50:13 -0300 Subject: [PATCH 02/13] chore: update OpenAPI specification for java implementation - Updated example values for block, account and transaction identifiers to align with current data. - Enhanced operation types and statuses to include Cardano-specific options. - Added valid response examples to improve clarity. - Commented out unimplemented features and provided TODO notes for future implementation. --- .../rosetta-specifications-1.4.15/api.yaml | 699 ++++++++++++++---- 1 file changed, 571 insertions(+), 128 deletions(-) diff --git a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml index e9decffd7e..6a937edda1 100644 --- a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml +++ b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml @@ -2,7 +2,7 @@ openapi: 3.0.2 info: version: 1.4.13 title: Mesh (formerly Rosetta) API for Cardano - description: Build Once. Integrate Your Blockchain Everywhere. + description: A lightweight Java implementation, built on Yaci-store for reduced resource footprint. license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html @@ -557,10 +557,10 @@ components: description: This is also known as the block height. type: integer format: int64 - example: 3430923 + example: 11832620 hash: type: string - example: '7985774c96490dfcde55b80523ac4c2dc27243a479ee8d236800ed4e1773fd8b' + example: '4797bd63a225277231bd02f87be986c33a1ff61eb12681fb5eaa5620f638fa05' description: This should be normalized according to the case specified in the block_hash_case network options. PartialBlockIdentifier: type: object @@ -582,7 +582,7 @@ components: hash: description: 'Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier. This should be normalized according to the case specified in the transaction_hash_case in network options.' type: string - example: '0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f' + example: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73' OperationIdentifier: description: The operation_identifier uniquely identifies an operation within a transaction. type: object @@ -610,23 +610,25 @@ components: address: description: The address may be a cryptographic public key (or some encoding of it) or a provided username. type: string - example: '0x3a065000ab4183c6bf581dc1e55a605455fc6d61' - sub_account: - $ref: '#/components/schemas/SubAccountIdentifier' - metadata: - $ref: '#/components/schemas/AccountIdentifierMetadata' - SubAccountIdentifier: - description: An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to. - type: object - required: - - address - properties: - address: - description: 'The SubAccount address may be a cryptographic value or some other identifier (ex: bonded) that uniquely specifies a SubAccount.' - type: string - example: '0x6b175474e89094c44da98b954eedeac495271d0f' + example: 'addr1qxx6qfrre0mynlmcst5wj3h0flk093zjx9wl86k6gnksztp693mm58mml2ckdm09rgycahv5ex68c36a7kp4r2sgcx7q3rqcx8' + # Not implemented for Cardano + #sub_account: + # $ref: '#/components/schemas/SubAccountIdentifier' metadata: $ref: '#/components/schemas/AccountIdentifierMetadata' + # Not implemented for Cardano + # SubAccountIdentifier: + # description: An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to. + # type: object + # required: + # - address + # properties: + # address: + # description: 'The SubAccount address may be a cryptographic value or some other identifier (ex: bonded) that uniquely specifies a SubAccount.' + # type: string + # example: '0x6b175474e89094c44da98b954eedeac495271d0f' + # metadata: + # $ref: '#/components/schemas/AccountIdentifierMetadata' Block: description: 'Blocks contain an array of Transactions that occurred at a particular BlockIdentifier. A hard requirement for blocks returned by Rosetta implementations is that they MUST be _inalterable_: once a client has requested and received a block identified by a specific BlockIndentifier, all future calls for that same BlockIdentifier must return the same block contents.' type: object @@ -648,6 +650,84 @@ components: $ref: '#/components/schemas/Transaction' metadata: $ref: '#/components/schemas/BlockMetadata' + example: + block_identifier: + index: 11832620 + hash: '4797bd63a225277231bd02f87be986c33a1ff61eb12681fb5eaa5620f638fa05' + parent_block_identifier: + index: 11832619 + hash: 'b5781a495eb21b613136fe09a19321c9a9f7fa8978e8d26105e3306287061625' + timestamp: 1746607844000 + transactions: + - transaction_identifier: + hash: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73' + operations: + - operation_identifier: + index: 0 + type: 'input' + status: 'success' + account: + address: 'addr1q8n85ymr09p8czlya59z5k6vyrfuhmg0zf3vfll46jqn25pgjy6j9tzkpzlupfjgmssf25nkudk6dk8nraesvygnntjs3m5fnu' + amount: + value: '-3000000' + currency: + symbol: 'ADA' + decimals: 6 + coin_change: + coin_identifier: + identifier: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' + coin_action: 'coin_spent' + metadata: + tokenBundle: + - policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' + tokens: + - value: '-161333000000' + currency: + symbol: '41474958' + decimals: 0 + - operation_identifier: + index: 1 + type: 'input' + status: 'success' + account: + address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' + amount: + value: '-502066491' + currency: + symbol: 'ADA' + decimals: 6 + coin_change: + coin_identifier: + identifier: 'f81b467c4c23af80d498956ea0540427a325cb87e0881b1d8a3d63d47d17fa2d:0' + coin_action: 'coin_spent' + - operation_identifier: + index: 2 + network_index: 0 + related_operations: + - index: 0 + - index: 1 + type: 'output' + status: 'success' + account: + address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' + amount: + value: '504663471' + currency: + symbol: 'ADA' + decimals: 6 + coin_change: + coin_identifier: + identifier: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73:0' + coin_action: 'coin_created' + metadata: + size: 503 + scriptSize: 2932 + metadata: + transactionsCount: 1 + createdBy: '2a748e3885f6f73320ad16a8331247b81fe01b8d39f57eec9caa5091' + size: 3674 + epochNo: 556 + slotNo: 155041553 Transaction: description: Transactions contain an array of Operations that are attributable to the same TransactionIdentifier. type: object @@ -667,6 +747,70 @@ components: $ref: '#/components/schemas/RelatedTransaction' metadata: $ref: '#/components/schemas/TransactionMetadata' + example: + transaction_identifier: + hash: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73' + operations: + - operation_identifier: + index: 0 + type: 'input' + status: 'success' + account: + address: 'addr1q8n85ymr09p8czlya59z5k6vyrfuhmg0zf3vfll46jqn25pgjy6j9tzkpzlupfjgmssf25nkudk6dk8nraesvygnntjs3m5fnu' + amount: + value: '-3000000' + currency: + symbol: 'ADA' + decimals: 6 + coin_change: + coin_identifier: + identifier: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' + coin_action: 'coin_spent' + metadata: + tokenBundle: + - policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' + tokens: + - value: '-161333000000' + currency: + symbol: '41474958' + decimals: 0 + - operation_identifier: + index: 1 + type: 'input' + status: 'success' + account: + address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' + amount: + value: '-502066491' + currency: + symbol: 'ADA' + decimals: 6 + coin_change: + coin_identifier: + identifier: 'f81b467c4c23af80d498956ea0540427a325cb87e0881b1d8a3d63d47d17fa2d:0' + coin_action: 'coin_spent' + - operation_identifier: + index: 2 + network_index: 0 + related_operations: + - index: 0 + - index: 1 + type: 'output' + status: 'success' + account: + address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' + amount: + value: '504663471' + currency: + symbol: 'ADA' + decimals: 6 + coin_change: + coin_identifier: + identifier: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73:0' + coin_action: 'coin_created' + metadata: + size: 503 + scriptSize: 2932 Operation: description: Operations contain all balance-changing information within a transaction. They are always one-sided (only affect 1 AccountIdentifier) and can succeed or fail independently from a Transaction. Operations are used both to represent on-chain data (Data API) and to construct new transactions (Construction API), creating a standard interface for reading and writing to blockchains. type: object @@ -682,16 +826,29 @@ components: items: $ref: '#/components/schemas/OperationIdentifier' example: + - index: 0 - index: 1 - - index: 2 type: description: Type is the network-specific type of the operation. Ensure that any type that can be returned here is also specified in the NetworkOptionsResponse. This can be very useful to downstream consumers that parse all block data. type: string - example: Transfer + examples: + - 'input' + - 'output' + - 'stakeKeyRegistration' + - 'stakeDelegation' + - 'stakeKeyDeregistration' + - 'poolRegistration' + - 'poolRegistrationWithCert' + - 'poolRetirement' + - 'voteRegistration' + - 'dRepVoteDelegation' + - 'withdrawal' status: description: Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. Cardano transactions are generally atomic; they either succeed entirely and are included in a block or fail validation and are rejected. Therefore, the status for operations within a block transaction will typically be a single success value defined in NetworkOptionsResponse. On-chain operations (operations retrieved in the `/block` and `/block/transaction` endpoints) MUST have a populated status field. Operations provided during transaction construction (often called "intent") MUST NOT have a populated status field. type: string - example: success # Example for Cardano + examples: + - 'success' + - 'failure' account: $ref: '#/components/schemas/AccountIdentifier' amount: @@ -710,11 +867,16 @@ components: value: description: Value of the transaction in atomic units represented as an arbitrary-sized signed integer. For example, 1 BTC would be represented by a value of 100000000. type: string - example: '1238089899992' + example: '-3000000' currency: $ref: '#/components/schemas/Currency' metadata: type: object + example: + value: '-3000000' + currency: + symbol: 'ADA' + decimals: 6 Currency: description: Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (e.g., Lovelace for ADA) to standard units (e.g., ADA). For Cardano native assets, the `symbol` is often the asset name (or hex-encoded name), `decimals` is 0, and `metadata` contains the `policyId` and potentially the human-readable `assetName`. type: object @@ -725,15 +887,18 @@ components: symbol: description: Canonical symbol associated with a currency. type: string - example: BTC + example: 'ADA' decimals: - description: Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10. + description: Number of decimal places in the standard unit representation of the amount. For example, ADA has 6 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10. type: integer format: int32 minimum: 0 - example: 8 + example: 6 metadata: $ref: '#/components/schemas/CurrencyMetadata' + example: + symbol: 'ADA' + decimals: 6 SyncStatus: description: SyncStatus is used to provide additional context about an implementation's sync status. This object is often used by implementations to indicate healthiness when block data cannot be queried until some sync phase completes or cannot be determined by comparing the timestamp of the most recent block with the current time. type: object @@ -763,7 +928,7 @@ components: properties: peer_id: type: string - example: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' # TODO: Add a proper example for peer_id + example: '' # TODO: Add a proper example for peer_id (issue #450) metadata: type: object Version: @@ -776,18 +941,19 @@ components: rosetta_version: description: The rosetta_version is the version of the Rosetta interface the implementation adheres to. This can be useful for clients looking to reliably parse responses. type: string - example: 1.2.5 + example: 1.4.13 node_version: description: The node_version is the canonical version of the node runtime. This can help clients manage deployments. type: string - example: 1.0.2 + example: 10.2.1 middleware_version: description: When a middleware server is used to adhere to the Rosetta interface, it should return its version here. This can help clients manage deployments. type: string - example: 0.2.7 + example: 1.2.8 metadata: description: Any other information that may be useful about versioning of dependent services should be returned here. type: object + example: {} Allow: description: Allow specifies supported Operation status, Operation types, and all possible error statuses. This Allow object is used by clients to validate the correctness of a Rosetta Server implementation. It is expected that these clients will error if they receive some response that contains any of the above information that is not specified here. type: object @@ -808,6 +974,8 @@ components: example: - status: 'success' successful: true + - status: 'invalid' + successful: false operation_types: description: All Operation.Type this implementation supports. This is crucial for Cardano, which has many distinct operation types beyond simple transfers. type: array @@ -816,76 +984,190 @@ components: example: # Add all relevant Cardano operation types - 'input' - 'output' - - 'stake_registration' - - 'stake_deregistration' - - 'stake_delegation' - - 'pool_registration' - - 'pool_retirement' + - 'stakeKeyRegistration' + - 'stakeDelegation' - 'withdrawal' - - 'asset_mint' - - 'asset_burn' - - 'script_input' - - 'script_output' - - 'collateral_input' - - 'collateral_output' - - 'reference_input' - - 'vote_registration' # Conway era onwards - - 'vote_delegation' # Conway era onwards - - 'stake_vote_delegation' # Conway era onwards - - 'committee_hot_auth' # Conway era onwards - - 'committee_cold_resign' # Conway era onwards - - 'drep_registration' # Conway era onwards - - 'drep_deregistration' # Conway era onwards - - 'drep_update' # Conway era onwards - - 'governance_action' # Conway era onwards + - 'stakeKeyDeregistration' + - 'poolRegistration' + - 'poolRegistrationWithCert' + - 'poolRetirement' + - 'voteRegistration' + - 'dRepVoteDelegation' errors: description: All Errors that this implementation could return. Include Cardano-specific transaction submission errors and node query errors. type: array items: $ref: '#/components/schemas/Error' example: # Add relevant Cardano error examples - - code: 1 # Generic Internal Server Error - message: 'Internal Server Error' + - code: 4001 + message: 'Block not found' + retriable: false + - code: 4002 + message: 'Network not found' retriable: false - - code: 100 # Example: Input UTXO not found - message: 'Input UTXO Not Found' + - code: 4003 + message: 'Networks not found' retriable: false - description: 'One of the transaction inputs does not exist or is already spent.' - - code: 101 # Example: Fee Too Small - message: 'Fee Too Small' + - code: 4004 + message: 'Invalid blockchain' retriable: false - description: 'The provided fee does not meet the minimum requirement based on transaction size and protocol parameters.' - - code: 102 # Example: TTL Exceeded - message: 'TTL Exceeded' + - code: 4005 + message: 'Genesis block not found' retriable: false - description: "The transaction's time-to-live (TTL) slot is in the past relative to the current node tip." - - code: 103 # Example: Value Not Conserved - message: 'Value Not Conserved' + - code: 4006 + message: 'Transaction not found' retriable: false - description: 'The sum of transaction inputs (plus minting) does not equal the sum of outputs (plus burning and fee).' - - code: 104 # Example: Script Validation Failed - message: 'Script Validation Failed' + - code: 4007 + message: 'Invalid public key format' retriable: false - description: 'A Plutus script associated with the transaction failed validation.' - - code: 105 # Example: Pool Registration Error - message: 'Pool Registration Error' + - code: 4008 + message: 'Transaction inputs parameters errors in operations array' retriable: false - description: 'Error related to stake pool registration parameters or deposits.' - - code: 106 # Example: Bad Inputs - message: 'Bad Inputs' + - code: 4009 + message: 'Transaction outputs parameters errors in operations array' retriable: false - description: 'General error indicating invalid transaction inputs or structure (e.g., duplicate inputs).' - - code: 500 # Example: Rosetta Specification Error - message: 'Rosetta Specification Error' + - code: 4010 + message: 'The transaction you are trying to build has more outputs than inputs' retriable: false - description: 'The request or response violates the Rosetta specification based on Network Options.' - - code: 600 # Example: Node Query Error - message: 'Node Query Error' + - code: 4011 + message: 'Cant create signed transaction from transaction bytes' + retriable: false + - code: 4012 + message: 'Cant create unsigned transaction from transaction bytes' + retriable: false + - code: 4013 + message: 'Cant deserialize transaction input from transaction body' + retriable: false + - code: 4014 + message: 'Cant deserialize transaction output from transaction body' + retriable: false + - code: 4015 + message: 'Provided address is invalid' + retriable: true + - code: 4016 + message: 'Provided address type is invalid' + retriable: true + - code: 4017 + message: 'Invalid staking key format' + retriable: false + - code: 4018 + message: 'Staking key is required for this type of address' + retriable: false + - code: 4019 + message: 'Provided operation type is invalid' retriable: true - description: 'Failed to query the underlying Cardano node.' + - code: 4020 + message: 'Pool key hash is required to operate' + retriable: false + - code: 4021 + message: 'Assets are required for output operation token bundle' + retriable: false + - code: 4022 + message: 'Asset value is required for token asset' + retriable: false + - code: 4023 + message: 'Invalid policy id' + retriable: false + - code: 4024 + message: 'Invalid token name' + retriable: false + - code: 4025 + message: 'Provided pool key hash has invalid format' + retriable: false + - code: 4026 + message: 'Pool registration certificate is required for pool registration' + retriable: false + - code: 4027 + message: 'Invalid pool registration certificate format' + retriable: false + - code: 4028 + message: 'Invalid certificate type. Expected pool registration certificate' + retriable: false + - code: 4029 + message: 'Pool registration parameters were expected' + retriable: false + - code: 4030 + message: 'Pool relays are invalid' + retriable: false + - code: 4031 + message: 'Pool metadata is invalid' + retriable: false + - code: 4032 + message: 'Dns name expected for pool relay' + retriable: false + - code: 4033 + message: 'Invalid pool relay type received' + retriable: false + - code: 4034 + message: 'Invalid pool owners received' + retriable: false + - code: 4035 + message: 'Invalid pool registration parameters received' + retriable: false + - code: 4036 + message: 'Mandatory parameter is missing: Epoch' + retriable: false + - code: 4037 + message: 'Error when sending the transaction - OutsideValidityIntervalUTxO' + retriable: false + - code: 5000 + message: 'An error occurred' + retriable: true + - code: 5001 + message: 'Not implemented' + retriable: false + - code: 5002 + message: 'Address generation error' + retriable: false + - code: 5003 + message: 'Parse signed transaction error' + retriable: false + - code: 5004 + message: 'Cant create signed transaction probably because of unsigned transaction bytes' + retriable: false + - code: 5005 + message: 'Cant build witnesses set for transaction probably because of provided signatures' + retriable: false + - code: 5006 + message: 'Error when sending the transaction' + retriable: true + - code: 5007 + message: 'Voting nonce not valid' + retriable: false + - code: 5008 + message: 'Invalid voting signature' + retriable: false + - code: 5009 + message: 'Voting key is missing' + retriable: false + - code: 5010 + message: 'Voting key format is invalid' + retriable: false + - code: 5011 + message: 'Missing vote registration metadata' + retriable: false + - code: 5012 + message: 'Missing chain code' + retriable: false + - code: 5013 + message: 'Invalid operation status' + retriable: false + - code: 5014 + message: 'Given operation status and success state does not match' + retriable: false + - code: 5015 + message: 'Transaction hash does not match to given coin identifier' + retriable: false + - code: 5016 + message: 'Address and account identifier does not match' + retriable: false + - code: 5017 + message: 'Coin identifier has an invalid format' + retriable: false historical_balance_lookup: type: boolean description: Any Rosetta implementation that supports querying the balance of an account at any height in the past should set this to true. + example: true timestamp_start_index: type: integer format: int64 @@ -896,18 +1178,22 @@ components: description: All methods that are supported by the /call endpoint. Communicating which parameters should be provided to /call is the responsibility of the implementer (this is en lieu of defining an entire type system and requiring the implementer to define that in Allow). items: type: string - example: eth_call + example: [] balance_exemptions: type: array description: BalanceExemptions is an array of BalanceExemption indicating which account balances could change without a corresponding Operation. BalanceExemptions should be used sparingly as they may introduce significant complexity for integrators that attempt to reconcile all account balance changes. If your implementation relies on any BalanceExemptions, you MUST implement historical balance lookup (the ability to query an account balance at any BlockIdentifier). items: $ref: '#/components/schemas/BalanceExemption' + example: [] mempool_coins: type: boolean description: Any Rosetta implementation that can update an AccountIdentifier's unspent coins based on the contents of the mempool should populate this field as true. If false, requests to `/account/coins` that set `include_mempool` as true will be automatically rejected. + example: false + # TODO: Verify if block_hash_case is implemented block_hash_case: $ref: '#/components/schemas/Case' description: This specifies the normalized case for block hash in the BlockIdentifier. If not specified, it's assumed to be case sensitive. + # TODO: Verify if transaction_hash_case is implemented transaction_hash_case: $ref: '#/components/schemas/Case' description: This specifies the normalized case for transaction hash in the TransactionIdentifier. If not specified, it's assumed to be case sensitive. @@ -932,7 +1218,7 @@ components: type: integer format: int64 minimum: 0 - example: 1582833600000 + example: 1746607844000 PublicKey: description: PublicKey contains a public key byte array for a particular CurveType encoded in hex. Note that there is no PrivateKey struct as this is NEVER the concern of an implementation. type: object @@ -1013,7 +1299,7 @@ components: identifier: description: Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction_hash:index. type: string - example: 0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f:1 + example: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' CoinChange: description: CoinChange is used to represent a change in state of a some coin identified by a coin_identifier. This object is part of the Operation model and must be populated for UTXO-based blockchains. Coincidentally, this abstraction of UTXOs allows for supporting both account-based transfers and UTXO-based transfers on the same blockchain (when a transfer is account-based, don't populate this model). type: object @@ -1025,6 +1311,10 @@ components: $ref: '#/components/schemas/CoinIdentifier' coin_action: $ref: '#/components/schemas/CoinAction' + example: + coin_identifier: + identifier: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' + coin_action: 'coin_spent' Coin: description: Coin contains its unique identifier and the amount it represents. type: object @@ -1038,6 +1328,7 @@ components: $ref: '#/components/schemas/Amount' metadata: $ref: '#/components/schemas/CoinMetadata' + # TODO: Verify if BalanceExemption is implemented BalanceExemption: description: BalanceExemption indicates that the balance for an exempt account could change without a corresponding Operation. This typically occurs with staking rewards, vesting balances, and Currencies with a dynamic supply. Currently, it is possible to exempt an account from strict reconciliation by SubAccountIdentifier.Address or by Currency. This means that any account with SubAccountIdentifier.Address would be exempt or any balance of a particular Currency would be exempt, respectively. BalanceExemptions should be used sparingly as they may introduce significant complexity for integrators that attempt to reconcile all account balance changes. If your implementation relies on any BalanceExemptions, you MUST implement historical balance lookup (the ability to query an account balance at any BlockIdentifier). type: object @@ -1057,6 +1348,7 @@ components: - greater_or_equal - less_or_equal - dynamic + # Not implemented for Cardano # BlockEvent: # description: BlockEvent represents the addition or removal of a BlockIdentifier from storage. Streaming BlockEvents allows lightweight clients to update their own state without needing to implement their own syncing logic. # type: object @@ -1145,6 +1437,22 @@ components: description: In some cases, the caller may not want to retrieve all available balances for an AccountIdentifier. If the currencies field is populated, only balances for the specified currencies will be returned. If not populated, all available balances will be returned. items: $ref: '#/components/schemas/Currency' + example: + network_identifier: + blockchain: 'cardano' + network: 'mainnet' + account_identifier: + address: 'addr1qxx6qfrre0mynlmcst5wj3h0flk093zjx9wl86k6gnksztp693mm58mml2ckdm09rgycahv5ex68c36a7kp4r2sgcx7q3rqcx8' + block_identifier: + index: 11835193 + hash: '63a22fe4206c78794a54d5837e0f35d93f3c6eedb8689bcc73842795e3f425cd' + currencies: + - symbol: 'ADA' + decimals: 6 + - symbol: '0014df1047454e53' + decimals: 0 + metadata: + policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' AccountBalanceResponse: description: 'An AccountBalanceResponse is returned on the /account/balance endpoint. If an account has a balance for each AccountIdentifier describing it (ex: an ERC-20 token balance on a few smart contracts), an account balance request must be made with each AccountIdentifier. The `coins` field was removed and replaced by by `/account/coins` in `v1.4.7`.' type: object @@ -1159,11 +1467,27 @@ components: description: A single account may have a balance in multiple currencies. items: $ref: '#/components/schemas/Amount' - metadata: - description: Account-based blockchains that utilize a nonce or sequence number should include that number in the metadata. This number could be unique to the identifier or global across the account address. - type: object - example: - sequence_number: 23 + # Not implemented for Cardano + # metadata: + # description: Account-based blockchains that utilize a nonce or sequence number should include that number in the metadata. This number could be unique to the identifier or global across the account address. + # type: object + # example: + # sequence_number: 23 + example: + block_identifier: + index: 11835193 + hash: '63a22fe4206c78794a54d5837e0f35d93f3c6eedb8689bcc73842795e3f425cd' + balances: + - value: '1988397' + currency: + symbol: 'ADA' + decimals: 6 + - value: '60000000000' + currency: + symbol: '0014df1047454e53' + decimals: 0 + metadata: + policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' AccountCoinsRequest: description: AccountCoinsRequest is utilized to make a request on the /account/coins endpoint. type: object @@ -1175,15 +1499,29 @@ components: $ref: '#/components/schemas/NetworkIdentifier' account_identifier: $ref: '#/components/schemas/AccountIdentifier' - include_mempool: - type: boolean - default: false - description: Include state from the mempool when looking up an account's unspent coins. Note, using this functionality breaks any guarantee of idempotency. + # Not implemented for Cardano + # include_mempool: + # type: boolean + # default: false + # description: Include state from the mempool when looking up an account's unspent coins. Note, using this functionality breaks any guarantee of idempotency. currencies: type: array description: In some cases, the caller may not want to retrieve coins for all currencies for an AccountIdentifier. If the currencies field is populated, only coins for the specified currencies will be returned. If not populated, all unspent coins will be returned. items: $ref: '#/components/schemas/Currency' + example: + network_identifier: + blockchain: 'cardano' + network: 'mainnet' + account_identifier: + address: 'addr1qxx6qfrre0mynlmcst5wj3h0flk093zjx9wl86k6gnksztp693mm58mml2ckdm09rgycahv5ex68c36a7kp4r2sgcx7q3rqcx8' + currencies: + - symbol: 'ADA' + decimals: 6 + - symbol: '0014df1047454e53' + decimals: 0 + metadata: + policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' AccountCoinsResponse: description: AccountCoinsResponse is returned on the /account/coins endpoint and includes all unspent Coins owned by an AccountIdentifier. type: object @@ -1203,6 +1541,28 @@ components: type: object example: sequence_number: 23 + example: + block_identifier: + index: 11835240 + hash: 'ade2395f21cc26ebfb86c1e74fd910193902a87b289be18b67a3903813141b39' + coins: + - coin_identifier: + identifier: '82014e975b195c77d296fa1c8947c4614bb6392ade219dffb47b2fdda88f837f:1' + amount: + value: '1988397' + currency: + symbol: 'ADA' + decimals: 6 + metadata: + '82014e975b195c77d296fa1c8947c4614bb6392ade219dffb47b2fdda88f837f:1': # The metadata key here is the coin_identifier.identifier, this needs to be reflected in the CoinMetadata schema or a specific Coin.metadata schema + - policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' + tokens: + - value: '60000000000' + currency: + symbol: '0014df1047454e53' + decimals: 0 + metadata: + policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' BlockRequest: description: A BlockRequest is utilized to make a block request on the /block endpoint. type: object @@ -1225,6 +1585,85 @@ components: type: array items: $ref: '#/components/schemas/TransactionIdentifier' + example: + block: + block_identifier: + index: 11832620 + hash: '4797bd63a225277231bd02f87be986c33a1ff61eb12681fb5eaa5620f638fa05' + parent_block_identifier: + index: 11832619 + hash: 'b5781a495eb21b613136fe09a19321c9a9f7fa8978e8d26105e3306287061625' + timestamp: 1746607844000 + transactions: + - transaction_identifier: + hash: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73' + operations: + - operation_identifier: + index: 0 + type: 'input' + status: 'success' + account: + address: 'addr1q8n85ymr09p8czlya59z5k6vyrfuhmg0zf3vfll46jqn25pgjy6j9tzkpzlupfjgmssf25nkudk6dk8nraesvygnntjs3m5fnu' + amount: + value: '-3000000' + currency: + symbol: 'ADA' + decimals: 6 + coin_change: + coin_identifier: + identifier: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' + coin_action: 'coin_spent' + metadata: + tokenBundle: + - policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' + tokens: + - value: '-161333000000' + currency: + symbol: '41474958' + decimals: 0 + - operation_identifier: + index: 1 + type: 'input' + status: 'success' + account: + address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' + amount: + value: '-502066491' + currency: + symbol: 'ADA' + decimals: 6 + coin_change: + coin_identifier: + identifier: 'f81b467c4c23af80d498956ea0540427a325cb87e0881b1d8a3d63d47d17fa2d:0' + coin_action: 'coin_spent' + - operation_identifier: + index: 2 + network_index: 0 + related_operations: + - index: 0 + - index: 1 + type: 'output' + status: 'success' + account: + address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' + amount: + value: '504663471' + currency: + symbol: 'ADA' + decimals: 6 + coin_change: + coin_identifier: + identifier: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73:0' + coin_action: 'coin_created' + metadata: + size: 503 + scriptSize: 2932 + metadata: + transactionsCount: 1 + createdBy: '2a748e3885f6f73320ad16a8331247b81fe01b8d39f57eec9caa5091' + size: 3674 + epochNo: 556 + slotNo: 155041553 BlockTransactionRequest: description: A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse. type: object @@ -1247,6 +1686,7 @@ components: properties: transaction: $ref: '#/components/schemas/Transaction' + # Not implemented for Cardano # MempoolResponse: # description: A MempoolResponse contains all transaction identifiers in the mempool for a particular network_identifier. # type: object @@ -1321,12 +1761,12 @@ components: $ref: '#/components/schemas/Timestamp' genesis_block_identifier: $ref: '#/components/schemas/BlockIdentifier' - #oldest_block_identifier: # TODO: Add oldest_block_identifier property to SyncStatus + #oldest_block_identifier: # TODO: Add oldest_block_identifier property to NetworkStatusResponse (issue #439) # description: Not implemented. # $ref: '#/components/schemas/BlockIdentifier' sync_status: $ref: '#/components/schemas/SyncStatus' - #peers: # TODO: Fix empty peers property in NetworkStatusResponse + #peers: # TODO: Fix empty peers property in NetworkStatusResponse (issue #450) # type: array # items: # $ref: '#/components/schemas/Peer' @@ -1673,30 +2113,6 @@ components: success: type: boolean description: success is a synthetic condition populated by parsing network-specific operation statuses (using the mapping provided in `/network/options`). - SearchTransactionsResponse: - description: SearchTransactionsResponse contains an ordered collection of BlockTransactions that match the query in SearchTransactionsRequest. These BlockTransactions are sorted from most recent block to oldest block. - type: object - required: - - transactions - - total_count - properties: - transactions: - type: array - description: transactions is an array of BlockTransactions sorted by most recent BlockIdentifier (meaning that transactions in recent blocks appear first). If there are many transactions for a particular search, transactions may not contain all matching transactions. It is up to the caller to paginate these transactions using the max_block field. - items: - $ref: '#/components/schemas/BlockTransaction' - total_count: - description: total_count is the number of results for a given search. Callers typically use this value to concurrently fetch results by offset or to display a virtual page number associated with results. - type: integer - format: int64 - minimum: 0 - example: 5 - next_offset: - description: next_offset is the next offset to use when paginating through transaction results. If this field is not populated, there are no more transactions to query. - type: integer - format: int64 - minimum: 0 - example: 5 Error: description: Instead of utilizing HTTP status codes to describe node errors (which often do not have a good analog), rich errors are returned using this object. Both the code and message fields can be individually used to correctly identify an error. Implementations MUST use unique values for both fields. type: object @@ -1749,6 +2165,12 @@ components: description: slotNo type: integer format: int64 + example: + transactionsCount: 1 + createdBy: '2a748e3885f6f73320ad16a8331247b81fe01b8d39f57eec9caa5091' + size: 3674 + epochNo: 556 + slotNo: 155041553 TransactionMetadata: description: Contains Cardano-specific transaction details beyond the core operations, such as fees, TTL, certificates, withdrawals, minting information, collateral, script data hash, and required signers. type: object @@ -1802,9 +2224,8 @@ components: items: type: string example: - size: 12378 - fee: { value: '170000', currency: { symbol: 'ADA', decimals: 6 } } - ttl: 8675309 + size: 503 + scriptSize: 2932 OperationMetadata: description: OperationMetadata provides Cardano-specific context for an Operation, such as withdrawal/deposit amounts, staking credentials, pool details, DRep information, voting metadata, or the native assets involved (via tokenBundle if the operation affects a UTXO). type: object @@ -1841,6 +2262,14 @@ components: $ref: '#/components/schemas/PoolRegistrationParams' voteRegistrationMetadata: $ref: '#/components/schemas/VoteRegistrationMetadata' + example: + tokenBundle: + - policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' + tokens: + - value: '-161333000000' + currency: + symbol: '41474958' + decimals: 0 VoteRegistrationMetadata: description: VoteRegistrationMetadata type: object @@ -1872,6 +2301,13 @@ components: type: array items: $ref: '#/components/schemas/Amount' + example: + policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' + tokens: + - value: '-161333000000' + currency: + symbol: '41474958' + decimals: 0 DRepTypeParams: # required if id has 29 bytes, otherwise not required description: DRepTypeParams type: string @@ -2064,6 +2500,8 @@ components: assetName: description: Optional human-readable asset name (UTF-8 encoded, then hex-encoded if needed). type: string + example: + policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' ConstructionMetadataRequestOption: description: '' type: object @@ -2084,7 +2522,12 @@ components: protocol_parameters: $ref: '#/components/schemas/ProtocolParameters' CoinMetadata: - description: Contains the native assets held by this UTXO (Coin). The ADA amount is represented in the main Coin.Amount field. + description: | + Contains the native assets held by this UTXO (Coin). The ADA amount is represented in the main Coin.Amount field. + #TODO: BUG/INCONSISTENCY - The AccountCoinsResponse example shows Coin.metadata having a dynamic key (the coin_identifier.identifier) + #and a value structure like [{policyId: string, tokens: Amount[]}]. + #This contradicts this CoinMetadata schema, which expects a fixed "assets" key. + #Investigate whether the schema or the example (and potentially API implementation) is correct and align them. type: object properties: assets: @@ -2092,9 +2535,9 @@ components: description: List of Amounts representing native assets (excluding ADA) held by the coin. items: $ref: '#/components/schemas/Amount' - CoinTokens: - # This schema is no longer used by CoinMetadata and can potentially be removed if not used elsewhere. - description: | - DEPRECATED by simplified CoinMetadata.assets. CoinTokens contains the policyId and the tokens - it represents. - type: object + #CoinTokens: + # This schema is no longer used by CoinMetadata and can potentially be removed if not used elsewhere. + #description: | + # DEPRECATED by simplified CoinMetadata.assets. CoinTokens contains the policyId and the tokens + # it represents. + #type: object From df86ed319adbab99262c240d6ffe178d0abe86ee Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Wed, 7 May 2025 21:53:35 -0300 Subject: [PATCH 03/13] chore: update Docusaurus configuration and CSS for improved documentation layout - Updated custom CSS to enhance layout consistency, including centering the navbar and main wrapper. - Removed the proxy URL from the configuration. - Adjusted styles for the theme edit button and sidebar to improve user experience. - Deleted the outdated API specification file to streamline documentation. --- docs/docusaurus.config.js | 12 +- docs/src/css/custom.css | 67 +- docs/static/api.yaml | 2000 ------------------------------------- 3 files changed, 49 insertions(+), 2030 deletions(-) delete mode 100644 docs/static/api.yaml diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index f087103112..e457b7a57f 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -154,18 +154,18 @@ const config = { forceDarkModeState: 'light', withDefaultFonts: false, hideClientButton: true, - searchHotKey: 'l', - proxyUrl: 'https://proxy.scalar.com', + hideTestRequestButton: true, + //proxyUrl: 'https://proxy.scalar.com', servers: [ { url: 'http://localhost:8082', name: 'Local', }, ], - customCss: `* { - --scalar-background-1: transparent; - --scalar-font: 'Helvetica Neue', Helvetica, Arial, sans-serif; - }` + customCss: `* { + --scalar-font: 'Helvetica Neue', Helvetica, Arial, sans-serif; + } + ` }, diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 038a1f897d..87d0091231 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -1,7 +1,7 @@ /******************************************************* * Global & Theme Variables * *******************************************************/ -:root { + :root { /* Primary Grey Colors */ --grey-1000: #272727; --grey-800: #404040; @@ -142,25 +142,20 @@ /* Constrain the navbar content */ .navbar__inner { - max-width: var(--content-max-width); - margin: 0 8%; + max-width: 1800px; + margin: 0 auto; } /* Constrain the main wrapper for the whole page content below navbar */ .main-wrapper { - max-width: var(--content-max-width); - margin: 0 8%; + max-width: 1800px; + margin: 0 auto; display: flex; + justify-content: space-between; + padding: 0 2rem; + width: 100%; } - /* Keep sidebar width fixed */ - .theme-doc-sidebar-container { - width: 300px; - min-width: 300px; - flex-shrink: 0; /* Prevent sidebar from shrinking */ - position: sticky; /* should now be relative to the centered main-wrapper */ - } - } h1, h2, h3, h4, h5, h6 { @@ -831,14 +826,10 @@ html[data-theme='dark'] .choice-card .button--secondary { color: var(--ifm-color-emphasis-900); } -.markdown { - padding: 1.68rem; -} - .theme-edit-this-page { background-color: var(--ifm-color-emphasis-100); - border-radius: 12px; - padding: 8px 12px; + border-radius: 8px; + padding: 8px 2px; margin-bottom: 12px; margin-top: 12px; border: 1px solid var(--ifm-color-emphasis-200); @@ -850,6 +841,11 @@ html[data-theme='dark'] .choice-card .button--secondary { transition: background-color 0.2s ease, color 0.2s ease, transform 0.2s ease; cursor: pointer; user-select: none; + display: flex; + flex-direction: row; + align-items: center; + justify-content: center; + max-width: 152px; } /******************************************************* @@ -1306,17 +1302,40 @@ div[class*='codeBlockContainer'] { } [data-theme='dark'] .card { - background-color: #1c2128; - border-color: rgba(255, 255, 255, 0.1); - box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2); + background-color: rgba(255, 255, 255, 0.03); + border-color: rgba(255, 255, 255, 0.12); + box-shadow: 0 2px 8px rgba(0, 0, 0, 0.2); } [data-theme='dark'] .card:hover { - background-color: #242a33; - border-color: rgba(255, 255, 255, 0.15); + background-color: rgba(255, 255, 255, 0.06); + border-color: rgba(255, 255, 255, 0.2); box-shadow: 0 5px 15px rgba(0, 0, 0, 0.3); } +/* Hide icons in User Guides category card titles */ +.cardTitle_rnsV { + font-size: 0 !important; + line-height: normal; +} + +.cardTitle_rnsV::before { + content: attr(title); + font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif; + font-weight: 700; + font-size: 1.25rem; + line-height: 1.4; +} + +/* Explicit color settings for the ::before pseudo-element, matching h2 styles */ +[data-theme='light'] .cardTitle_rnsV::before { + color: var(--grey-1000); +} + +[data-theme='dark'] .cardTitle_rnsV::before { + color: #fff; +} + /******************************************************* * Override Details Alert Styling * *******************************************************/ diff --git a/docs/static/api.yaml b/docs/static/api.yaml deleted file mode 100644 index 23f3a2b430..0000000000 --- a/docs/static/api.yaml +++ /dev/null @@ -1,2000 +0,0 @@ -openapi: 3.0.2 -info: - version: 1.4.13 - title: Rosetta - description: Build Once. Integrate Your Blockchain Everywhere. - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html -paths: - /network/list: - post: - summary: Get List of Available Networks - description: This endpoint returns a list of NetworkIdentifiers that the Rosetta server supports. - operationId: networkList - tags: - - Network - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/MetadataRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkListResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /network/status: - post: - summary: Get Network Status - description: This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. - operationId: networkStatus - tags: - - Network - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkStatusResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /network/options: - post: - summary: Get Network Options - description: This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. - operationId: networkOptions - tags: - - Network - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkOptionsResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /block: - post: - summary: Get a Block - description: 'Get a block by its Block Identifier. If transactions are returned in the same call to the node as fetching the block, the response should include these transactions in the Block object. If not, an array of Transaction Identifiers should be returned so /block/transaction fetches can be done to get all transaction information. When requesting a block by the hash component of the BlockIdentifier, this request MUST be idempotent: repeated invocations for the same hash-identified block must return the exact same block contents. No such restriction is imposed when requesting a block by height, given that a chain reorg event might cause the specific block at height `n` to be set to a different one.' - operationId: block - tags: - - Block - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/BlockRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/BlockResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /block/transaction: - post: - summary: Get a Block Transaction - description: 'Get a transaction in a block by its Transaction Identifier. This endpoint should only be used when querying a node for a block does not return all transactions contained within it. All transactions returned by this endpoint must be appended to any transactions returned by the /block method by consumers of this data. Fetching a transaction by hash is considered an Explorer Method (which is classified under the Future Work section). This method can be used to let consumers to paginate results when the block trasactions count is too big to be returned in a single BlockResponse. Calling this endpoint requires reference to a BlockIdentifier because transaction parsing can change depending on which block contains the transaction. For example, in Bitcoin it is necessary to know which block contains a transaction to determine the destination of fee payments. Without specifying a block identifier, the node would have to infer which block to use (which could change during a re-org). Implementations that require fetching previous transactions to populate the response (ex: Previous UTXOs in Bitcoin) may find it useful to run a cache within the Rosetta server in the /data directory (on a path that does not conflict with the node).' - operationId: blockTransaction - tags: - - Block - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/BlockTransactionRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/BlockTransactionResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /mempool: - post: - summary: Get All Mempool Transactions - description: Get all Transaction Identifiers in the mempool - operationId: mempool - tags: - - Mempool - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NetworkRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/MempoolResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /mempool/transaction: - post: - summary: Get a Mempool Transaction - description: 'Get a transaction in the mempool by its Transaction Identifier. This is a separate request than fetching a block transaction (/block/transaction) because some blockchain nodes need to know that a transaction query is for something in the mempool instead of a transaction in a block. Transactions may not be fully parsable until they are in a block (ex: may not be possible to determine the fee to pay before a transaction is executed). On this endpoint, it is ok that returned transactions are only estimates of what may actually be included in a block.' - operationId: mempoolTransaction - tags: - - Mempool - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/MempoolTransactionRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/MempoolTransactionResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /account/balance: - post: - summary: Get an Account's Balance - description: Get an array of all AccountBalances for an AccountIdentifier and the BlockIdentifier at which the balance lookup was performed. The BlockIdentifier must always be returned because some consumers of account balance data need to know specifically at which block the balance was calculated to compare balances they compute from operations with the balance returned by the node. It is important to note that making a balance request for an account without populating the SubAccountIdentifier should not result in the balance of all possible SubAccountIdentifiers being returned. Rather, it should result in the balance pertaining to no SubAccountIdentifiers being returned (sometimes called the liquid balance). To get all balances associated with an account, it may be necessary to perform multiple balance requests with unique AccountIdentifiers. It is also possible to perform a historical balance lookup (if the server supports it) by passing in an optional BlockIdentifier. - operationId: accountBalance - tags: - - Account - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AccountBalanceRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/AccountBalanceResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /account/coins: - post: - summary: Get an Account's Unspent Coins - description: Get an array of all unspent coins for an AccountIdentifier and the BlockIdentifier at which the lookup was performed. If your implementation does not support coins (i.e. it is for an account-based blockchain), you do not need to implement this endpoint. If you implementation does support coins (i.e. it is fro a UTXO-based blockchain), you MUST also complete the `/account/balance` endpoint. It is important to note that making a coins request for an account without populating the SubAccountIdentifier should not result in the coins of all possible SubAccountIdentifiers being returned. Rather, it should result in the coins pertaining to no SubAccountIdentifiers being returned. To get all coins associated with an account, it may be necessary to perform multiple coin requests with unique AccountIdentifiers. Optionally, an implementation may choose to support updating an AccountIdentifier's unspent coins based on the contents of the mempool. Note, using this functionality breaks any guarantee of idempotency. - operationId: accountCoins - tags: - - Account - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AccountCoinsRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/AccountCoinsResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /construction/derive: - post: - summary: Derive an AccountIdentifier from a PublicKey - description: Derive returns the AccountIdentifier associated with a public key. Blockchains that require an on-chain action to create an account should not implement this method. - operationId: constructionDerive - tags: - - Construction - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionDeriveRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionDeriveResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /construction/preprocess: - post: - summary: Create a Request to Fetch Metadata - description: Preprocess is called prior to `/construction/payloads` to construct a request for any metadata that is needed for transaction construction given (i.e. account nonce). The `options` object returned from this endpoint will be sent to the `/construction/metadata` endpoint UNMODIFIED by the caller (in an offline execution environment). If your Construction API implementation has configuration options, they MUST be specified in the `/construction/preprocess` request (in the `metadata` field). - operationId: constructionPreprocess - tags: - - Construction - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionPreprocessRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionPreprocessResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /construction/metadata: - post: - summary: Get Metadata for Transaction Construction - description: Get any information required to construct a transaction for a specific network. Metadata returned here could be a recent hash to use, an account sequence number, or even arbitrary chain state. The request used when calling this endpoint is created by calling `/construction/preprocess` in an offline environment. You should NEVER assume that the request sent to this endpoint will be created by the caller or populated with any custom parameters. This must occur in `/construction/preprocess`. It is important to clarify that this endpoint should not pre-construct any transactions for the client (this should happen in `/construction/payloads`). This endpoint is left purposely unstructured because of the wide scope of metadata that could be required. - operationId: constructionMetadata - tags: - - Construction - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionMetadataRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionMetadataResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /construction/payloads: - post: - summary: Generate an Unsigned Transaction and Signing Payloads - description: Payloads is called with an array of operations and the response from `/construction/metadata`. It returns an unsigned transaction blob and a collection of payloads that must be signed by particular AccountIdentifiers using a certain SignatureType. The array of operations provided in transaction construction often times can not specify all "effects" of a transaction (consider invoked transactions in Ethereum). However, they can deterministically specify the "intent" of the transaction, which is sufficient for construction. For this reason, parsing the corresponding transaction in the Data API (when it lands on chain) will contain a superset of whatever operations were provided during construction. - operationId: constructionPayloads - tags: - - Construction - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionPayloadsRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionPayloadsResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /construction/combine: - post: - summary: Create Network Transaction from Signatures - description: Combine creates a network-specific transaction from an unsigned transaction and an array of provided signatures. The signed transaction returned from this method will be sent to the `/construction/submit` endpoint by the caller. - operationId: constructionCombine - tags: - - Construction - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionCombineRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionCombineResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /construction/parse: - post: - summary: Parse a Transaction - description: 'Parse is called on both unsigned and signed transactions to understand the intent of the formulated transaction. This is run as a sanity check before signing (after `/construction/payloads`) and before broadcast (after `/construction/combine`). ' - operationId: constructionParse - tags: - - Construction - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionParseRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionParseResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /construction/hash: - post: - summary: Get the Hash of a Signed Transaction - description: TransactionHash returns the network-specific transaction hash for a signed transaction. - operationId: constructionHash - tags: - - Construction - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionHashRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/TransactionIdentifierResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /construction/submit: - post: - summary: Submit a Signed Transaction - description: Submit a pre-signed transaction to the node. This call should not block on the transaction being included in a block. Rather, it should return immediately with an indication of whether or not the transaction was included in the mempool. The transaction submission response should only return a 200 status if the submitted transaction could be included in the mempool. Otherwise, it should return an error. - operationId: constructionSubmit - tags: - - Construction - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ConstructionSubmitRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/TransactionIdentifierResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /call: - post: - summary: Make a Network-Specific Procedure Call - description: Call invokes an arbitrary, network-specific procedure call with network-specific parameters. The guidance for what this endpoint should or could do is purposely left vague. In Ethereum, this could be used to invoke `eth_call` to implement an entire Rosetta API interface for some smart contract that is not parsed by the implementation creator (like a DEX). This endpoint could also be used to provide access to data that does not map to any Rosetta models instead of requiring an integrator to use some network-specific SDK and call some network-specific endpoint (like surfacing staking parameters). Call is NOT a replacement for implementing Rosetta API endpoints or mapping network-specific data to Rosetta models. Rather, it enables developers to build additional Rosetta API interfaces for things they care about without introducing complexity into a base-level Rosetta implementation. Simply put, imagine that the average integrator will use layered Rosetta API implementations that each surfaces unique data. - operationId: call - tags: - - Call - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CallRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/CallResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /events/blocks: - post: - summary: '[INDEXER] Get a range of BlockEvents' - description: '`/events/blocks` allows the caller to query a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. Following BlockEvents allows lightweight clients to update their state without needing to implement their own syncing logic (like finding the common parent in a reorg). `/events/blocks` is considered an "indexer" endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' - operationId: eventsBlocks - tags: - - Events - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/EventsBlocksRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/EventsBlocksResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /search/transactions: - post: - summary: '[INDEXER] Search for Transactions' - description: '`/search/transactions` allows the caller to search for transactions that meet certain conditions. Some conditions include matching a transaction hash, containing an operation with a certain status, or containing an operation that affects a certain account. `/search/transactions` is considered an "indexer" endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' - operationId: searchTransactions - tags: - - Search - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SearchTransactionsRequest' - responses: - '200': - description: Expected response to a valid request - content: - application/json: - schema: - $ref: '#/components/schemas/SearchTransactionsResponse' - '500': - description: unexpected error - content: - application/json: - schema: - $ref: '#/components/schemas/Error' -components: - schemas: - NetworkIdentifier: - description: The network_identifier specifies which network a particular object is associated with. - type: object - required: - - blockchain - - network - properties: - blockchain: - type: string - example: bitcoin - network: - description: If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet. - type: string - example: mainnet - sub_network_identifier: - $ref: '#/components/schemas/SubNetworkIdentifier' - SubNetworkIdentifier: - description: In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains. - type: object - required: - - network - properties: - network: - type: string - example: shard 1 - metadata: - type: object - example: - producer: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' - BlockIdentifier: - description: The block_identifier uniquely identifies a block in a particular network. - type: object - required: - - index - - hash - properties: - index: - description: This is also known as the block height. - type: integer - format: int64 - example: 1123941 - hash: - type: string - example: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85' - description: This should be normalized according to the case specified in the block_hash_case network options. - PartialBlockIdentifier: - type: object - description: When fetching data by BlockIdentifier, it may be possible to only specify the index or hash. If neither property is specified, it is assumed that the client is making a request at the current block. - properties: - index: - type: integer - format: int64 - example: 1123941 - hash: - type: string - example: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85' - TransactionIdentifier: - description: The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool. - type: object - required: - - hash - properties: - hash: - description: 'Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier. This should be normalized according to the case specified in the transaction_hash_case in network options.' - type: string - example: '0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f' - OperationIdentifier: - description: The operation_identifier uniquely identifies an operation within a transaction. - type: object - required: - - index - properties: - index: - description: The operation index is used to ensure each operation has a unique identifier within a transaction. This index is only relative to the transaction and NOT GLOBAL. The operations in each transaction should start from index 0. To clarify, there may not be any notion of an operation index in the blockchain being described. - type: integer - format: int64 - minimum: 0 - example: 5 - network_index: - description: Some blockchains specify an operation index that is essential for client use. For example, Bitcoin uses a network_index to identify which UTXO was used in a transaction. network_index should not be populated if there is no notion of an operation index in a blockchain (typically most account-based blockchains). - type: integer - format: int64 - minimum: 0 - example: 0 - AccountIdentifier: - description: The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated). - type: object - required: - - address - properties: - address: - description: The address may be a cryptographic public key (or some encoding of it) or a provided username. - type: string - example: '0x3a065000ab4183c6bf581dc1e55a605455fc6d61' - sub_account: - $ref: '#/components/schemas/SubAccountIdentifier' - metadata: - $ref: '#/components/schemas/AccountIdentifierMetadata' - SubAccountIdentifier: - description: An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to. - type: object - required: - - address - properties: - address: - description: 'The SubAccount address may be a cryptographic value or some other identifier (ex: bonded) that uniquely specifies a SubAccount.' - type: string - example: '0x6b175474e89094c44da98b954eedeac495271d0f' - metadata: - $ref: '#/components/schemas/AccountIdentifierMetadata' - Block: - description: 'Blocks contain an array of Transactions that occurred at a particular BlockIdentifier. A hard requirement for blocks returned by Rosetta implementations is that they MUST be _inalterable_: once a client has requested and received a block identified by a specific BlockIndentifier, all future calls for that same BlockIdentifier must return the same block contents.' - type: object - required: - - block_identifier - - parent_block_identifier - - timestamp - - transactions - properties: - block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - parent_block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - timestamp: - $ref: '#/components/schemas/Timestamp' - transactions: - type: array - items: - $ref: '#/components/schemas/Transaction' - metadata: - $ref: '#/components/schemas/BlockMetadata' - Transaction: - description: Transactions contain an array of Operations that are attributable to the same TransactionIdentifier. - type: object - required: - - transaction_identifier - - operations - properties: - transaction_identifier: - $ref: '#/components/schemas/TransactionIdentifier' - operations: - type: array - items: - $ref: '#/components/schemas/Operation' - related_transactions: - type: array - items: - $ref: '#/components/schemas/RelatedTransaction' - metadata: - $ref: '#/components/schemas/TransactionMetadata' - Operation: - description: Operations contain all balance-changing information within a transaction. They are always one-sided (only affect 1 AccountIdentifier) and can succeed or fail independently from a Transaction. Operations are used both to represent on-chain data (Data API) and to construct new transactions (Construction API), creating a standard interface for reading and writing to blockchains. - type: object - required: - - operation_identifier - - type - properties: - operation_identifier: - $ref: '#/components/schemas/OperationIdentifier' - related_operations: - description: Restrict referenced related_operations to identifier indices < the current operation_identifier.index. This ensures there exists a clear DAG-structure of relations. Since operations are one-sided, one could imagine relating operations in a single transfer or linking operations in a call tree. - type: array - items: - $ref: '#/components/schemas/OperationIdentifier' - example: - - index: 1 - - index: 2 - type: - description: Type is the network-specific type of the operation. Ensure that any type that can be returned here is also specified in the NetworkOptionsResponse. This can be very useful to downstream consumers that parse all block data. - type: string - example: Transfer - status: - description: Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. On-chain operations (operations retrieved in the `/block` and `/block/transaction` endpoints) MUST have a populated status field (anything on-chain must have succeeded or failed). However, operations provided during transaction construction (often times called "intent" in the documentation) MUST NOT have a populated status field (operations yet to be included on-chain have not yet succeeded or failed). - type: string - example: Reverted - account: - $ref: '#/components/schemas/AccountIdentifier' - amount: - $ref: '#/components/schemas/Amount' - coin_change: - $ref: '#/components/schemas/CoinChange' - metadata: - $ref: '#/components/schemas/OperationMetadata' - Amount: - description: Amount is some Value of a Currency. It is considered invalid to specify a Value without a Currency. - type: object - required: - - value - - currency - properties: - value: - description: Value of the transaction in atomic units represented as an arbitrary-sized signed integer. For example, 1 BTC would be represented by a value of 100000000. - type: string - example: '1238089899992' - currency: - $ref: '#/components/schemas/Currency' - metadata: - type: object - Currency: - description: Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins). - type: object - required: - - symbol - - decimals - properties: - symbol: - description: Canonical symbol associated with a currency. - type: string - example: BTC - decimals: - description: Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10. - type: integer - format: int32 - minimum: 0 - example: 8 - metadata: - $ref: '#/components/schemas/CurrencyMetadata' - SyncStatus: - description: SyncStatus is used to provide additional context about an implementation's sync status. This object is often used by implementations to indicate healthiness when block data cannot be queried until some sync phase completes or cannot be determined by comparing the timestamp of the most recent block with the current time. - type: object - properties: - current_index: - description: CurrentIndex is the index of the last synced block in the current stage. This is a separate field from current_block_identifier in NetworkStatusResponse because blocks with indices up to and including the current_index may not yet be queryable by the caller. To reiterate, all indices up to and including current_block_identifier in NetworkStatusResponse must be queryable via the /block endpoint (excluding indices less than oldest_block_identifier). - type: integer - format: int64 - example: 100 - target_index: - description: TargetIndex is the index of the block that the implementation is attempting to sync to in the current stage. - type: integer - format: int64 - example: 150 - stage: - description: Stage is the phase of the sync process. - type: string - example: header sync - synced: - description: synced is a boolean that indicates if an implementation has synced up to the most recent block. If this field is not populated, the caller should rely on a traditional tip timestamp comparison to determine if an implementation is synced. This field is particularly useful for quiescent blockchains (blocks only produced when there are pending transactions). In these blockchains, the most recent block could have a timestamp far behind the current time but the node could be healthy and at tip. - type: boolean - Peer: - description: A Peer is a representation of a node's peer. - type: object - required: - - peer_id - properties: - peer_id: - type: string - example: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' - metadata: - type: object - Version: - description: The Version object is utilized to inform the client of the versions of different components of the Rosetta implementation. - type: object - required: - - rosetta_version - - node_version - properties: - rosetta_version: - description: The rosetta_version is the version of the Rosetta interface the implementation adheres to. This can be useful for clients looking to reliably parse responses. - type: string - example: 1.2.5 - node_version: - description: The node_version is the canonical version of the node runtime. This can help clients manage deployments. - type: string - example: 1.0.2 - middleware_version: - description: When a middleware server is used to adhere to the Rosetta interface, it should return its version here. This can help clients manage deployments. - type: string - example: 0.2.7 - metadata: - description: Any other information that may be useful about versioning of dependent services should be returned here. - type: object - Allow: - description: Allow specifies supported Operation status, Operation types, and all possible error statuses. This Allow object is used by clients to validate the correctness of a Rosetta Server implementation. It is expected that these clients will error if they receive some response that contains any of the above information that is not specified here. - type: object - required: - - operation_statuses - - operation_types - - errors - - historical_balance_lookup - - call_methods - - balance_exemptions - - mempool_coins - properties: - operation_statuses: - description: All Operation.Status this implementation supports. Any status that is returned during parsing that is not listed here will cause client validation to error. - type: array - items: - $ref: '#/components/schemas/OperationStatus' - operation_types: - description: All Operation.Type this implementation supports. Any type that is returned during parsing that is not listed here will cause client validation to error. - type: array - items: - type: string - example: TRANSFER - errors: - description: All Errors that this implementation could return. Any error that is returned during parsing that is not listed here will cause client validation to error. - type: array - items: - $ref: '#/components/schemas/Error' - historical_balance_lookup: - type: boolean - description: Any Rosetta implementation that supports querying the balance of an account at any height in the past should set this to true. - timestamp_start_index: - type: integer - format: int64 - minimum: 0 - description: If populated, `timestamp_start_index` indicates the first block index where block timestamps are considered valid (i.e. all blocks less than `timestamp_start_index` could have invalid timestamps). This is useful when the genesis block (or blocks) of a network have timestamp 0. If not populated, block timestamps are assumed to be valid for all available blocks. - call_methods: - type: array - description: All methods that are supported by the /call endpoint. Communicating which parameters should be provided to /call is the responsibility of the implementer (this is en lieu of defining an entire type system and requiring the implementer to define that in Allow). - items: - type: string - example: eth_call - balance_exemptions: - type: array - description: BalanceExemptions is an array of BalanceExemption indicating which account balances could change without a corresponding Operation. BalanceExemptions should be used sparingly as they may introduce significant complexity for integrators that attempt to reconcile all account balance changes. If your implementation relies on any BalanceExemptions, you MUST implement historical balance lookup (the ability to query an account balance at any BlockIdentifier). - items: - $ref: '#/components/schemas/BalanceExemption' - mempool_coins: - type: boolean - description: Any Rosetta implementation that can update an AccountIdentifier's unspent coins based on the contents of the mempool should populate this field as true. If false, requests to `/account/coins` that set `include_mempool` as true will be automatically rejected. - block_hash_case: - $ref: '#/components/schemas/Case' - description: This specifies the normalized case for block hash in the BlockIdentifier. If not specified, it's assumed to be case sensitive. - transaction_hash_case: - $ref: '#/components/schemas/Case' - description: This specifies the normalized case for transaction hash in the TransactionIdentifier. If not specified, it's assumed to be case sensitive. - OperationStatus: - description: OperationStatus is utilized to indicate which Operation status are considered successful. - type: object - required: - - status - - successful - properties: - status: - description: The status is the network-specific status of the operation. - type: string - successful: - description: An Operation is considered successful if the Operation.Amount should affect the Operation.Account. Some blockchains (like Bitcoin) only include successful operations in blocks but other blockchains (like Ethereum) include unsuccessful operations that incur a fee. To reconcile the computed balance from the stream of Operations, it is critical to understand which Operation.Status indicate an Operation is successful and should affect an Account. - type: boolean - example: - status: SUCCESS - successful: true - Timestamp: - description: The timestamp of the block in milliseconds since the Unix Epoch. The timestamp is stored in milliseconds because some blockchains produce blocks more often than once a second. - type: integer - format: int64 - minimum: 0 - example: 1582833600000 - PublicKey: - description: PublicKey contains a public key byte array for a particular CurveType encoded in hex. Note that there is no PrivateKey struct as this is NEVER the concern of an implementation. - type: object - required: - - hex_bytes - - curve_type - properties: - hex_bytes: - type: string - description: Hex-encoded public key bytes in the format specified by the CurveType. - curve_type: - $ref: '#/components/schemas/CurveType' - CurveType: - description: 'CurveType is the type of cryptographic curve associated with a PublicKey. * secp256k1: SEC compressed - `33 bytes` (https://secg.org/sec1-v2.pdf#subsubsection.2.3.3) * secp256k1_bip340: x-only - `32 bytes` (implicitly even `Y` coord. Secp256k1 compressed keys may be repurposed by dropping the first byte. (https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki#Public_Key_Generation)) * secp256r1: SEC compressed - `33 bytes` (https://secg.org/sec1-v2.pdf#subsubsection.2.3.3) * edwards25519: `y (255-bits) || x-sign-bit (1-bit)` - `32 bytes` (https://ed25519.cr.yp.to/ed25519-20110926.pdf) * tweedle: 1st pk : Fq.t (32 bytes) || 2nd pk : Fq.t (32 bytes) (https://github.com/CodaProtocol/coda/blob/develop/rfcs/0038-rosetta-construction-api.md#marshal-keys) * pallas: `x (255 bits) || y-parity-bit (1-bit) - 32 bytes` (https://github.com/zcash/pasta)' - type: string - enum: - - secp256k1 - - secp256k1_bip340 - - secp256r1 - - edwards25519 - - tweedle - - pallas - SigningPayload: - description: SigningPayload is signed by the client with the keypair associated with an AccountIdentifier using the specified SignatureType. SignatureType can be optionally populated if there is a restriction on the signature scheme that can be used to sign the payload. - type: object - required: - - hex_bytes - properties: - address: - type: string - description: '[DEPRECATED by `account_identifier` in `v1.4.4`] The network-specific address of the account that should sign the payload.' - account_identifier: - $ref: '#/components/schemas/AccountIdentifier' - hex_bytes: - type: string - description: Hex-encoded string of the payload bytes. - signature_type: - $ref: '#/components/schemas/SignatureType' - Signature: - description: Signature contains the payload that was signed, the public keys of the keypairs used to produce the signature, the signature (encoded in hex), and the SignatureType. PublicKey is often times not known during construction of the signing payloads but may be needed to combine signatures properly. - type: object - required: - - signing_payload - - public_key - - signature_type - - hex_bytes - properties: - signing_payload: - $ref: '#/components/schemas/SigningPayload' - public_key: - $ref: '#/components/schemas/PublicKey' - signature_type: - $ref: '#/components/schemas/SignatureType' - hex_bytes: - type: string - SignatureType: - description: 'SignatureType is the type of a cryptographic signature. * ecdsa: `r (32-bytes) || s (32-bytes)` - `64 bytes` * ecdsa_recovery: `r (32-bytes) || s (32-bytes) || v (1-byte)` - `65 bytes` * ed25519: `R (32-byte) || s (32-bytes)` - `64 bytes` * schnorr_1: `r (32-bytes) || s (32-bytes)` - `64 bytes` (schnorr signature implemented by Zilliqa where both `r` and `s` are scalars encoded as `32-bytes` values, most significant byte first.) * schnorr_bip340: `r (32-bytes) || s (32-bytes)` - `64 bytes` (sig = (bytes(R) || bytes((k + ed) mod n) where `r` is the `X` coordinate of a point `R` whose `Y` coordinate is even, most significant bytes first.) * schnorr_poseidon: `r (32-bytes) || s (32-bytes)` where s = Hash(1st pk || 2nd pk || r) - `64 bytes` (schnorr signature w/ Poseidon hash function implemented by O(1) Labs where both `r` and `s` are scalars encoded as `32-bytes` values, least significant byte first. https://github.com/CodaProtocol/signer-reference/blob/master/schnorr.ml )' - type: string - enum: - - ecdsa - - ecdsa_recovery - - ed25519 - - schnorr_1 - - schnorr_bip340 - - schnorr_poseidon - CoinAction: - description: CoinActions are different state changes that a Coin can undergo. When a Coin is created, it is coin_created. When a Coin is spent, it is coin_spent. It is assumed that a single Coin cannot be created or spent more than once. - type: string - enum: - - coin_created - - coin_spent - CoinIdentifier: - description: CoinIdentifier uniquely identifies a Coin. - type: object - required: - - identifier - properties: - identifier: - description: Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction_hash:index. - type: string - example: 0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f:1 - CoinChange: - description: CoinChange is used to represent a change in state of a some coin identified by a coin_identifier. This object is part of the Operation model and must be populated for UTXO-based blockchains. Coincidentally, this abstraction of UTXOs allows for supporting both account-based transfers and UTXO-based transfers on the same blockchain (when a transfer is account-based, don't populate this model). - type: object - required: - - coin_identifier - - coin_action - properties: - coin_identifier: - $ref: '#/components/schemas/CoinIdentifier' - coin_action: - $ref: '#/components/schemas/CoinAction' - Coin: - description: Coin contains its unique identifier and the amount it represents. - type: object - required: - - coin_identifier - - amount - properties: - coin_identifier: - $ref: '#/components/schemas/CoinIdentifier' - amount: - $ref: '#/components/schemas/Amount' - metadata: - $ref: '#/components/schemas/CoinMetadata' - BalanceExemption: - description: BalanceExemption indicates that the balance for an exempt account could change without a corresponding Operation. This typically occurs with staking rewards, vesting balances, and Currencies with a dynamic supply. Currently, it is possible to exempt an account from strict reconciliation by SubAccountIdentifier.Address or by Currency. This means that any account with SubAccountIdentifier.Address would be exempt or any balance of a particular Currency would be exempt, respectively. BalanceExemptions should be used sparingly as they may introduce significant complexity for integrators that attempt to reconcile all account balance changes. If your implementation relies on any BalanceExemptions, you MUST implement historical balance lookup (the ability to query an account balance at any BlockIdentifier). - type: object - properties: - sub_account_address: - description: SubAccountAddress is the SubAccountIdentifier.Address that the BalanceExemption applies to (regardless of the value of SubAccountIdentifier.Metadata). - type: string - example: staking - currency: - $ref: '#/components/schemas/Currency' - exemption_type: - $ref: '#/components/schemas/ExemptionType' - ExemptionType: - description: 'ExemptionType is used to indicate if the live balance for an account subject to a BalanceExemption could increase above, decrease below, or equal the computed balance. * greater_or_equal: The live balance may increase above or equal the computed balance. This typically occurs with staking rewards that accrue on each block. * less_or_equal: The live balance may decrease below or equal the computed balance. This typically occurs as balance moves from locked to spendable on a vesting account. * dynamic: The live balance may increase above, decrease below, or equal the computed balance. This typically occurs with tokens that have a dynamic supply.' - type: string - enum: - - greater_or_equal - - less_or_equal - - dynamic - BlockEvent: - description: BlockEvent represents the addition or removal of a BlockIdentifier from storage. Streaming BlockEvents allows lightweight clients to update their own state without needing to implement their own syncing logic. - type: object - required: - - sequence - - block_identifier - - type - properties: - sequence: - description: sequence is the unique identifier of a BlockEvent within the context of a NetworkIdentifier. - type: integer - format: int64 - minimum: 0 - example: 5 - block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - type: - $ref: '#/components/schemas/BlockEventType' - BlockEventType: - description: BlockEventType determines if a BlockEvent represents the addition or removal of a block. - type: string - enum: - - block_added - - block_removed - Operator: - description: Operator is used by query-related endpoints to determine how to apply conditions. If this field is not populated, the default `and` value will be used. - type: string - enum: - - or - - and - BlockTransaction: - description: BlockTransaction contains a populated Transaction and the BlockIdentifier that contains it. - type: object - required: - - block_identifier - - transaction - properties: - block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - transaction: - $ref: '#/components/schemas/Transaction' - RelatedTransaction: - description: The related_transaction allows implementations to link together multiple transactions. An unpopulated network identifier indicates that the related transaction is on the same network. - type: object - required: - - transaction_identifier - - direction - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - transaction_identifier: - $ref: '#/components/schemas/TransactionIdentifier' - direction: - $ref: '#/components/schemas/Direction' - Direction: - description: Used by RelatedTransaction to indicate the direction of the relation (i.e. cross-shard/cross-network sends may reference `backward` to an earlier transaction and async execution may reference `forward`). Can be used to indicate if a transaction relation is from child to parent or the reverse. - type: string - enum: - - forward - - backward - Case: - description: Case specifies the expected case for strings and hashes. - type: string - nullable: true - enum: - - upper_case - - lower_case - - case_sensitive - - null - default: case_sensitive - AccountBalanceRequest: - description: An AccountBalanceRequest is utilized to make a balance request on the /account/balance endpoint. If the block_identifier is populated, a historical balance query should be performed. - type: object - required: - - network_identifier - - account_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - account_identifier: - $ref: '#/components/schemas/AccountIdentifier' - block_identifier: - $ref: '#/components/schemas/PartialBlockIdentifier' - currencies: - type: array - description: In some cases, the caller may not want to retrieve all available balances for an AccountIdentifier. If the currencies field is populated, only balances for the specified currencies will be returned. If not populated, all available balances will be returned. - items: - $ref: '#/components/schemas/Currency' - AccountBalanceResponse: - description: 'An AccountBalanceResponse is returned on the /account/balance endpoint. If an account has a balance for each AccountIdentifier describing it (ex: an ERC-20 token balance on a few smart contracts), an account balance request must be made with each AccountIdentifier. The `coins` field was removed and replaced by by `/account/coins` in `v1.4.7`.' - type: object - required: - - block_identifier - - balances - properties: - block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - balances: - type: array - description: A single account may have a balance in multiple currencies. - items: - $ref: '#/components/schemas/Amount' - metadata: - description: Account-based blockchains that utilize a nonce or sequence number should include that number in the metadata. This number could be unique to the identifier or global across the account address. - type: object - example: - sequence_number: 23 - AccountCoinsRequest: - description: AccountCoinsRequest is utilized to make a request on the /account/coins endpoint. - type: object - required: - - network_identifier - - account_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - account_identifier: - $ref: '#/components/schemas/AccountIdentifier' - include_mempool: - type: boolean - default: false - description: Include state from the mempool when looking up an account's unspent coins. Note, using this functionality breaks any guarantee of idempotency. - currencies: - type: array - description: In some cases, the caller may not want to retrieve coins for all currencies for an AccountIdentifier. If the currencies field is populated, only coins for the specified currencies will be returned. If not populated, all unspent coins will be returned. - items: - $ref: '#/components/schemas/Currency' - AccountCoinsResponse: - description: AccountCoinsResponse is returned on the /account/coins endpoint and includes all unspent Coins owned by an AccountIdentifier. - type: object - required: - - block_identifier - - coins - properties: - block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - coins: - type: array - description: If a blockchain is UTXO-based, all unspent Coins owned by an account_identifier should be returned alongside the balance. It is highly recommended to populate this field so that users of the Rosetta API implementation don't need to maintain their own indexer to track their UTXOs. - items: - $ref: '#/components/schemas/Coin' - metadata: - description: Account-based blockchains that utilize a nonce or sequence number should include that number in the metadata. This number could be unique to the identifier or global across the account address. - type: object - example: - sequence_number: 23 - BlockRequest: - description: A BlockRequest is utilized to make a block request on the /block endpoint. - type: object - required: - - network_identifier - - block_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - block_identifier: - $ref: '#/components/schemas/PartialBlockIdentifier' - BlockResponse: - description: A BlockResponse includes a fully-populated block or a partially-populated block with a list of other transactions to fetch (other_transactions). As a result of the consensus algorithm of some blockchains, blocks can be omitted (i.e. certain block indices can be skipped). If a query for one of these omitted indices is made, the response should not include a `Block` object. It is VERY important to note that blocks MUST still form a canonical, connected chain of blocks where each block has a unique index. In other words, the `PartialBlockIdentifier` of a block after an omitted block should reference the last non-omitted block. - type: object - properties: - block: - $ref: '#/components/schemas/Block' - other_transactions: - description: 'Some blockchains may require additional transactions to be fetched that weren''t returned in the block response (ex: block only returns transaction hashes). For blockchains with a lot of transactions in each block, this can be very useful as consumers can concurrently fetch all transactions returned.' - type: array - items: - $ref: '#/components/schemas/TransactionIdentifier' - BlockTransactionRequest: - description: A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse. - type: object - required: - - network_identifier - - block_identifier - - transaction_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - transaction_identifier: - $ref: '#/components/schemas/TransactionIdentifier' - BlockTransactionResponse: - description: A BlockTransactionResponse contains information about a block transaction. - type: object - required: - - transaction - properties: - transaction: - $ref: '#/components/schemas/Transaction' - MempoolResponse: - description: A MempoolResponse contains all transaction identifiers in the mempool for a particular network_identifier. - type: object - required: - - transaction_identifiers - properties: - transaction_identifiers: - type: array - items: - $ref: '#/components/schemas/TransactionIdentifier' - MempoolTransactionRequest: - description: A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool. - type: object - required: - - network_identifier - - transaction_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - transaction_identifier: - $ref: '#/components/schemas/TransactionIdentifier' - MempoolTransactionResponse: - description: 'A MempoolTransactionResponse contains an estimate of a mempool transaction. It may not be possible to know the full impact of a transaction in the mempool (ex: fee paid).' - type: object - required: - - transaction - properties: - transaction: - $ref: '#/components/schemas/Transaction' - metadata: - type: object - example: - descendant_fees: 123923 - ancestor_count: 2 - MetadataRequest: - description: A MetadataRequest is utilized in any request where the only argument is optional metadata. - type: object - properties: - metadata: - type: object - NetworkListResponse: - description: A NetworkListResponse contains all NetworkIdentifiers that the node can serve information for. - type: object - required: - - network_identifiers - properties: - network_identifiers: - type: array - items: - $ref: '#/components/schemas/NetworkIdentifier' - NetworkRequest: - description: A NetworkRequest is utilized to retrieve some data specific exclusively to a NetworkIdentifier. - type: object - required: - - network_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - metadata: - type: object - NetworkStatusResponse: - description: NetworkStatusResponse contains basic information about the node's view of a blockchain network. It is assumed that any BlockIdentifier.Index less than or equal to CurrentBlockIdentifier.Index can be queried. If a Rosetta implementation prunes historical state, it should populate the optional `oldest_block_identifier` field with the oldest block available to query. If this is not populated, it is assumed that the `genesis_block_identifier` is the oldest queryable block. If a Rosetta implementation performs some pre-sync before it is possible to query blocks, sync_status should be populated so that clients can still monitor healthiness. Without this field, it may appear that the implementation is stuck syncing and needs to be terminated. - type: object - required: - - current_block_identifier - - current_block_timestamp - - genesis_block_identifier - properties: - current_block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - current_block_timestamp: - $ref: '#/components/schemas/Timestamp' - genesis_block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - oldest_block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - sync_status: - $ref: '#/components/schemas/SyncStatus' - peers: - type: array - items: - $ref: '#/components/schemas/Peer' - NetworkOptionsResponse: - description: NetworkOptionsResponse contains information about the versioning of the node and the allowed operation statuses, operation types, and errors. - type: object - required: - - version - - allow - properties: - version: - $ref: '#/components/schemas/Version' - allow: - $ref: '#/components/schemas/Allow' - ConstructionMetadataRequest: - description: A ConstructionMetadataRequest is utilized to get information required to construct a transaction. The Options object used to specify which metadata to return is left purposely unstructured to allow flexibility for implementers. Options is not required in the case that there is network-wide metadata of interest. Optionally, the request can also include an array of PublicKeys associated with the AccountIdentifiers returned in ConstructionPreprocessResponse. - type: object - required: - - network_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - options: - $ref: '#/components/schemas/ConstructionMetadataRequestOption' - public_keys: - type: array - items: - $ref: '#/components/schemas/PublicKey' - ConstructionMetadataResponse: - description: The ConstructionMetadataResponse returns network-specific metadata used for transaction construction. Optionally, the implementer can return the suggested fee associated with the transaction being constructed. The caller may use this info to adjust the intent of the transaction or to create a transaction with a different account that can pay the suggested fee. Suggested fee is an array in case fee payment must occur in multiple currencies. - type: object - required: - - metadata - properties: - metadata: - $ref: '#/components/schemas/ConstructionMetadataResponseMetadata' - suggested_fee: - type: array - items: - $ref: '#/components/schemas/Amount' - ConstructionDeriveRequest: - description: ConstructionDeriveRequest is passed to the `/construction/derive` endpoint. Network is provided in the request because some blockchains have different address formats for different networks. Metadata is provided in the request because some blockchains allow for multiple address types (i.e. different address for validators vs normal accounts). - type: object - required: - - network_identifier - - public_key - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - public_key: - $ref: '#/components/schemas/PublicKey' - metadata: - $ref: '#/components/schemas/ConstructionDeriveMetadata' - ConstructionDeriveResponse: - description: ConstructionDeriveResponse is returned by the `/construction/derive` endpoint. - type: object - properties: - address: - type: string - description: '[DEPRECATED by `account_identifier` in `v1.4.4`] Address in network-specific format.' - account_identifier: - $ref: '#/components/schemas/AccountIdentifier' - metadata: - type: object - ConstructionPreprocessRequest: - description: ConstructionPreprocessRequest is passed to the `/construction/preprocess` endpoint so that a Rosetta implementation can determine which metadata it needs to request for construction. Metadata provided in this object should NEVER be a product of live data (i.e. the caller must follow some network-specific data fetching strategy outside of the Construction API to populate required Metadata). If live data is required for construction, it MUST be fetched in the call to `/construction/metadata`. - type: object - required: - - network_identifier - - operations - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - operations: - type: array - items: - $ref: '#/components/schemas/Operation' - metadata: - $ref: '#/components/schemas/ConstructionPreprocessMetadata' - ConstructionPreprocessResponse: - description: ConstructionPreprocessResponse contains `options` that will be sent unmodified to `/construction/metadata`. If it is not necessary to make a request to `/construction/metadata`, `options` should be omitted. Some blockchains require the PublicKey of particular AccountIdentifiers to construct a valid transaction. To fetch these PublicKeys, populate `required_public_keys` with the AccountIdentifiers associated with the desired PublicKeys. If it is not necessary to retrieve any PublicKeys for construction, `required_public_keys` should be omitted. - type: object - properties: - options: - type: object - description: The options that will be sent directly to `/construction/metadata` by the caller. - required_public_keys: - type: array - items: - $ref: '#/components/schemas/AccountIdentifier' - ConstructionPayloadsRequest: - description: ConstructionPayloadsRequest is the request to `/construction/payloads`. It contains the network, a slice of operations, and arbitrary metadata that was returned by the call to `/construction/metadata`. Optionally, the request can also include an array of PublicKeys associated with the AccountIdentifiers returned in ConstructionPreprocessResponse. - type: object - required: - - network_identifier - - operations - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - operations: - type: array - items: - $ref: '#/components/schemas/Operation' - metadata: - $ref: '#/components/schemas/ConstructionPayloadsRequestMetadata' - public_keys: - type: array - items: - $ref: '#/components/schemas/PublicKey' - ConstructionPayloadsResponse: - description: ConstructionTransactionResponse is returned by `/construction/payloads`. It contains an unsigned transaction blob (that is usually needed to construct the a network transaction from a collection of signatures) and an array of payloads that must be signed by the caller. - type: object - required: - - unsigned_transaction - - payloads - properties: - unsigned_transaction: - type: string - payloads: - type: array - items: - $ref: '#/components/schemas/SigningPayload' - ConstructionCombineRequest: - description: ConstructionCombineRequest is the input to the `/construction/combine` endpoint. It contains the unsigned transaction blob returned by `/construction/payloads` and all required signatures to create a network transaction. - type: object - required: - - network_identifier - - unsigned_transaction - - signatures - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - unsigned_transaction: - type: string - signatures: - type: array - items: - $ref: '#/components/schemas/Signature' - ConstructionCombineResponse: - description: ConstructionCombineResponse is returned by `/construction/combine`. The network payload will be sent directly to the `construction/submit` endpoint. - type: object - required: - - signed_transaction - properties: - signed_transaction: - type: string - ConstructionParseRequest: - description: ConstructionParseRequest is the input to the `/construction/parse` endpoint. It allows the caller to parse either an unsigned or signed transaction. - type: object - required: - - network_identifier - - signed - - transaction - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - signed: - type: boolean - description: Signed is a boolean indicating whether the transaction is signed. - transaction: - type: string - description: This must be either the unsigned transaction blob returned by `/construction/payloads` or the signed transaction blob returned by `/construction/combine`. - ConstructionParseResponse: - description: ConstructionParseResponse contains an array of operations that occur in a transaction blob. This should match the array of operations provided to `/construction/preprocess` and `/construction/payloads`. - type: object - required: - - operations - properties: - operations: - type: array - items: - $ref: '#/components/schemas/Operation' - signers: - description: '[DEPRECATED by `account_identifier_signers` in `v1.4.4`] All signers (addresses) of a particular transaction. If the transaction is unsigned, it should be empty.' - type: array - items: - type: string - account_identifier_signers: - type: array - items: - $ref: '#/components/schemas/AccountIdentifier' - metadata: - type: object - ConstructionHashRequest: - description: ConstructionHashRequest is the input to the `/construction/hash` endpoint. - type: object - required: - - network_identifier - - signed_transaction - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - signed_transaction: - type: string - ConstructionSubmitRequest: - description: The transaction submission request includes a signed transaction. - type: object - required: - - network_identifier - - signed_transaction - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - signed_transaction: - type: string - TransactionIdentifierResponse: - description: TransactionIdentifierResponse contains the transaction_identifier of a transaction that was submitted to either `/construction/hash` or `/construction/submit`. - type: object - required: - - transaction_identifier - properties: - transaction_identifier: - $ref: '#/components/schemas/TransactionIdentifier' - metadata: - type: object - CallRequest: - description: CallRequest is the input to the `/call` endpoint. - type: object - required: - - network_identifier - - method - - parameters - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - method: - type: string - description: Method is some network-specific procedure call. This method could map to a network-specific RPC endpoint, a method in an SDK generated from a smart contract, or some hybrid of the two. The implementation must define all available methods in the Allow object. However, it is up to the caller to determine which parameters to provide when invoking `/call`. - example: eth_call - parameters: - type: object - description: Parameters is some network-specific argument for a method. It is up to the caller to determine which parameters to provide when invoking `/call`. - example: - block_number: 23 - address: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' - CallResponse: - description: CallResponse contains the result of a `/call` invocation. - type: object - required: - - result - - idempotent - properties: - result: - type: object - description: Result contains the result of the `/call` invocation. This result will not be inspected or interpreted by Rosetta tooling and is left to the caller to decode. - example: - count: 1000 - idempotent: - type: boolean - description: Idempotent indicates that if `/call` is invoked with the same CallRequest again, at any point in time, it will return the same CallResponse. Integrators may cache the CallResponse if this is set to true to avoid making unnecessary calls to the Rosetta implementation. For this reason, implementers should be very conservative about returning true here or they could cause issues for the caller. - EventsBlocksRequest: - description: EventsBlocksRequest is utilized to fetch a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. - type: object - required: - - network_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - offset: - description: offset is the offset into the event stream to sync events from. If this field is not populated, we return the limit events backwards from tip. If this is set to 0, we start from the beginning. - type: integer - format: int64 - minimum: 0 - example: 5 - limit: - description: limit is the maximum number of events to fetch in one call. The implementation may return <= limit events. - type: integer - format: int64 - minimum: 0 - example: 5 - EventsBlocksResponse: - description: EventsBlocksResponse contains an ordered collection of BlockEvents and the max retrievable sequence. - type: object - required: - - max_sequence - - events - properties: - max_sequence: - description: max_sequence is the maximum available sequence number to fetch. - type: integer - format: int64 - minimum: 0 - example: 5 - events: - type: array - description: events is an array of BlockEvents indicating the order to add and remove blocks to maintain a canonical view of blockchain state. Lightweight clients can use this event stream to update state without implementing their own block syncing logic. - items: - $ref: '#/components/schemas/BlockEvent' - SearchTransactionsRequest: - description: SearchTransactionsRequest is used to search for transactions matching a set of provided conditions in canonical blocks. - type: object - required: - - network_identifier - properties: - network_identifier: - $ref: '#/components/schemas/NetworkIdentifier' - operator: - $ref: '#/components/schemas/Operator' - max_block: - description: max_block is the largest block index to consider when searching for transactions. If this field is not populated, the current block is considered the max_block. If you do not specify a max_block, it is possible a newly synced block will interfere with paginated transaction queries (as the offset could become invalid with newly added rows). - type: integer - format: int64 - minimum: 0 - example: 5 - offset: - description: offset is the offset into the query result to start returning transactions. If any search conditions are changed, the query offset will change and you must restart your search iteration. - type: integer - format: int64 - minimum: 0 - example: 5 - limit: - description: limit is the maximum number of transactions to return in one call. The implementation may return <= limit transactions. - type: integer - format: int64 - minimum: 0 - example: 5 - block_identifier: - $ref: '#/components/schemas/BlockIdentifier' - transaction_identifier: - $ref: '#/components/schemas/TransactionIdentifier' - account_identifier: - $ref: '#/components/schemas/AccountIdentifier' - coin_identifier: - $ref: '#/components/schemas/CoinIdentifier' - currency: - $ref: '#/components/schemas/Currency' - status: - type: string - description: status is the network-specific operation type. - example: reverted - type: - type: string - description: type is the network-specific operation type. - example: transfer - address: - type: string - description: address is AccountIdentifier.Address. This is used to get all transactions related to an AccountIdentifier.Address, regardless of SubAccountIdentifier. - example: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347' - success: - type: boolean - description: success is a synthetic condition populated by parsing network-specific operation statuses (using the mapping provided in `/network/options`). - SearchTransactionsResponse: - description: SearchTransactionsResponse contains an ordered collection of BlockTransactions that match the query in SearchTransactionsRequest. These BlockTransactions are sorted from most recent block to oldest block. - type: object - required: - - transactions - - total_count - properties: - transactions: - type: array - description: transactions is an array of BlockTransactions sorted by most recent BlockIdentifier (meaning that transactions in recent blocks appear first). If there are many transactions for a particular search, transactions may not contain all matching transactions. It is up to the caller to paginate these transactions using the max_block field. - items: - $ref: '#/components/schemas/BlockTransaction' - total_count: - description: total_count is the number of results for a given search. Callers typically use this value to concurrently fetch results by offset or to display a virtual page number associated with results. - type: integer - format: int64 - minimum: 0 - example: 5 - next_offset: - description: next_offset is the next offset to use when paginating through transaction results. If this field is not populated, there are no more transactions to query. - type: integer - format: int64 - minimum: 0 - example: 5 - Error: - description: Instead of utilizing HTTP status codes to describe node errors (which often do not have a good analog), rich errors are returned using this object. Both the code and message fields can be individually used to correctly identify an error. Implementations MUST use unique values for both fields. - type: object - required: - - code - - message - - retriable - properties: - code: - description: Code is a network-specific error code. If desired, this code can be equivalent to an HTTP status code. - type: integer - format: int32 - minimum: 0 - example: 12 - message: - description: Message is a network-specific error message. The message MUST NOT change for a given code. In particular, this means that any contextual information should be included in the details field. - type: string - example: Invalid account format - description: - description: Description allows the implementer to optionally provide additional information about an error. In many cases, the content of this field will be a copy-and-paste from existing developer documentation. Description can ONLY be populated with generic information about a particular type of error. It MUST NOT be populated with information about a particular instantiation of an error (use `details` for this). Whereas the content of Error.Message should stay stable across releases, the content of Error.Description will likely change across releases (as implementers improve error documentation). For this reason, the content in this field is not part of any type assertion (unlike Error.Message). - type: string - example: This error is returned when the requested AccountIdentifier is improperly formatted. - retriable: - description: An error is retriable if the same request may succeed if submitted again. - type: boolean - details: - type: object - description: Often times it is useful to return context specific to the request that caused the error (i.e. a sample of the stack trace or impacted account) in addition to the standard error message. - example: - address: '0x1dcc4de8dec75d7aab85b567b6' - error: not base64 - BlockMetadata: - description: BlockMetadata is used to provide any additional data needed for a Block. It is important to populate this object with any data a consumer will need to fully understand a Block. - type: object - properties: - transactionsCount: - description: transactionCount - type: integer - format: int64 - createdBy: - description: createdBy - type: string - size: - description: size - type: integer - epochNo: - description: epochNo - type: integer - slotNo: - description: slotNo - type: integer - format: int64 - TransactionMetadata: - description: Transactions that are related to other transactions (like a cross-shard transaction) should include the tranaction_identifier of these transactions in the metadata. - type: object - properties: - size: - description: Size is the size of the transaction in bytes. - type: integer - format: int64 - scriptSize: - description: ScriptSize is the size of the transaction script in bytes. - type: integer - format: int64 - example: - size: 12378 - lockTime: 1582272577 - OperationMetadata: - description: OperationMetadata is used to provide any additional data needed for an Operation. It is important to populate this object with any data a consumer will need to fully understand an Operation. - type: object - properties: - withdrawalAmount: - description: WithdrawalAmount is the amount of funds withdrawn from an account. This field should only be populated if the operation is a withdrawal. - $ref: '#/components/schemas/Amount' - depositAmount: - description: DepositAmount is the amount of funds deposited into an account. This field should only be populated if the operation is a deposit. - $ref: '#/components/schemas/Amount' - refundAmount: - description: RefundAmount is the amount of funds refunded to an account. This field should only be populated if the operation is a refund. - $ref: '#/components/schemas/Amount' - staking_credential: - $ref: '#/components/schemas/PublicKey' - pool_key_hash: - description: Pool key as hex bytes. - type: string - drep: - description: DRep - $ref: '#/components/schemas/DRepParams' - epoch: - description: Epoch - type: integer - tokenBundle: - description: TokenBundle - type: array - items: - $ref: '#/components/schemas/TokenBundleItem' - poolRegistrationCert: - description: PoolRegistrationCert - type: string - poolRegistrationParams: - $ref: '#/components/schemas/PoolRegistrationParams' - voteRegistrationMetadata: - $ref: '#/components/schemas/VoteRegistrationMetadata' - VoteRegistrationMetadata: - description: VoteRegistrationMetadata - type: object - properties: - stakeKey: - description: VotePublicKey - $ref: '#/components/schemas/PublicKey' - votingkey: - description: votingkey - $ref: '#/components/schemas/PublicKey' - rewardAddress: - description: rewardAddress - type: string - votingNonce: - description: votingNonce - type: integer - votingSignature: - description: votingSignature - type: string - TokenBundleItem: - description: TokenBundleItem - type: object - properties: - policyId: - description: PolicyId - type: string - tokens: - description: Tokens - type: array - items: - $ref: '#/components/schemas/Amount' - DRepTypeParams: - description: DRepTypeParams - type: string - enum: - - key_hash - - script_hash - - no_confidence - - abstain - DRepParams: - description: DRep - type: object - properties: - id: - description: DRepId - type: string - type: - description: DRepType - $ref: '#/components/schemas/DRepTypeParams' - PoolRegistrationParams: - description: PoolRegistrationParams - type: object - properties: - vrfKeyHash: - description: VrfKeyHash - type: string - rewardAddress: - description: RewardAddress - type: string - pledge: - description: Pledge - type: string - cost: - description: Cost - type: string - poolOwners: - description: PoolOwners - type: array - items: - type: string - relays: - description: Relays - type: array - items: - $ref: '#/components/schemas/Relay' - margin: - description: Margin - $ref: '#/components/schemas/PoolMargin' - marginPercentage: - description: MarginPercentage - type: string - poolMetadata: - description: PoolMetadata - $ref: '#/components/schemas/PoolMetadata' - PoolMetadata: - description: PoolMetadata - type: object - properties: - url: - description: url - type: string - hash: - description: hash - type: string - Relay: - description: Relay - type: object - properties: - ipv4: - description: Ipv4 - type: string - ipv6: - description: Ipv6 - type: string - dnsName: - description: DnsName - type: string - port: - description: Port - type: integer - type: - description: Type - type: string - PoolMargin: - description: PoolMargin - type: object - properties: - numerator: - description: Numerator - type: string - denominator: - description: Denominator - type: string - ConstructionDeriveMetadata: - description: ConstructionDeriveMetadata is returned by `/construction/derive` and contains any network-specific metadata that is needed to derive an account identifier. This metadata should be a product of live data (i.e. the caller must follow some network-specific data fetching strategy outside of the Construction API to populate required Metadata). If live data is required for construction, it MUST be fetched in the call to `/construction/metadata`. - type: object - properties: - address_type: - type: string - description: AddressType is the type of address that will be derived from the PublicKey. This field is used to indicate that a PublicKey is associated with a particular address type. If this field is not populated, it is assumed that the PublicKey is associated with the default address type for the network. - staking_credential: - $ref: '#/components/schemas/PublicKey' - StakingCredential: - description: StakingCredential contains the staking key hash of a staking key. - type: object - properties: - hex_bytes: - type: string - description: Hex-encoded staking key hash. - curve_type: - $ref: '#/components/schemas/CurveType' - ConstructionPreprocessMetadata: - description: ConstructionPreprocessMetadata is returned by `/construction/preprocess` and contains any network-specific metadata that is needed to construct a valid transaction. This metadata should be a product of live data (i.e. the caller must follow some network-specific data fetching strategy outside of the Construction API to populate required Metadata). If live data is required for construction, it MUST be fetched in the call to `/construction/metadata`. - type: object - properties: - relative_ttl: - type: integer - description: Relative TTL is the TTL of the transaction in the mempool in seconds. If the transaction is not included in a block before this time, it may be evicted from the mempool. - deposit_parameters: - $ref: '#/components/schemas/DepositParameters' - DepositParameters: - description: DepositParameters contains all of the information needed to construct a deposit transaction. - type: object - properties: - keyDeposit: - type: string - description: KeyDeposit is the amount of funds that are needed for registering a stake key. - poolDeposit: - type: string - description: PoolDeposit is the amount of funds that are needed to register a pool. - ConstructionPayloadsRequestMetadata: - description: ConstructionPayloadsRequestMetadata - type: object - properties: - ttl: - description: Ttl is the TTL of the transaction in the mempool in seconds. If the transaction is not included in a block before this time, it may be evicted from the mempool. - type: integer - protocol_parameters: - $ref: '#/components/schemas/ProtocolParameters' - ProtocolParameters: - description: Protocolparameters defining the current parameters of a blockchain protocol. For example how much to deposit for a pool registration. - type: object - properties: - coinsPerUtxoSize: - type: string - description: coinsperutxosize - maxTxSize: - type: integer - description: Maximum size of a transaction in bytes. - maxValSize: - type: integer - format: int64 - description: Maximum size of a value in bytes. - keyDeposit: - type: string - description: KeyDeposit is the amount of funds that are needed for registering a stake key. - maxCollateralInputs: - type: integer - description: Maximum number of collateral inputs. - minFeeCoefficient: - type: integer - description: Minimum fee coefficient. - minFeeConstant: - type: integer - description: '' - minPoolCost: - type: string - description: Minimum pool cost. - poolDeposit: - type: string - description: PoolDeposit is the amount of funds that are needed to register a pool. - protocol: - type: integer - description: Protocol magic. - AccountIdentifierMetadata: - description: AccountIdentifierMetadata - type: object - properties: - chain_code: - description: 'ChainCode ' - type: string - CurrencyMetadata: - description: '' - type: object - properties: - policyId: - description: '' - type: string - ConstructionMetadataRequestOption: - description: '' - type: object - properties: - relative_ttl: - description: '' - type: number - transaction_size: - description: '' - type: number - ConstructionMetadataResponseMetadata: - description: '' - type: object - properties: - ttl: - description: '' - type: number - protocol_parameters: - $ref: '#/components/schemas/ProtocolParameters' - CoinMetadata: - description: CoinMetadata is used to provide additional data for a Coin object. It is often used to store human-readable information that a client can use to display information to a user. - type: object - additionalProperties: - type: array - items: - $ref: '#/components/schemas/CoinTokens' - CoinTokens: - description: | - CoinTokens contains the policyId and the tokens - it represents. - type: object - required: - - policyId - - tokens - properties: - policyId: - type: string - tokens: - type: array - items: - $ref: '#/components/schemas/Amount' From 70dc5a187238e71edf1c56d6503f7a6940314e92 Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Wed, 7 May 2025 21:54:07 -0300 Subject: [PATCH 04/13] chore: update dependencies in package.json and yarn.lock --- docs/package.json | 2 +- docs/yarn.lock | 1292 ++------------------------------------------- 2 files changed, 37 insertions(+), 1257 deletions(-) diff --git a/docs/package.json b/docs/package.json index a5fdb1989f..161ddf10d4 100644 --- a/docs/package.json +++ b/docs/package.json @@ -19,7 +19,7 @@ "@docusaurus/preset-classic": "3.7.0", "@docusaurus/theme-mermaid": "^3.7.0", "@mdx-js/react": "^3.0.0", - "@scalar/docusaurus": "^0.6.3", + "@scalar/docusaurus": "^0.6.5", "clsx": "^2.0.0", "prism-react-renderer": "^2.3.0", "react": "^19.0.0", diff --git a/docs/yarn.lock b/docs/yarn.lock index d811944f73..361a346a86 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -363,7 +363,7 @@ "@babel/template" "^7.26.9" "@babel/types" "^7.26.10" -"@babel/parser@^7.25.3", "@babel/parser@^7.26.10", "@babel/parser@^7.26.9": +"@babel/parser@^7.26.10", "@babel/parser@^7.26.9": version "7.26.10" resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.26.10.tgz#e9bdb82f14b97df6569b0b038edd436839c57749" integrity sha512-6aQR2zGE/QFi8JpDLjUZEPYOs7+mhKXm86VaKFiLP35JQwQb6bwUE+XbvkH0EptsYhbNBSUGaUBLKqxH1xSgsA== @@ -1101,144 +1101,6 @@ resolved "https://registry.yarnpkg.com/@chevrotain/utils/-/utils-11.0.3.tgz#e39999307b102cff3645ec4f5b3665f5297a2224" integrity sha512-YslZMgtJUyuMbZ+aKvfF3x1f5liK4mWNxghFRv7jqRR9C3R3fAOGTTKvxXDa2Y1s9zSbcpuO0cAxDYsc9SrXoQ== -"@codemirror/autocomplete@^6.0.0", "@codemirror/autocomplete@^6.18.3": - version "6.18.6" - resolved "https://registry.yarnpkg.com/@codemirror/autocomplete/-/autocomplete-6.18.6.tgz#de26e864a1ec8192a1b241eb86addbb612964ddb" - integrity sha512-PHHBXFomUs5DF+9tCOM/UoW6XQ4R44lLNNhRaW9PKPTU0D7lIjRg3ElxaJnTwsl/oHiR93WSXDBrekhoUGCPtg== - dependencies: - "@codemirror/language" "^6.0.0" - "@codemirror/state" "^6.0.0" - "@codemirror/view" "^6.17.0" - "@lezer/common" "^1.0.0" - -"@codemirror/commands@^6.0.0", "@codemirror/commands@^6.7.1": - version "6.8.0" - resolved "https://registry.yarnpkg.com/@codemirror/commands/-/commands-6.8.0.tgz#92f200b66f852939bd6ebb90d48c2d9e9c813d64" - integrity sha512-q8VPEFaEP4ikSlt6ZxjB3zW72+7osfAYW9i8Zu943uqbKuz6utc1+F170hyLUCUltXORjQXRyYQNfkckzA/bPQ== - dependencies: - "@codemirror/language" "^6.0.0" - "@codemirror/state" "^6.4.0" - "@codemirror/view" "^6.27.0" - "@lezer/common" "^1.1.0" - -"@codemirror/lang-css@^6.0.0", "@codemirror/lang-css@^6.3.1": - version "6.3.1" - resolved "https://registry.yarnpkg.com/@codemirror/lang-css/-/lang-css-6.3.1.tgz#763ca41aee81bb2431be55e3cfcc7cc8e91421a3" - integrity sha512-kr5fwBGiGtmz6l0LSJIbno9QrifNMUusivHbnA1H6Dmqy4HZFte3UAICix1VuKo0lMPKQr2rqB+0BkKi/S3Ejg== - dependencies: - "@codemirror/autocomplete" "^6.0.0" - "@codemirror/language" "^6.0.0" - "@codemirror/state" "^6.0.0" - "@lezer/common" "^1.0.2" - "@lezer/css" "^1.1.7" - -"@codemirror/lang-html@^6.4.8": - version "6.4.9" - resolved "https://registry.yarnpkg.com/@codemirror/lang-html/-/lang-html-6.4.9.tgz#d586f2cc9c341391ae07d1d7c545990dfa069727" - integrity sha512-aQv37pIMSlueybId/2PVSP6NPnmurFDVmZwzc7jszd2KAF8qd4VBbvNYPXWQq90WIARjsdVkPbw29pszmHws3Q== - dependencies: - "@codemirror/autocomplete" "^6.0.0" - "@codemirror/lang-css" "^6.0.0" - "@codemirror/lang-javascript" "^6.0.0" - "@codemirror/language" "^6.4.0" - "@codemirror/state" "^6.0.0" - "@codemirror/view" "^6.17.0" - "@lezer/common" "^1.0.0" - "@lezer/css" "^1.1.0" - "@lezer/html" "^1.3.0" - -"@codemirror/lang-javascript@^6.0.0": - version "6.2.3" - resolved "https://registry.yarnpkg.com/@codemirror/lang-javascript/-/lang-javascript-6.2.3.tgz#d705c359dc816afcd3bcdf120a559f83d31d4cda" - integrity sha512-8PR3vIWg7pSu7ur8A07pGiYHgy3hHj+mRYRCSG8q+mPIrl0F02rgpGv+DsQTHRTc30rydOsf5PZ7yjKFg2Ackw== - dependencies: - "@codemirror/autocomplete" "^6.0.0" - "@codemirror/language" "^6.6.0" - "@codemirror/lint" "^6.0.0" - "@codemirror/state" "^6.0.0" - "@codemirror/view" "^6.17.0" - "@lezer/common" "^1.0.0" - "@lezer/javascript" "^1.0.0" - -"@codemirror/lang-json@^6.0.0": - version "6.0.1" - resolved "https://registry.yarnpkg.com/@codemirror/lang-json/-/lang-json-6.0.1.tgz#0a0be701a5619c4b0f8991f9b5e95fe33f462330" - integrity sha512-+T1flHdgpqDDlJZ2Lkil/rLiRy684WMLc74xUnjJH48GQdfJo/pudlTRreZmKwzP8/tGdKf83wlbAdOCzlJOGQ== - dependencies: - "@codemirror/language" "^6.0.0" - "@lezer/json" "^1.0.0" - -"@codemirror/lang-xml@^6.0.0": - version "6.1.0" - resolved "https://registry.yarnpkg.com/@codemirror/lang-xml/-/lang-xml-6.1.0.tgz#e3e786e1a89fdc9520efe75c1d6d3de1c40eb91c" - integrity sha512-3z0blhicHLfwi2UgkZYRPioSgVTo9PV5GP5ducFH6FaHy0IAJRg+ixj5gTR1gnT/glAIC8xv4w2VL1LoZfs+Jg== - dependencies: - "@codemirror/autocomplete" "^6.0.0" - "@codemirror/language" "^6.4.0" - "@codemirror/state" "^6.0.0" - "@codemirror/view" "^6.0.0" - "@lezer/common" "^1.0.0" - "@lezer/xml" "^1.0.0" - -"@codemirror/lang-yaml@^6.1.2": - version "6.1.2" - resolved "https://registry.yarnpkg.com/@codemirror/lang-yaml/-/lang-yaml-6.1.2.tgz#c84280c68fa7af456a355d91183b5e537e9b7038" - integrity sha512-dxrfG8w5Ce/QbT7YID7mWZFKhdhsaTNOYjOkSIMt1qmC4VQnXSDSYVHHHn8k6kJUfIhtLo8t1JJgltlxWdsITw== - dependencies: - "@codemirror/autocomplete" "^6.0.0" - "@codemirror/language" "^6.0.0" - "@codemirror/state" "^6.0.0" - "@lezer/common" "^1.2.0" - "@lezer/highlight" "^1.2.0" - "@lezer/lr" "^1.0.0" - "@lezer/yaml" "^1.0.0" - -"@codemirror/language@^6.0.0", "@codemirror/language@^6.10.7", "@codemirror/language@^6.4.0", "@codemirror/language@^6.6.0": - version "6.11.0" - resolved "https://registry.yarnpkg.com/@codemirror/language/-/language-6.11.0.tgz#5ae90972601497f4575f30811519d720bf7232c9" - integrity sha512-A7+f++LodNNc1wGgoRDTt78cOwWm9KVezApgjOMp1W4hM0898nsqBXwF+sbePE7ZRcjN7Sa1Z5m2oN27XkmEjQ== - dependencies: - "@codemirror/state" "^6.0.0" - "@codemirror/view" "^6.23.0" - "@lezer/common" "^1.1.0" - "@lezer/highlight" "^1.0.0" - "@lezer/lr" "^1.0.0" - style-mod "^4.0.0" - -"@codemirror/lint@^6.0.0", "@codemirror/lint@^6.8.4": - version "6.8.4" - resolved "https://registry.yarnpkg.com/@codemirror/lint/-/lint-6.8.4.tgz#7d8aa5d1a6dec89ffcc23ad45ddca2e12e90982d" - integrity sha512-u4q7PnZlJUojeRe8FJa/njJcMctISGgPQ4PnWsd9268R4ZTtU+tfFYmwkBvgcrK2+QQ8tYFVALVb5fVJykKc5A== - dependencies: - "@codemirror/state" "^6.0.0" - "@codemirror/view" "^6.35.0" - crelt "^1.0.5" - -"@codemirror/search@^6.0.0": - version "6.5.10" - resolved "https://registry.yarnpkg.com/@codemirror/search/-/search-6.5.10.tgz#7367bfc88094d078b91c752bc74140fb565b55ee" - integrity sha512-RMdPdmsrUf53pb2VwflKGHEe1XVM07hI7vV2ntgw1dmqhimpatSJKva4VA9h4TLUDOD4EIF02201oZurpnEFsg== - dependencies: - "@codemirror/state" "^6.0.0" - "@codemirror/view" "^6.0.0" - crelt "^1.0.5" - -"@codemirror/state@^6.0.0", "@codemirror/state@^6.4.0", "@codemirror/state@^6.5.0": - version "6.5.2" - resolved "https://registry.yarnpkg.com/@codemirror/state/-/state-6.5.2.tgz#8eca3a64212a83367dc85475b7d78d5c9b7076c6" - integrity sha512-FVqsPqtPWKVVL3dPSxy8wEF/ymIEuVzF1PK3VbUgrxXpJUSHQWWZz4JMToquRxnkw+36LTamCZG2iua2Ptq0fA== - dependencies: - "@marijn/find-cluster-break" "^1.0.0" - -"@codemirror/view@^6.0.0", "@codemirror/view@^6.17.0", "@codemirror/view@^6.23.0", "@codemirror/view@^6.27.0", "@codemirror/view@^6.35.0", "@codemirror/view@^6.35.3": - version "6.36.4" - resolved "https://registry.yarnpkg.com/@codemirror/view/-/view-6.36.4.tgz#d47d38b92a22cc40647bfb9cc97944e13d44942d" - integrity sha512-ZQ0V5ovw/miKEXTvjgzRyjnrk9TwriUB1k4R5p7uNnHR9Hus+D1SXHGdJshijEzPFjU25xea/7nhIeSqYFKdbA== - dependencies: - "@codemirror/state" "^6.5.0" - style-mod "^4.1.0" - w3c-keyname "^2.2.4" - "@colors/colors@1.5.0": version "1.5.0" resolved "https://registry.yarnpkg.com/@colors/colors/-/colors-1.5.0.tgz#bb504579c1cae923e6576a4f5da43d25f97bdbd9" @@ -2056,35 +1918,6 @@ utility-types "^3.10.0" webpack "^5.88.1" -"@floating-ui/core@^1.6.0": - version "1.6.9" - resolved "https://registry.yarnpkg.com/@floating-ui/core/-/core-1.6.9.tgz#64d1da251433019dafa091de9b2886ff35ec14e6" - integrity sha512-uMXCuQ3BItDUbAMhIXw7UPXRfAlOAvZzdK9BWpE60MCn+Svt3aLn9jsPTi/WNGlRUu2uI0v5S7JiIUsbsvh3fw== - dependencies: - "@floating-ui/utils" "^0.2.9" - -"@floating-ui/dom@^1.0.0", "@floating-ui/dom@^1.6.7": - version "1.6.13" - resolved "https://registry.yarnpkg.com/@floating-ui/dom/-/dom-1.6.13.tgz#a8a938532aea27a95121ec16e667a7cbe8c59e34" - integrity sha512-umqzocjDgNRGTuO7Q8CU32dkHkECqI8ZdMZ5Swb6QAM0t5rnlrN3lGo1hdpscRd3WS8T6DKYK4ephgIH9iRh3w== - dependencies: - "@floating-ui/core" "^1.6.0" - "@floating-ui/utils" "^0.2.9" - -"@floating-ui/utils@^0.2.2", "@floating-ui/utils@^0.2.9": - version "0.2.9" - resolved "https://registry.yarnpkg.com/@floating-ui/utils/-/utils-0.2.9.tgz#50dea3616bc8191fb8e112283b49eaff03e78429" - integrity sha512-MDWhGtE+eHw5JW7lq4qhc5yRLS11ERl1c7Z6Xd0a58DozHES6EnNNwUWbMiG4J9Cgj053Bhk8zvlhFYKVhULwg== - -"@floating-ui/vue@^1.0.2", "@floating-ui/vue@^1.1.0": - version "1.1.6" - resolved "https://registry.yarnpkg.com/@floating-ui/vue/-/vue-1.1.6.tgz#1c7e8f257fae5b71a72d10c1746e6b0ba338399c" - integrity sha512-XFlUzGHGv12zbgHNk5FN2mUB7ROul3oG2ENdTpWdE+qMFxyNxWSRmsoyhiEnpmabNm6WnUvR1OvJfUfN4ojC1A== - dependencies: - "@floating-ui/dom" "^1.0.0" - "@floating-ui/utils" "^0.2.9" - vue-demi ">=0.13.0" - "@hapi/hoek@^9.0.0", "@hapi/hoek@^9.3.0": version "9.3.0" resolved "https://registry.yarnpkg.com/@hapi/hoek/-/hoek-9.3.0.tgz#8368869dcb735be2e7f5cb7647de78e167a251fb" @@ -2097,46 +1930,6 @@ dependencies: "@hapi/hoek" "^9.0.0" -"@headlessui/tailwindcss@^0.2.0": - version "0.2.2" - resolved "https://registry.yarnpkg.com/@headlessui/tailwindcss/-/tailwindcss-0.2.2.tgz#8ebde73fabca72d48636ea56ae790209dc5f0d49" - integrity sha512-xNe42KjdyA4kfUKLLPGzME9zkH7Q3rOZ5huFihWNWOQFxnItxPB3/67yBI8/qBfY8nwBRx5GHn4VprsoluVMGw== - -"@headlessui/vue@^1.7.20": - version "1.7.23" - resolved "https://registry.yarnpkg.com/@headlessui/vue/-/vue-1.7.23.tgz#7fe19dbeca35de9e6270c82c78c4864e6a6f7391" - integrity sha512-JzdCNqurrtuu0YW6QaDtR2PIYCKPUWq28csDyMvN4zmGccmE7lz40Is6hc3LA4HFeCI7sekZ/PQMTNmn9I/4Wg== - dependencies: - "@tanstack/vue-virtual" "^3.0.0-beta.60" - -"@hyperjump/json-pointer@^1.1.0": - version "1.1.0" - resolved "https://registry.yarnpkg.com/@hyperjump/json-pointer/-/json-pointer-1.1.0.tgz#57342cb50a87b4e5d561738cc1d1c9e088780dee" - integrity sha512-tFCKxMKDKK3VEdtUA3EBOS9GmSOS4mbrTjh9v3RnK10BphDMOb6+bxTh++/ae1AyfHyWb6R54O/iaoAtPMZPCg== - -"@hyperjump/json-schema@^1.9.6": - version "1.11.0" - resolved "https://registry.yarnpkg.com/@hyperjump/json-schema/-/json-schema-1.11.0.tgz#db02e2ebf48c3e6ac029a6515265af77be0a1689" - integrity sha512-gX1YNObOybUW6tgJjvb1lomNbI/VnY+EBPokmEGy9Lk8cgi+gE0vXhX1XDgIpUUA4UXfgHEn5I1mga5vHgOttg== - dependencies: - "@hyperjump/json-pointer" "^1.1.0" - "@hyperjump/pact" "^1.2.0" - "@hyperjump/uri" "^1.2.0" - content-type "^1.0.4" - json-stringify-deterministic "^1.0.12" - just-curry-it "^5.3.0" - uuid "^9.0.0" - -"@hyperjump/pact@^1.2.0": - version "1.4.0" - resolved "https://registry.yarnpkg.com/@hyperjump/pact/-/pact-1.4.0.tgz#4ddeec3dcecedc5c1db9972056c463e30c223ad3" - integrity sha512-01Q7VY6BcAkp9W31Fv+ciiZycxZHGlR2N6ba9BifgyclHYHdbaZgITo0U6QMhYRlem4k8pf8J31/tApxvqAz8A== - -"@hyperjump/uri@^1.2.0": - version "1.3.1" - resolved "https://registry.yarnpkg.com/@hyperjump/uri/-/uri-1.3.1.tgz#6ed517caa0eb1191f8938c4d5f85babecb0d6c62" - integrity sha512-2ecKymxf6prQMgrNpAvlx4RhsuM5+PFT6oh6uUTZdv5qmBv0RZvxv8LJ7oR30ZxGhdPdZAl4We/1NFc0nqHeAw== - "@iconify/types@^2.0.0": version "2.0.0" resolved "https://registry.yarnpkg.com/@iconify/types/-/types-2.0.0.tgz#ab0e9ea681d6c8a1214f30cd741fe3a20cc57f57" @@ -2156,20 +1949,6 @@ local-pkg "^1.0.0" mlly "^1.7.4" -"@internationalized/date@^3.5.4": - version "3.7.0" - resolved "https://registry.yarnpkg.com/@internationalized/date/-/date-3.7.0.tgz#23a4956308ee108e308517a7137c69ab8f5f2ad9" - integrity sha512-VJ5WS3fcVx0bejE/YHfbDKR/yawZgKqn/if+oEeLqNwBtPzVB06olkfcnojTmEMX+gTpH+FlQ69SHNitJ8/erQ== - dependencies: - "@swc/helpers" "^0.5.0" - -"@internationalized/number@^3.5.3": - version "3.6.0" - resolved "https://registry.yarnpkg.com/@internationalized/number/-/number-3.6.0.tgz#dc6ba20c41b25eb605f1d5cac7d8668e9022c224" - integrity sha512-PtrRcJVy7nw++wn4W2OuePQQfTqDzfusSuY1QTtui4wa7r+rGVtR75pO8CyKvHvzyQYi3Q1uO5sY0AsB4e65Bw== - dependencies: - "@swc/helpers" "^0.5.0" - "@jest/schemas@^29.6.3": version "29.6.3" resolved "https://registry.yarnpkg.com/@jest/schemas/-/schemas-29.6.3.tgz#430b5ce8a4e0044a7e3819663305a7b3091c8e03" @@ -2216,7 +1995,7 @@ "@jridgewell/gen-mapping" "^0.3.5" "@jridgewell/trace-mapping" "^0.3.25" -"@jridgewell/sourcemap-codec@^1.4.10", "@jridgewell/sourcemap-codec@^1.4.14", "@jridgewell/sourcemap-codec@^1.5.0": +"@jridgewell/sourcemap-codec@^1.4.10", "@jridgewell/sourcemap-codec@^1.4.14": version "1.5.0" resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz#3188bcb273a414b0d215fd22a58540b989b9409a" integrity sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ== @@ -2234,84 +2013,6 @@ resolved "https://registry.yarnpkg.com/@leichtgewicht/ip-codec/-/ip-codec-2.0.5.tgz#4fc56c15c580b9adb7dc3c333a134e540b44bfb1" integrity sha512-Vo+PSpZG2/fmgmiNzYK9qWRh8h/CHrwD0mo1h1DzL4yzHNSfWYujGTYsWGreD000gcgmZ7K4Ys6Tx9TxtsKdDw== -"@lezer/common@^1.0.0", "@lezer/common@^1.0.2", "@lezer/common@^1.1.0", "@lezer/common@^1.2.0", "@lezer/common@^1.2.3": - version "1.2.3" - resolved "https://registry.yarnpkg.com/@lezer/common/-/common-1.2.3.tgz#138fcddab157d83da557554851017c6c1e5667fd" - integrity sha512-w7ojc8ejBqr2REPsWxJjrMFsA/ysDCFICn8zEOR9mrqzOu2amhITYuLD8ag6XZf0CFXDrhKqw7+tW8cX66NaDA== - -"@lezer/css@^1.1.0", "@lezer/css@^1.1.7": - version "1.1.10" - resolved "https://registry.yarnpkg.com/@lezer/css/-/css-1.1.10.tgz#99cef68b26bfdefb76e269b9ee13b0de28edd8ed" - integrity sha512-V5/89eDapjeAkWPBpWEfQjZ1Hag3aYUUJOL8213X0dFRuXJ4BXa5NKl9USzOnaLod4AOpmVCkduir2oKwZYZtg== - dependencies: - "@lezer/common" "^1.2.0" - "@lezer/highlight" "^1.0.0" - "@lezer/lr" "^1.0.0" - -"@lezer/highlight@^1.0.0", "@lezer/highlight@^1.1.3", "@lezer/highlight@^1.2.0", "@lezer/highlight@^1.2.1": - version "1.2.1" - resolved "https://registry.yarnpkg.com/@lezer/highlight/-/highlight-1.2.1.tgz#596fa8f9aeb58a608be0a563e960c373cbf23f8b" - integrity sha512-Z5duk4RN/3zuVO7Jq0pGLJ3qynpxUVsh7IbUbGj88+uV2ApSAn6kWg2au3iJb+0Zi7kKtqffIESgNcRXWZWmSA== - dependencies: - "@lezer/common" "^1.0.0" - -"@lezer/html@^1.3.0": - version "1.3.10" - resolved "https://registry.yarnpkg.com/@lezer/html/-/html-1.3.10.tgz#1be9a029a6fe835c823b20a98a449a630416b2af" - integrity sha512-dqpT8nISx/p9Do3AchvYGV3qYc4/rKr3IBZxlHmpIKam56P47RSHkSF5f13Vu9hebS1jM0HmtJIwLbWz1VIY6w== - dependencies: - "@lezer/common" "^1.2.0" - "@lezer/highlight" "^1.0.0" - "@lezer/lr" "^1.0.0" - -"@lezer/javascript@^1.0.0": - version "1.4.21" - resolved "https://registry.yarnpkg.com/@lezer/javascript/-/javascript-1.4.21.tgz#8ebf7d1f891c70e3d00864f5a03ac42c75d19492" - integrity sha512-lL+1fcuxWYPURMM/oFZLEDm0XuLN128QPV+VuGtKpeaOGdcl9F2LYC3nh1S9LkPqx9M0mndZFdXCipNAZpzIkQ== - dependencies: - "@lezer/common" "^1.2.0" - "@lezer/highlight" "^1.1.3" - "@lezer/lr" "^1.3.0" - -"@lezer/json@^1.0.0": - version "1.0.3" - resolved "https://registry.yarnpkg.com/@lezer/json/-/json-1.0.3.tgz#e773a012ad0088fbf07ce49cfba875cc9e5bc05f" - integrity sha512-BP9KzdF9Y35PDpv04r0VeSTKDeox5vVr3efE7eBbx3r4s3oNLfunchejZhjArmeieBH+nVOpgIiBJpEAv8ilqQ== - dependencies: - "@lezer/common" "^1.2.0" - "@lezer/highlight" "^1.0.0" - "@lezer/lr" "^1.0.0" - -"@lezer/lr@^1.0.0", "@lezer/lr@^1.3.0", "@lezer/lr@^1.4.0", "@lezer/lr@^1.4.2": - version "1.4.2" - resolved "https://registry.yarnpkg.com/@lezer/lr/-/lr-1.4.2.tgz#931ea3dea8e9de84e90781001dae30dea9ff1727" - integrity sha512-pu0K1jCIdnQ12aWNaAVU5bzi7Bd1w54J3ECgANPmYLtQKP0HBj2cE/5coBD66MT10xbtIuUr7tg0Shbsvk0mDA== - dependencies: - "@lezer/common" "^1.0.0" - -"@lezer/xml@^1.0.0": - version "1.0.6" - resolved "https://registry.yarnpkg.com/@lezer/xml/-/xml-1.0.6.tgz#908c203923288f854eb8e2f4d9b06c437e8610b9" - integrity sha512-CdDwirL0OEaStFue/66ZmFSeppuL6Dwjlk8qk153mSQwiSH/Dlri4GNymrNWnUmPl2Um7QfV1FO9KFUyX3Twww== - dependencies: - "@lezer/common" "^1.2.0" - "@lezer/highlight" "^1.0.0" - "@lezer/lr" "^1.0.0" - -"@lezer/yaml@^1.0.0": - version "1.0.3" - resolved "https://registry.yarnpkg.com/@lezer/yaml/-/yaml-1.0.3.tgz#b23770ab42b390056da6b187d861b998fd60b1ff" - integrity sha512-GuBLekbw9jDBDhGur82nuwkxKQ+a3W5H0GfaAthDXcAu+XdpS43VlnxA9E9hllkpSP5ellRDKjLLj7Lu9Wr6xA== - dependencies: - "@lezer/common" "^1.2.0" - "@lezer/highlight" "^1.0.0" - "@lezer/lr" "^1.4.0" - -"@marijn/find-cluster-break@^1.0.0": - version "1.0.2" - resolved "https://registry.yarnpkg.com/@marijn/find-cluster-break/-/find-cluster-break-1.0.2.tgz#775374306116d51c0c500b8c4face0f9a04752d8" - integrity sha512-l0h88YhZFyKdXIFNfSWpyjStDjGHwZ/U7iobcK1cQQD8sejsONdQtTVU+1wVN1PBw40PiiHB1vA5S7VTfQiP9g== - "@mdx-js/mdx@^3.0.0": version "3.1.0" resolved "https://registry.yarnpkg.com/@mdx-js/mdx/-/mdx-3.1.0.tgz#10235cab8ad7d356c262e8c21c68df5850a97dc3" @@ -2403,287 +2104,28 @@ resolved "https://registry.yarnpkg.com/@polka/url/-/url-1.0.0-next.28.tgz#d45e01c4a56f143ee69c54dd6b12eade9e270a73" integrity sha512-8LduaNlMZGwdZ6qWrKlfa+2M4gahzFkprZiAt2TF8uS0qQgBizKXpXURqvTJ4WtmupWxaLqjRb2UCTe72mu+Aw== -"@popperjs/core@^2.9.0": - version "2.11.8" - resolved "https://registry.yarnpkg.com/@popperjs/core/-/core-2.11.8.tgz#6b79032e760a0899cd4204710beede972a3a185f" - integrity sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A== - -"@replit/codemirror-css-color-picker@^6.3.0": - version "6.3.0" - resolved "https://registry.yarnpkg.com/@replit/codemirror-css-color-picker/-/codemirror-css-color-picker-6.3.0.tgz#069835261d2b7b7ff5cb5f3ce354253d6e7e1100" - integrity sha512-19biDANghUm7Fz7L1SNMIhK48tagaWuCOHj4oPPxc7hxPGkTVY2lU/jVZ8tsbTKQPVG7BO2CBDzs7CBwb20t4A== - -"@scalar/api-client@2.3.5": - version "2.3.5" - resolved "https://registry.yarnpkg.com/@scalar/api-client/-/api-client-2.3.5.tgz#27751076944d73d57209756574ccda1d2eb1c3e1" - integrity sha512-bVBP8H3laa4VG3dExv4Ak/Kf+q9z8aK/Glpv6CPE0wxgZJWxwkJoSrvwxUE+46JktSObUrhu4xQiqSCmBz8esQ== - dependencies: - "@headlessui/tailwindcss" "^0.2.0" - "@headlessui/vue" "^1.7.20" - "@scalar/components" "0.13.37" - "@scalar/draggable" "0.1.11" - "@scalar/icons" "0.1.3" - "@scalar/import" "0.3.2" - "@scalar/oas-utils" "0.2.120" - "@scalar/object-utils" "1.1.13" - "@scalar/openapi-parser" "0.10.10" - "@scalar/openapi-types" "0.1.9" - "@scalar/postman-to-openapi" "0.1.43" - "@scalar/snippetz" "0.2.16" - "@scalar/themes" "0.9.79" - "@scalar/types" "0.1.1" - "@scalar/use-codemirror" "0.11.82" - "@scalar/use-hooks" "0.1.33" - "@scalar/use-toasts" "0.7.9" - "@scalar/use-tooltip" "1.0.6" - "@vueuse/core" "^10.10.0" - "@vueuse/integrations" "^11.2.0" - focus-trap "^7" - fuse.js "^7.0.0" - microdiff "^1.4.0" - nanoid "^5.0.9" - pretty-bytes "^6.1.1" - pretty-ms "^8.0.0" - shell-quote "^1.8.1" - vue "^3.5.12" - vue-router "^4.3.0" - whatwg-mimetype "^4.0.0" - yaml "^2.4.5" - zod "^3.23.8" - -"@scalar/api-reference-react@0.6.2": - version "0.6.2" - resolved "https://registry.yarnpkg.com/@scalar/api-reference-react/-/api-reference-react-0.6.2.tgz#5f59ed1ebaf8b1b9e6de9fec2a2d80a23537c30d" - integrity sha512-kUcwmO0bHtuoWhxYiygz7gz36INdQ+TbsqHBcvfGCm96NDCFNkePjHmbC6ytZGA3Rg+76AO5Kb0vtDPJRNkl3g== - dependencies: - "@scalar/api-reference" "1.28.5" - "@scalar/types" "0.1.1" - -"@scalar/api-reference@1.28.5": - version "1.28.5" - resolved "https://registry.yarnpkg.com/@scalar/api-reference/-/api-reference-1.28.5.tgz#c9542605f7372b1304c417694ae81dfdfe5cdf03" - integrity sha512-GNBQae0OCk39KnOmJNtciCc0gKY0BtWYZt1wkqogetm8d2D4JypzxpR4+TqKJeBoASsKF45XogXuKlDbywOGZA== - dependencies: - "@floating-ui/vue" "^1.0.2" - "@headlessui/vue" "^1.7.20" - "@scalar/api-client" "2.3.5" - "@scalar/code-highlight" "0.0.25" - "@scalar/components" "0.13.37" - "@scalar/oas-utils" "0.2.120" - "@scalar/openapi-parser" "0.10.10" - "@scalar/openapi-types" "0.1.9" - "@scalar/snippetz" "0.2.16" - "@scalar/themes" "0.9.79" - "@scalar/types" "0.1.1" - "@scalar/use-hooks" "0.1.33" - "@scalar/use-toasts" "0.7.9" - "@unhead/vue" "^1.11.11" - "@vueuse/core" "^10.10.0" - fuse.js "^7.0.0" - github-slugger "^2.0.0" - nanoid "^5.0.9" - vue "^3.5.12" - zod "^3.23.8" - -"@scalar/code-highlight@0.0.25": - version "0.0.25" - resolved "https://registry.yarnpkg.com/@scalar/code-highlight/-/code-highlight-0.0.25.tgz#3fc0dc4371025d0bb52d1426cc407116b22484da" - integrity sha512-rmiXaAoL3Zl+OycIO1CMj8apaeAU/p41EmCpHTxInZiFVW0++iClce2fun1lK6qjTMZneR6UwE4qBKiUUVLCpg== - dependencies: - hast-util-to-text "^4.0.2" - highlight.js "^11.9.0" - highlightjs-curl "^1.3.0" - highlightjs-vue "^1.0.0" - lowlight "^3.1.0" - rehype-external-links "^3.0.0" - rehype-format "^5.0.0" - rehype-parse "^9.0.0" - rehype-raw "^7.0.0" - rehype-sanitize "^6.0.0" - rehype-stringify "^10.0.0" - remark-gfm "^4.0.0" - remark-parse "^11.0.0" - remark-rehype "^11.1.0" - remark-stringify "^11.0.0" - unified "^11.0.4" - unist-util-visit "^5.0.0" - -"@scalar/components@0.13.37": - version "0.13.37" - resolved "https://registry.yarnpkg.com/@scalar/components/-/components-0.13.37.tgz#609276a0f12f2c226fb74934b310a13064c180b6" - integrity sha512-bhJxg0I63nUH0qoZgb8nyHKCSzL8L9widP2WIYymIvXpCFLwCvF64Z0CAbihwgXxq0YblPvNM+g5N3dRtmXqdA== - dependencies: - "@floating-ui/utils" "^0.2.2" - "@floating-ui/vue" "^1.0.2" - "@headlessui/vue" "^1.7.20" - "@scalar/code-highlight" "0.0.25" - "@scalar/themes" "0.9.79" - "@scalar/use-hooks" "0.1.33" - "@scalar/use-toasts" "0.7.9" - "@vueuse/core" "^10.10.0" - cva "1.0.0-beta.2" - nanoid "^5.0.9" - pretty-bytes "^6.1.1" - radix-vue "^1.9.3" - tailwind-merge "^2.5.5" - vue "^3.5.12" - -"@scalar/docusaurus@^0.5.5": - version "0.5.5" - resolved "https://registry.yarnpkg.com/@scalar/docusaurus/-/docusaurus-0.5.5.tgz#5d7c3ac9b6daf1ff8066a422ede957b5666213c4" - integrity sha512-3YUwnwS7kL94szOWYnMdVMPuqCG2rWh3ax5LMxs8iAbSTktCo2WlZWMQMqMkP7ANyxMldHl6u874v27p6bkuzw== - dependencies: - "@scalar/api-reference-react" "0.6.2" - "@scalar/types" "0.1.1" - -"@scalar/draggable@0.1.11": - version "0.1.11" - resolved "https://registry.yarnpkg.com/@scalar/draggable/-/draggable-0.1.11.tgz#67b59c2a278efecfdc718fd282f8148dad4ce238" - integrity sha512-EQW9N1+mDORhsbjdtCI3XDvmUKsuKw1uf6r3kT1Mm2zQKT+rWwA0ChsAkEN6OG62C0YumMuXpH71h1seAWptxw== - dependencies: - vue "^3.5.12" - -"@scalar/icons@0.1.3": - version "0.1.3" - resolved "https://registry.yarnpkg.com/@scalar/icons/-/icons-0.1.3.tgz#f9db55110e8d498ed2592a121ef505073da014e0" - integrity sha512-Bl46u7WsJ7NYjW1Fva7SMvw9c/92pGBP8B68tvDc+QevQ04DVNxw6+ny1NU/PnLtpuu1rUpPdtSCAkV1OdQGZQ== - dependencies: - vue "^3.5.12" - -"@scalar/import@0.3.2": - version "0.3.2" - resolved "https://registry.yarnpkg.com/@scalar/import/-/import-0.3.2.tgz#2464ae657cc505097d2b7ce6c1b2078bfbfa7671" - integrity sha512-de7IDZgEYOhhgaq8lFFbfiJ4Hx/ITIXvuLA8SfSl5UQKg+LxiOnnn/5PSKF+pnjWmUf7Kz/ds0eHOXpZv5iMkw== - dependencies: - "@scalar/oas-utils" "0.2.120" - "@scalar/openapi-parser" "0.10.10" - yaml "^2.4.5" - -"@scalar/oas-utils@0.2.120": - version "0.2.120" - resolved "https://registry.yarnpkg.com/@scalar/oas-utils/-/oas-utils-0.2.120.tgz#036935af81b58c8df5440c75b7e67320d2096c43" - integrity sha512-npu0uLClqqXVZfxMdKBWxkWCmONK0jKaUcfmVhGza9Jij5aJyvdfDw6vH/Hh+DghgECwAvQLQeIBZTxjr9ufzg== - dependencies: - "@hyperjump/json-schema" "^1.9.6" - "@scalar/object-utils" "1.1.13" - "@scalar/openapi-types" "0.1.9" - "@scalar/themes" "0.9.79" - "@scalar/types" "0.1.1" - flatted "^3.3.1" - microdiff "^1.4.0" - nanoid "^5.0.9" - yaml "^2.4.5" - zod "^3.23.8" - -"@scalar/object-utils@1.1.13": - version "1.1.13" - resolved "https://registry.yarnpkg.com/@scalar/object-utils/-/object-utils-1.1.13.tgz#031425319daf23ecdfcf8b7cac0978607265928e" - integrity sha512-311eTykIXgOtjCs4VTELj9UMT97jHTWc5qkGNoIzZ5nxjCcvOVe7kDQobIkE8dGT+ybOgHz5qly02Eu7nVHeZQ== - dependencies: - flatted "^3.3.1" - just-clone "^6.2.0" - ts-deepmerge "^7.0.1" - -"@scalar/openapi-parser@0.10.10": - version "0.10.10" - resolved "https://registry.yarnpkg.com/@scalar/openapi-parser/-/openapi-parser-0.10.10.tgz#5fd4ff002d7fb550969f5a70ac0002f37bd6148f" - integrity sha512-6MSgvpNKu/anZy96dn8tXQZo1PuDCoeB4m2ZLLDS4vC2zaTnuNBvvQHx+gjwXNKWhTbIVy8bQpYBzlMAYnFNcQ== - dependencies: - ajv "^8.17.1" - ajv-draft-04 "^1.0.0" - ajv-formats "^3.0.1" - jsonpointer "^5.0.1" - leven "^4.0.0" - yaml "^2.4.5" - -"@scalar/openapi-types@0.1.9": - version "0.1.9" - resolved "https://registry.yarnpkg.com/@scalar/openapi-types/-/openapi-types-0.1.9.tgz#e2c5144f7b31ab831f914b1daa0f34b50e47b106" - integrity sha512-HQQudOSQBU7ewzfnBW9LhDmBE2XOJgSfwrh5PlUB7zJup/kaRkBGNgV2wMjNz9Af/uztiU/xNrO179FysmUT+g== - -"@scalar/postman-to-openapi@0.1.43": - version "0.1.43" - resolved "https://registry.yarnpkg.com/@scalar/postman-to-openapi/-/postman-to-openapi-0.1.43.tgz#791e44682a5a3b737bbafca946afc556f0acf1f1" - integrity sha512-gLOkYYPCTKYFBOwyBOKZDc0seZjntmwPTchJUr3oxGQmLB1Y5VBJ+8fXJCTp5TwKiiztjALJs79y9s7jXBdWMA== - dependencies: - "@scalar/oas-utils" "0.2.120" - "@scalar/openapi-types" "0.1.9" - -"@scalar/snippetz@0.2.16": - version "0.2.16" - resolved "https://registry.yarnpkg.com/@scalar/snippetz/-/snippetz-0.2.16.tgz#8c1d33e69260191c5b91255aef69ea1126cbea85" - integrity sha512-xtIY4kvV619IF2uXg6fDw7emtXwuJeWzLunGAaUTIOwNRw5mGSKqJnLcSnIiSdH54YmN8D2CtdJRo2VxPP9/Wg== +"@scalar/docusaurus@^0.6.5": + version "0.6.5" + resolved "https://registry.yarnpkg.com/@scalar/docusaurus/-/docusaurus-0.6.5.tgz#2a4d43535978df3f95ca49da7edbb2a3c2a54de3" + integrity sha512-Fa/YhxxyWtvwLcg8U48eGpUvbM7UrqNd6Bys1jNAZUYzis4oFmcqQoyxVmH7amPkXoR8DVAmJAtI4NQhFZkOwQ== dependencies: - stringify-object "^5.0.0" + "@scalar/types" "0.1.14" -"@scalar/themes@0.9.79": - version "0.9.79" - resolved "https://registry.yarnpkg.com/@scalar/themes/-/themes-0.9.79.tgz#4309cc62bbe780fa64373fdc45fb14a34c9c565d" - integrity sha512-zWiHCZAIjPGa8X9o/NORBPRMTMblLEz2+2RcfW9yIKNO/8H4Gz0rltiGGlJ6vX0o+qHwx7AdgfY+7njmWQR4ng== +"@scalar/openapi-types@0.2.2": + version "0.2.2" + resolved "https://registry.yarnpkg.com/@scalar/openapi-types/-/openapi-types-0.2.2.tgz#59ddb4ff62c0dd0dbeb4376a8ebd2b15b32f5e4c" + integrity sha512-fwWboUf3W5U4qWU7nj4jrs+KYilnfKyVp0d6LC1ejB2aROgWXIAscRtVaPLPaNLpTZOBsMC8XpiAPm3/SlU+mA== dependencies: - "@scalar/types" "0.1.1" + zod "3.24.1" -"@scalar/types@0.1.1": - version "0.1.1" - resolved "https://registry.yarnpkg.com/@scalar/types/-/types-0.1.1.tgz#6e623e1eede623e982369b39706bb476347aacb4" - integrity sha512-LlUX6AmOOGoRqOMoO835V2FezM1KiO5UlvQC3poT/s7oqD6ranqwRNFxyrPz/IxClPYR+SV1yBUSNKely4ZQhQ== - dependencies: - "@scalar/openapi-types" "0.1.9" - "@unhead/schema" "^1.11.11" - zod "^3.23.8" - -"@scalar/use-codemirror@0.11.82": - version "0.11.82" - resolved "https://registry.yarnpkg.com/@scalar/use-codemirror/-/use-codemirror-0.11.82.tgz#04f6c3e447198043d9e686716a7675aa331d802a" - integrity sha512-zFECln7aWKRf6iJO9oovByD59EsrOMenNLfLhneH6L+K1CrBoHFVr4czSDlom1wlr3HPg3xwpZrukoAteHYILQ== - dependencies: - "@codemirror/autocomplete" "^6.18.3" - "@codemirror/commands" "^6.7.1" - "@codemirror/lang-css" "^6.3.1" - "@codemirror/lang-html" "^6.4.8" - "@codemirror/lang-json" "^6.0.0" - "@codemirror/lang-xml" "^6.0.0" - "@codemirror/lang-yaml" "^6.1.2" - "@codemirror/language" "^6.10.7" - "@codemirror/lint" "^6.8.4" - "@codemirror/state" "^6.5.0" - "@codemirror/view" "^6.35.3" - "@lezer/common" "^1.2.3" - "@lezer/highlight" "^1.2.1" - "@lezer/lr" "^1.4.2" - "@replit/codemirror-css-color-picker" "^6.3.0" - "@scalar/components" "0.13.37" - codemirror "^6.0.0" - style-mod "^4.1.2" - vue "^3.5.12" - -"@scalar/use-hooks@0.1.33": - version "0.1.33" - resolved "https://registry.yarnpkg.com/@scalar/use-hooks/-/use-hooks-0.1.33.tgz#c6570547ab636c30e67a9efa62daa494906affd3" - integrity sha512-ENm0bWwRdAWWF/S6TbE+fFx0vP2mgEpG5APqQBomm0a41/6L2HJ/TN+9ajAvrJXGi0ULWuxihNS4Jue6tpEssA== - dependencies: - "@scalar/themes" "0.9.79" - "@scalar/use-toasts" "0.7.9" - "@vueuse/core" "^10.10.0" - vue "^3.5.12" - zod "^3.23.8" - -"@scalar/use-toasts@0.7.9": - version "0.7.9" - resolved "https://registry.yarnpkg.com/@scalar/use-toasts/-/use-toasts-0.7.9.tgz#4f930dded7524a0899d1ea6ad6552ccc7a678821" - integrity sha512-EcUDJY8VozLS9sfoQKvvipStQJ9RuH/nKOzf0BBr+mZDmumi1WFZ1iIJnHVXIN3iSLcSAr5ej6rOqa6jIv4bCQ== - dependencies: - nanoid "^5.0.9" - vue "^3.5.12" - vue-sonner "^1.0.3" - -"@scalar/use-tooltip@1.0.6": - version "1.0.6" - resolved "https://registry.yarnpkg.com/@scalar/use-tooltip/-/use-tooltip-1.0.6.tgz#e55942b9668a0cbb6ad4288574be39289683bd05" - integrity sha512-f0gadIaUnILfi9qYAk7g+fNTsvLGXnam8oOUTxovavC1ocYuGTEykdz3g2MTqnAqRS8OkAB64h9mHf0FBfg6mg== +"@scalar/types@0.1.14": + version "0.1.14" + resolved "https://registry.yarnpkg.com/@scalar/types/-/types-0.1.14.tgz#b3367be4f7636560d6cee944d781264895f0d4c2" + integrity sha512-N7qZ9qARJfi4Gl5MEsRfwPHFWs68qDXWQ+jGi05LGExDqErAJStc4PPkEmxt44uSO4+TVx4ADxWB6xNoGMG/Zg== dependencies: - tippy.js "^6.3.7" - vue "^3.5.12" + "@scalar/openapi-types" "0.2.2" + nanoid "^5.1.5" + zod "3.24.1" "@sideway/address@^4.1.5": version "4.1.5" @@ -2832,13 +2274,6 @@ "@svgr/plugin-jsx" "8.1.0" "@svgr/plugin-svgo" "8.1.0" -"@swc/helpers@^0.5.0": - version "0.5.15" - resolved "https://registry.yarnpkg.com/@swc/helpers/-/helpers-0.5.15.tgz#79efab344c5819ecf83a43f3f9f811fc84b516d7" - integrity sha512-JQ5TuMi45Owi4/BIMAJBoSQoOJu12oOk/gADqlcUL9JEdHB8vyjUSsxqeNXnmXHjYKMi2WcYtezGEEhqUI/E2g== - dependencies: - tslib "^2.8.0" - "@szmarczak/http-timer@^5.0.1": version "5.0.1" resolved "https://registry.yarnpkg.com/@szmarczak/http-timer/-/http-timer-5.0.1.tgz#c7c1bf1141cdd4751b0399c8fc7b8b664cd5be3a" @@ -2846,18 +2281,6 @@ dependencies: defer-to-connect "^2.0.1" -"@tanstack/virtual-core@3.13.4": - version "3.13.4" - resolved "https://registry.yarnpkg.com/@tanstack/virtual-core/-/virtual-core-3.13.4.tgz#31ac7710d102ed59463f922ab088dde5a9e62010" - integrity sha512-fNGO9fjjSLns87tlcto106enQQLycCKR4DPNpgq3djP5IdcPFdPAmaKjsgzIeRhH7hWrELgW12hYnRthS5kLUw== - -"@tanstack/vue-virtual@^3.0.0-beta.60", "@tanstack/vue-virtual@^3.8.1": - version "3.13.4" - resolved "https://registry.yarnpkg.com/@tanstack/vue-virtual/-/vue-virtual-3.13.4.tgz#0e5e8b6ba03a9a5f27793b2b4325bc4a80b60ad3" - integrity sha512-1fPrd3hE1SS4R/9JbX1AlzueY4duCK7ixuLcMW5GMnk9N6WbLo9MioNKiv22V+UaXKOLNy8tLdzT8NYerOFTOQ== - dependencies: - "@tanstack/virtual-core" "3.13.4" - "@trysound/sax@0.2.0": version "0.2.0" resolved "https://registry.yarnpkg.com/@trysound/sax/-/sax-0.2.0.tgz#cccaab758af56761eb7bf37af6f03f326dd798ad" @@ -3405,11 +2828,6 @@ resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.11.tgz#11af57b127e32487774841f7a4e54eab166d03c4" integrity sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA== -"@types/web-bluetooth@^0.0.20": - version "0.0.20" - resolved "https://registry.yarnpkg.com/@types/web-bluetooth/-/web-bluetooth-0.0.20.tgz#f066abfcd1cbe66267cdbbf0de010d8a41b41597" - integrity sha512-g9gZnnXVq7gM7v3tJCWV/qw7w+KeOlSHAhgF9RytFyifW6AF61hdT2ucrYhPq9hLs5JIryeupHV3qGk95dH9ow== - "@types/ws@^8.5.5": version "8.18.0" resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.18.0.tgz#8a2ec491d6f0685ceaab9a9b7ff44146236993b5" @@ -3434,178 +2852,6 @@ resolved "https://registry.yarnpkg.com/@ungap/structured-clone/-/structured-clone-1.3.0.tgz#d06bbb384ebcf6c505fde1c3d0ed4ddffe0aaff8" integrity sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g== -"@unhead/dom@1.11.20": - version "1.11.20" - resolved "https://registry.yarnpkg.com/@unhead/dom/-/dom-1.11.20.tgz#b777f439e1c5f80ebcceb89aa45c45e877013c62" - integrity sha512-jgfGYdOH+xHJF/j8gudjsYu3oIjFyXhCWcgKaw3vQnT616gSqyqnGQGOItL+BQtQZACKNISwIfx5PuOtztMKLA== - dependencies: - "@unhead/schema" "1.11.20" - "@unhead/shared" "1.11.20" - -"@unhead/schema@1.11.20", "@unhead/schema@^1.11.11": - version "1.11.20" - resolved "https://registry.yarnpkg.com/@unhead/schema/-/schema-1.11.20.tgz#e4341832a203b990380df906391e9039501257fa" - integrity sha512-0zWykKAaJdm+/Y7yi/Yds20PrUK7XabLe9c3IRcjnwYmSWY6z0Cr19VIs3ozCj8P+GhR+/TI2mwtGlueCEYouA== - dependencies: - hookable "^5.5.3" - zhead "^2.2.4" - -"@unhead/shared@1.11.20": - version "1.11.20" - resolved "https://registry.yarnpkg.com/@unhead/shared/-/shared-1.11.20.tgz#593926bff62d88cda9a19b9d41d2bcdb3ed08da4" - integrity sha512-1MOrBkGgkUXS+sOKz/DBh4U20DNoITlJwpmvSInxEUNhghSNb56S0RnaHRq0iHkhrO/cDgz2zvfdlRpoPLGI3w== - dependencies: - "@unhead/schema" "1.11.20" - packrup "^0.1.2" - -"@unhead/vue@^1.11.11": - version "1.11.20" - resolved "https://registry.yarnpkg.com/@unhead/vue/-/vue-1.11.20.tgz#609513751abfd2d20426d2e97337f3a76fbb8b12" - integrity sha512-sqQaLbwqY9TvLEGeq8Fd7+F2TIuV3nZ5ihVISHjWpAM3y7DwNWRU7NmT9+yYT+2/jw1Vjwdkv5/HvDnvCLrgmg== - dependencies: - "@unhead/schema" "1.11.20" - "@unhead/shared" "1.11.20" - hookable "^5.5.3" - unhead "1.11.20" - -"@vue/compiler-core@3.5.13": - version "3.5.13" - resolved "https://registry.yarnpkg.com/@vue/compiler-core/-/compiler-core-3.5.13.tgz#b0ae6c4347f60c03e849a05d34e5bf747c9bda05" - integrity sha512-oOdAkwqUfW1WqpwSYJce06wvt6HljgY3fGeM9NcVA1HaYOij3mZG9Rkysn0OHuyUAGMbEbARIpsG+LPVlBJ5/Q== - dependencies: - "@babel/parser" "^7.25.3" - "@vue/shared" "3.5.13" - entities "^4.5.0" - estree-walker "^2.0.2" - source-map-js "^1.2.0" - -"@vue/compiler-dom@3.5.13": - version "3.5.13" - resolved "https://registry.yarnpkg.com/@vue/compiler-dom/-/compiler-dom-3.5.13.tgz#bb1b8758dbc542b3658dda973b98a1c9311a8a58" - integrity sha512-ZOJ46sMOKUjO3e94wPdCzQ6P1Lx/vhp2RSvfaab88Ajexs0AHeV0uasYhi99WPaogmBlRHNRuly8xV75cNTMDA== - dependencies: - "@vue/compiler-core" "3.5.13" - "@vue/shared" "3.5.13" - -"@vue/compiler-sfc@3.5.13": - version "3.5.13" - resolved "https://registry.yarnpkg.com/@vue/compiler-sfc/-/compiler-sfc-3.5.13.tgz#461f8bd343b5c06fac4189c4fef8af32dea82b46" - integrity sha512-6VdaljMpD82w6c2749Zhf5T9u5uLBWKnVue6XWxprDobftnletJ8+oel7sexFfM3qIxNmVE7LSFGTpv6obNyaQ== - dependencies: - "@babel/parser" "^7.25.3" - "@vue/compiler-core" "3.5.13" - "@vue/compiler-dom" "3.5.13" - "@vue/compiler-ssr" "3.5.13" - "@vue/shared" "3.5.13" - estree-walker "^2.0.2" - magic-string "^0.30.11" - postcss "^8.4.48" - source-map-js "^1.2.0" - -"@vue/compiler-ssr@3.5.13": - version "3.5.13" - resolved "https://registry.yarnpkg.com/@vue/compiler-ssr/-/compiler-ssr-3.5.13.tgz#e771adcca6d3d000f91a4277c972a996d07f43ba" - integrity sha512-wMH6vrYHxQl/IybKJagqbquvxpWCuVYpoUJfCqFZwa/JY1GdATAQ+TgVtgrwwMZ0D07QhA99rs/EAAWfvG6KpA== - dependencies: - "@vue/compiler-dom" "3.5.13" - "@vue/shared" "3.5.13" - -"@vue/devtools-api@^6.6.4": - version "6.6.4" - resolved "https://registry.yarnpkg.com/@vue/devtools-api/-/devtools-api-6.6.4.tgz#cbe97fe0162b365edc1dba80e173f90492535343" - integrity sha512-sGhTPMuXqZ1rVOk32RylztWkfXTRhuS7vgAKv0zjqk8gbsHkJ7xfFf+jbySxt7tWObEJwyKaHMikV/WGDiQm8g== - -"@vue/reactivity@3.5.13": - version "3.5.13" - resolved "https://registry.yarnpkg.com/@vue/reactivity/-/reactivity-3.5.13.tgz#b41ff2bb865e093899a22219f5b25f97b6fe155f" - integrity sha512-NaCwtw8o48B9I6L1zl2p41OHo/2Z4wqYGGIK1Khu5T7yxrn+ATOixn/Udn2m+6kZKB/J7cuT9DbWWhRxqixACg== - dependencies: - "@vue/shared" "3.5.13" - -"@vue/runtime-core@3.5.13": - version "3.5.13" - resolved "https://registry.yarnpkg.com/@vue/runtime-core/-/runtime-core-3.5.13.tgz#1fafa4bf0b97af0ebdd9dbfe98cd630da363a455" - integrity sha512-Fj4YRQ3Az0WTZw1sFe+QDb0aXCerigEpw418pw1HBUKFtnQHWzwojaukAs2X/c9DQz4MQ4bsXTGlcpGxU/RCIw== - dependencies: - "@vue/reactivity" "3.5.13" - "@vue/shared" "3.5.13" - -"@vue/runtime-dom@3.5.13": - version "3.5.13" - resolved "https://registry.yarnpkg.com/@vue/runtime-dom/-/runtime-dom-3.5.13.tgz#610fc795de9246300e8ae8865930d534e1246215" - integrity sha512-dLaj94s93NYLqjLiyFzVs9X6dWhTdAlEAciC3Moq7gzAc13VJUdCnjjRurNM6uTLFATRHexHCTu/Xp3eW6yoog== - dependencies: - "@vue/reactivity" "3.5.13" - "@vue/runtime-core" "3.5.13" - "@vue/shared" "3.5.13" - csstype "^3.1.3" - -"@vue/server-renderer@3.5.13": - version "3.5.13" - resolved "https://registry.yarnpkg.com/@vue/server-renderer/-/server-renderer-3.5.13.tgz#429ead62ee51de789646c22efe908e489aad46f7" - integrity sha512-wAi4IRJV/2SAW3htkTlB+dHeRmpTiVIK1OGLWV1yeStVSebSQQOwGwIq0D3ZIoBj2C2qpgz5+vX9iEBkTdk5YA== - dependencies: - "@vue/compiler-ssr" "3.5.13" - "@vue/shared" "3.5.13" - -"@vue/shared@3.5.13": - version "3.5.13" - resolved "https://registry.yarnpkg.com/@vue/shared/-/shared-3.5.13.tgz#87b309a6379c22b926e696893237826f64339b6f" - integrity sha512-/hnE/qP5ZoGpol0a5mDi45bOd7t3tjYJBjsgCsivow7D48cJeV5l05RD82lPqi7gRiphZM37rnhW1l6ZoCNNnQ== - -"@vueuse/core@11.3.0": - version "11.3.0" - resolved "https://registry.yarnpkg.com/@vueuse/core/-/core-11.3.0.tgz#bb0bd1f0edd5435d20694dbe51091cf548653a4d" - integrity sha512-7OC4Rl1f9G8IT6rUfi9JrKiXy4bfmHhZ5x2Ceojy0jnd3mHNEvV4JaRygH362ror6/NZ+Nl+n13LPzGiPN8cKA== - dependencies: - "@types/web-bluetooth" "^0.0.20" - "@vueuse/metadata" "11.3.0" - "@vueuse/shared" "11.3.0" - vue-demi ">=0.14.10" - -"@vueuse/core@^10.10.0", "@vueuse/core@^10.11.0": - version "10.11.1" - resolved "https://registry.yarnpkg.com/@vueuse/core/-/core-10.11.1.tgz#15d2c0b6448d2212235b23a7ba29c27173e0c2c6" - integrity sha512-guoy26JQktXPcz+0n3GukWIy/JDNKti9v6VEMu6kV2sYBsWuGiTU8OWdg+ADfUbHg3/3DlqySDe7JmdHrktiww== - dependencies: - "@types/web-bluetooth" "^0.0.20" - "@vueuse/metadata" "10.11.1" - "@vueuse/shared" "10.11.1" - vue-demi ">=0.14.8" - -"@vueuse/integrations@^11.2.0": - version "11.3.0" - resolved "https://registry.yarnpkg.com/@vueuse/integrations/-/integrations-11.3.0.tgz#2df4468ca3e2f8182ebe2cf7f5b9d768dc7baeb1" - integrity sha512-5fzRl0apQWrDezmobchoiGTkGw238VWESxZHazfhP3RM7pDSiyXy18QbfYkILoYNTd23HPAfQTJpkUc5QbkwTw== - dependencies: - "@vueuse/core" "11.3.0" - "@vueuse/shared" "11.3.0" - vue-demi ">=0.14.10" - -"@vueuse/metadata@10.11.1": - version "10.11.1" - resolved "https://registry.yarnpkg.com/@vueuse/metadata/-/metadata-10.11.1.tgz#209db7bb5915aa172a87510b6de2ca01cadbd2a7" - integrity sha512-IGa5FXd003Ug1qAZmyE8wF3sJ81xGLSqTqtQ6jaVfkeZ4i5kS2mwQF61yhVqojRnenVew5PldLyRgvdl4YYuSw== - -"@vueuse/metadata@11.3.0": - version "11.3.0" - resolved "https://registry.yarnpkg.com/@vueuse/metadata/-/metadata-11.3.0.tgz#be7ac12e3016c0353a3667b372a73aeeee59194e" - integrity sha512-pwDnDspTqtTo2HwfLw4Rp6yywuuBdYnPYDq+mO38ZYKGebCUQC/nVj/PXSiK9HX5otxLz8Fn7ECPbjiRz2CC3g== - -"@vueuse/shared@10.11.1", "@vueuse/shared@^10.11.0": - version "10.11.1" - resolved "https://registry.yarnpkg.com/@vueuse/shared/-/shared-10.11.1.tgz#62b84e3118ae6e1f3ff38f4fbe71b0c5d0f10938" - integrity sha512-LHpC8711VFZlDaYUXEBbFBCQ7GS3dVU9mjOhhMhXP6txTV4EhYQg/KGnQuvt/sPAtoUKq7VVUnL6mVtFoL42sA== - dependencies: - vue-demi ">=0.14.8" - -"@vueuse/shared@11.3.0": - version "11.3.0" - resolved "https://registry.yarnpkg.com/@vueuse/shared/-/shared-11.3.0.tgz#086a4f35bf5bcec5655a03b80eae582605a4b21d" - integrity sha512-P8gSSWQeucH5821ek2mn/ciCk+MS/zoRKqdQIM3bHq6p7GXDAJLmnRRKmF5F65sAVJIfzQlwR3aDzwCn10s8hA== - dependencies: - vue-demi ">=0.14.10" - "@webassemblyjs/ast@1.14.1", "@webassemblyjs/ast@^1.14.1": version "1.14.1" resolved "https://registry.yarnpkg.com/@webassemblyjs/ast/-/ast-1.14.1.tgz#a9f6a07f2b03c95c8d38c4536a1fdfb521ff55b6" @@ -3775,11 +3021,6 @@ aggregate-error@^3.0.0: clean-stack "^2.0.0" indent-string "^4.0.0" -ajv-draft-04@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz#3b64761b268ba0b9e668f0b41ba53fce0ad77fc8" - integrity sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw== - ajv-formats@^2.1.1: version "2.1.1" resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-2.1.1.tgz#6e669400659eb74973bbf2e33327180a0996b520" @@ -3787,13 +3028,6 @@ ajv-formats@^2.1.1: dependencies: ajv "^8.0.0" -ajv-formats@^3.0.1: - version "3.0.1" - resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-3.0.1.tgz#3d5dc762bca17679c3c2ea7e90ad6b7532309578" - integrity sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ== - dependencies: - ajv "^8.0.0" - ajv-keywords@^3.4.1, ajv-keywords@^3.5.2: version "3.5.2" resolved "https://registry.yarnpkg.com/ajv-keywords/-/ajv-keywords-3.5.2.tgz#31f29da5ab6e00d1c2d329acf7b5929614d5014d" @@ -3816,7 +3050,7 @@ ajv@^6.12.2, ajv@^6.12.5: json-schema-traverse "^0.4.1" uri-js "^4.2.2" -ajv@^8.0.0, ajv@^8.17.1, ajv@^8.9.0: +ajv@^8.0.0, ajv@^8.9.0: version "8.17.1" resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.17.1.tgz#37d9a5c776af6bc92d7f4f9510eba4c0a60d11a6" integrity sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g== @@ -3918,13 +3152,6 @@ argparse@^2.0.1: resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== -aria-hidden@^1.2.4: - version "1.2.4" - resolved "https://registry.yarnpkg.com/aria-hidden/-/aria-hidden-1.2.4.tgz#b78e383fdbc04d05762c78b4a25a501e736c4522" - integrity sha512-y+CcFFwelSXpLZk/7fMB2mUbGtX9lKycf1MWJ7CaTIERyitVlyQx6C+sxcROU2BAJ24OiZyK+8wj2i8AlBoS3A== - dependencies: - tslib "^2.0.0" - array-flatten@1.1.1: version "1.1.1" resolved "https://registry.yarnpkg.com/array-flatten/-/array-flatten-1.1.1.tgz#9a5f699051b1e7073328f2a008968b64ea2955d2" @@ -4371,24 +3598,11 @@ clsx@^1.1.1: resolved "https://registry.yarnpkg.com/clsx/-/clsx-1.2.1.tgz#0ddc4a20a549b59c93a4116bb26f5294ca17dc12" integrity sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg== -clsx@^2.0.0, clsx@^2.1.1: +clsx@^2.0.0: version "2.1.1" resolved "https://registry.yarnpkg.com/clsx/-/clsx-2.1.1.tgz#eed397c9fd8bd882bfb18deab7102049a2f32999" integrity sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA== -codemirror@^6.0.0: - version "6.0.1" - resolved "https://registry.yarnpkg.com/codemirror/-/codemirror-6.0.1.tgz#62b91142d45904547ee3e0e0e4c1a79158035a29" - integrity sha512-J8j+nZ+CdWmIeFIGXEFbFPtpiYacFMDR8GlHK3IyHQJMCaVRfGx9NT+Hxivv1ckLWPvNdZqndbr/7lVhrf/Svg== - dependencies: - "@codemirror/autocomplete" "^6.0.0" - "@codemirror/commands" "^6.0.0" - "@codemirror/language" "^6.0.0" - "@codemirror/lint" "^6.0.0" - "@codemirror/search" "^6.0.0" - "@codemirror/state" "^6.0.0" - "@codemirror/view" "^6.0.0" - collapse-white-space@^2.0.0: version "2.1.0" resolved "https://registry.yarnpkg.com/collapse-white-space/-/collapse-white-space-2.1.0.tgz#640257174f9f42c740b40f3b55ee752924feefca" @@ -4532,7 +3746,7 @@ content-disposition@0.5.4: dependencies: safe-buffer "5.2.1" -content-type@^1.0.4, content-type@~1.0.4, content-type@~1.0.5: +content-type@~1.0.4, content-type@~1.0.5: version "1.0.5" resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.5.tgz#8b773162656d1d1086784c8f23a54ce6d73d7918" integrity sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA== @@ -4626,11 +3840,6 @@ cosmiconfig@^8.1.3, cosmiconfig@^8.3.5: parse-json "^5.2.0" path-type "^4.0.0" -crelt@^1.0.5: - version "1.0.6" - resolved "https://registry.yarnpkg.com/crelt/-/crelt-1.0.6.tgz#7cc898ea74e190fb6ef9dae57f8f81cf7302df72" - integrity sha512-VQ2MBenTq1fWZUH9DJNGti7kKv6EeAuYr3cLwxUWhIu1baTaXh4Ib5W2CqHVqib4/MqbYGJqiL3Zb8GJZr3l4g== - cross-spawn@^7.0.3: version "7.0.6" resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.6.tgz#8a58fe78f00dcd70c370451759dfbfaf03e8ee9f" @@ -4821,18 +4030,11 @@ csso@^5.0.5: dependencies: css-tree "~2.2.0" -csstype@^3.0.2, csstype@^3.1.3: +csstype@^3.0.2: version "3.1.3" resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.1.3.tgz#d80ff294d114fb0e6ac500fbf85b60137d7eff81" integrity sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw== -cva@1.0.0-beta.2: - version "1.0.0-beta.2" - resolved "https://registry.yarnpkg.com/cva/-/cva-1.0.0-beta.2.tgz#9d8b43e0f9ad92904bb4065b6b40b2c06da96c92" - integrity sha512-dqcOFe247I5pKxfuzqfq3seLL5iMYsTgo40Uw7+pKZAntPgFtR7Tmy59P5IVIq/XgB0NQWoIvYDt9TwHkuK8Cg== - dependencies: - clsx "^2.1.1" - cytoscape-cose-bilkent@^4.1.0: version "4.1.0" resolved "https://registry.yarnpkg.com/cytoscape-cose-bilkent/-/cytoscape-cose-bilkent-4.1.0.tgz#762fa121df9930ffeb51a495d87917c570ac209b" @@ -5214,11 +4416,6 @@ define-properties@^1.2.1: has-property-descriptors "^1.0.0" object-keys "^1.1.1" -defu@^6.1.4: - version "6.1.4" - resolved "https://registry.yarnpkg.com/defu/-/defu-6.1.4.tgz#4e0c9cf9ff68fe5f3d7f2765cc1a012dfdcb0479" - integrity sha512-mEQCMmwJu317oSz8CwdIOdwf3xMif1ttiM8LTufzc3g6kR+9Pe236twL8j3IYT1F7GfRgGcW6MWxzZjLIkuHIg== - del@^6.1.1: version "6.1.1" resolved "https://registry.yarnpkg.com/del/-/del-6.1.1.tgz#3b70314f1ec0aa325c6b14eb36b95786671edb7a" @@ -5659,11 +4856,6 @@ estree-util-visit@^2.0.0: "@types/estree-jsx" "^1.0.0" "@types/unist" "^3.0.0" -estree-walker@^2.0.2: - version "2.0.2" - resolved "https://registry.yarnpkg.com/estree-walker/-/estree-walker-2.0.2.tgz#52f010178c2a4c117a7757cfe942adb7d2da4cac" - integrity sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w== - estree-walker@^3.0.0: version "3.0.3" resolved "https://registry.yarnpkg.com/estree-walker/-/estree-walker-3.0.3.tgz#67c3e549ec402a487b4fc193d1953a524752340d" @@ -5903,18 +5095,6 @@ flat@^5.0.2: resolved "https://registry.yarnpkg.com/flat/-/flat-5.0.2.tgz#8ca6fe332069ffa9d324c327198c598259ceb241" integrity sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ== -flatted@^3.3.1: - version "3.3.3" - resolved "https://registry.yarnpkg.com/flatted/-/flatted-3.3.3.tgz#67c8fad95454a7c7abebf74bb78ee74a44023358" - integrity sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg== - -focus-trap@^7: - version "7.6.4" - resolved "https://registry.yarnpkg.com/focus-trap/-/focus-trap-7.6.4.tgz#455ec5c51fee5ae99604ca15142409ffbbf84db9" - integrity sha512-xx560wGBk7seZ6y933idtjJQc1l+ck+pI3sKvhKozdBV1dRZoKhkW5xoCaFv9tQiX5RH1xfSxjuNu6g+lmN/gw== - dependencies: - tabbable "^6.2.0" - follow-redirects@^1.0.0: version "1.15.9" resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.9.tgz#a604fa10e443bf98ca94228d9eebcc2e8a2c8ee1" @@ -6012,11 +5192,6 @@ function-bind@^1.1.2: resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.2.tgz#2c02d864d97f3ea6c8830c464cbd11ab6eab7a1c" integrity sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA== -fuse.js@^7.0.0: - version "7.1.0" - resolved "https://registry.yarnpkg.com/fuse.js/-/fuse.js-7.1.0.tgz#306228b4befeee11e05b027087c2744158527d09" - integrity sha512-trLf4SzuuUxfusZADLINj+dE8clK1frKdmqiJNb1Es75fmI5oY6X2mxLVUciLLjxqw/xr72Dhy+lER6dGd02FQ== - gensync@^1.0.0-beta.2: version "1.0.0-beta.2" resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0" @@ -6038,11 +5213,6 @@ get-intrinsic@^1.2.4, get-intrinsic@^1.2.5, get-intrinsic@^1.3.0: hasown "^2.0.2" math-intrinsics "^1.1.0" -get-own-enumerable-keys@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/get-own-enumerable-keys/-/get-own-enumerable-keys-1.0.0.tgz#59bbda0f7e7469c8c74086e08f79f1381b203899" - integrity sha512-PKsK2FSrQCyxcGHsGrLDcK0lx+0Ke+6e8KFFozA9/fIQLhQzPaRvJFdcz7+Axg3jUH/Mq+NI4xa5u/UT2tQskA== - get-own-enumerable-property-symbols@^3.0.0: version "3.0.2" resolved "https://registry.yarnpkg.com/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz#b5fde77f22cbe35f390b4e089922c50bce6ef664" @@ -6066,11 +5236,6 @@ github-slugger@^1.5.0: resolved "https://registry.yarnpkg.com/github-slugger/-/github-slugger-1.5.0.tgz#17891bbc73232051474d68bd867a34625c955f7d" integrity sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw== -github-slugger@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/github-slugger/-/github-slugger-2.0.0.tgz#52cf2f9279a21eb6c59dd385b410f0c0adda8f1a" - integrity sha512-IaOQ9puYtjrkq7Y0Ygl9KDZnrf/aiUJYUpVf89y8kyaxbRG7Y1SrX/jaumrv81vc61+kiMempujsM3Yw7w5qcw== - glob-parent@^5.1.2, glob-parent@~5.1.2: version "5.1.2" resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" @@ -6246,39 +5411,6 @@ hasown@^2.0.2: dependencies: function-bind "^1.1.2" -hast-util-embedded@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/hast-util-embedded/-/hast-util-embedded-3.0.0.tgz#be4477780fbbe079cdba22982e357a0de4ba853e" - integrity sha512-naH8sld4Pe2ep03qqULEtvYr7EjrLK2QHY8KJR6RJkTUjPGObe1vnx585uzem2hGra+s1q08DZZpfgDVYRbaXA== - dependencies: - "@types/hast" "^3.0.0" - hast-util-is-element "^3.0.0" - -hast-util-format@^1.0.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/hast-util-format/-/hast-util-format-1.1.0.tgz#373e77382e07deb04f6676f1b4437e7d8549d985" - integrity sha512-yY1UDz6bC9rDvCWHpx12aIBGRG7krurX0p0Fm6pT547LwDIZZiNr8a+IHDogorAdreULSEzP82Nlv5SZkHZcjA== - dependencies: - "@types/hast" "^3.0.0" - hast-util-embedded "^3.0.0" - hast-util-minify-whitespace "^1.0.0" - hast-util-phrasing "^3.0.0" - hast-util-whitespace "^3.0.0" - html-whitespace-sensitive-tag-names "^3.0.0" - unist-util-visit-parents "^6.0.0" - -hast-util-from-html@^2.0.0: - version "2.0.3" - resolved "https://registry.yarnpkg.com/hast-util-from-html/-/hast-util-from-html-2.0.3.tgz#485c74785358beb80c4ba6346299311ac4c49c82" - integrity sha512-CUSRHXyKjzHov8yKsQjGOElXy/3EKpyX56ELnkHH34vDVw1N1XSQ1ZcAvTyAPtGqLTuKP/uxM+aLkSPqF/EtMw== - dependencies: - "@types/hast" "^3.0.0" - devlop "^1.1.0" - hast-util-from-parse5 "^8.0.0" - parse5 "^7.0.0" - vfile "^6.0.0" - vfile-message "^4.0.0" - hast-util-from-parse5@^8.0.0: version "8.0.3" resolved "https://registry.yarnpkg.com/hast-util-from-parse5/-/hast-util-from-parse5-8.0.3.tgz#830a35022fff28c3fea3697a98c2f4cc6b835a2e" @@ -6293,38 +5425,6 @@ hast-util-from-parse5@^8.0.0: vfile-location "^5.0.0" web-namespaces "^2.0.0" -hast-util-has-property@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/hast-util-has-property/-/hast-util-has-property-3.0.0.tgz#4e595e3cddb8ce530ea92f6fc4111a818d8e7f93" - integrity sha512-MNilsvEKLFpV604hwfhVStK0usFY/QmM5zX16bo7EjnAEGofr5YyI37kzopBlZJkHD4t887i+q/C8/tr5Q94cA== - dependencies: - "@types/hast" "^3.0.0" - -hast-util-is-body-ok-link@^3.0.0: - version "3.0.1" - resolved "https://registry.yarnpkg.com/hast-util-is-body-ok-link/-/hast-util-is-body-ok-link-3.0.1.tgz#ef63cb2f14f04ecf775139cd92bda5026380d8b4" - integrity sha512-0qpnzOBLztXHbHQenVB8uNuxTnm/QBFUOmdOSsEn7GnBtyY07+ENTWVFBAnXd/zEgd9/SUG3lRY7hSIBWRgGpQ== - dependencies: - "@types/hast" "^3.0.0" - -hast-util-is-element@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/hast-util-is-element/-/hast-util-is-element-3.0.0.tgz#6e31a6532c217e5b533848c7e52c9d9369ca0932" - integrity sha512-Val9mnv2IWpLbNPqc/pUem+a7Ipj2aHacCwgNfTiK0vJKl0LF+4Ba4+v1oPHFpf3bLYmreq0/l3Gud9S5OH42g== - dependencies: - "@types/hast" "^3.0.0" - -hast-util-minify-whitespace@^1.0.0: - version "1.0.1" - resolved "https://registry.yarnpkg.com/hast-util-minify-whitespace/-/hast-util-minify-whitespace-1.0.1.tgz#7588fd1a53f48f1d30406b81959dffc3650daf55" - integrity sha512-L96fPOVpnclQE0xzdWb/D12VT5FabA7SnZOUMtL1DbXmYiHJMXZvFkIZfiMmTCNJHUeO2K9UYNXoVyfz+QHuOw== - dependencies: - "@types/hast" "^3.0.0" - hast-util-embedded "^3.0.0" - hast-util-is-element "^3.0.0" - hast-util-whitespace "^3.0.0" - unist-util-is "^6.0.0" - hast-util-parse-selector@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/hast-util-parse-selector/-/hast-util-parse-selector-4.0.0.tgz#352879fa86e25616036037dd8931fb5f34cb4a27" @@ -6332,17 +5432,6 @@ hast-util-parse-selector@^4.0.0: dependencies: "@types/hast" "^3.0.0" -hast-util-phrasing@^3.0.0: - version "3.0.1" - resolved "https://registry.yarnpkg.com/hast-util-phrasing/-/hast-util-phrasing-3.0.1.tgz#fa284c0cd4a82a0dd6020de8300a7b1ebffa1690" - integrity sha512-6h60VfI3uBQUxHqTyMymMZnEbNl1XmEGtOxxKYL7stY2o601COo62AWAYBQR9lZbYXYSBoxag8UpPRXK+9fqSQ== - dependencies: - "@types/hast" "^3.0.0" - hast-util-embedded "^3.0.0" - hast-util-has-property "^3.0.0" - hast-util-is-body-ok-link "^3.0.0" - hast-util-is-element "^3.0.0" - hast-util-raw@^9.0.0: version "9.1.0" resolved "https://registry.yarnpkg.com/hast-util-raw/-/hast-util-raw-9.1.0.tgz#79b66b26f6f68fb50dfb4716b2cdca90d92adf2e" @@ -6362,15 +5451,6 @@ hast-util-raw@^9.0.0: web-namespaces "^2.0.0" zwitch "^2.0.0" -hast-util-sanitize@^5.0.0: - version "5.0.2" - resolved "https://registry.yarnpkg.com/hast-util-sanitize/-/hast-util-sanitize-5.0.2.tgz#edb260d94e5bba2030eb9375790a8753e5bf391f" - integrity sha512-3yTWghByc50aGS7JlGhk61SPenfE/p1oaFeNwkOOyrscaOkMGrcW9+Cy/QAIOBpZxP1yqDIzFMR0+Np0i0+usg== - dependencies: - "@types/hast" "^3.0.0" - "@ungap/structured-clone" "^1.0.0" - unist-util-position "^5.0.0" - hast-util-to-estree@^3.0.0: version "3.1.3" resolved "https://registry.yarnpkg.com/hast-util-to-estree/-/hast-util-to-estree-3.1.3.tgz#e654c1c9374645135695cc0ab9f70b8fcaf733d7" @@ -6393,23 +5473,6 @@ hast-util-to-estree@^3.0.0: unist-util-position "^5.0.0" zwitch "^2.0.0" -hast-util-to-html@^9.0.0: - version "9.0.5" - resolved "https://registry.yarnpkg.com/hast-util-to-html/-/hast-util-to-html-9.0.5.tgz#ccc673a55bb8e85775b08ac28380f72d47167005" - integrity sha512-OguPdidb+fbHQSU4Q4ZiLKnzWo8Wwsf5bZfbvu7//a9oTYoqD/fWpe96NuHkoS9h0ccGOTe0C4NGXdtS0iObOw== - dependencies: - "@types/hast" "^3.0.0" - "@types/unist" "^3.0.0" - ccount "^2.0.0" - comma-separated-tokens "^2.0.0" - hast-util-whitespace "^3.0.0" - html-void-elements "^3.0.0" - mdast-util-to-hast "^13.0.0" - property-information "^7.0.0" - space-separated-tokens "^2.0.0" - stringify-entities "^4.0.0" - zwitch "^2.0.4" - hast-util-to-jsx-runtime@^2.0.0: version "2.3.6" resolved "https://registry.yarnpkg.com/hast-util-to-jsx-runtime/-/hast-util-to-jsx-runtime-2.3.6.tgz#ff31897aae59f62232e21594eac7ef6b63333e98" @@ -6444,16 +5507,6 @@ hast-util-to-parse5@^8.0.0: web-namespaces "^2.0.0" zwitch "^2.0.0" -hast-util-to-text@^4.0.2: - version "4.0.2" - resolved "https://registry.yarnpkg.com/hast-util-to-text/-/hast-util-to-text-4.0.2.tgz#57b676931e71bf9cb852453678495b3080bfae3e" - integrity sha512-KK6y/BN8lbaq654j7JgBydev7wuNMcID54lkRav1P0CaE1e47P72AWWPiGKXTJU271ooYzcvTAn/Zt0REnvc7A== - dependencies: - "@types/hast" "^3.0.0" - "@types/unist" "^3.0.0" - hast-util-is-element "^3.0.0" - unist-util-find-after "^5.0.0" - hast-util-whitespace@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz#7778ed9d3c92dd9e8c5c8f648a49c21fc51cb621" @@ -6477,21 +5530,6 @@ he@^1.2.0: resolved "https://registry.yarnpkg.com/he/-/he-1.2.0.tgz#84ae65fa7eafb165fddb61566ae14baf05664f0f" integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw== -highlight.js@^11.9.0, highlight.js@~11.11.0: - version "11.11.1" - resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-11.11.1.tgz#fca06fa0e5aeecf6c4d437239135fabc15213585" - integrity sha512-Xwwo44whKBVCYoliBQwaPvtd/2tYFkRQtXDWj1nackaV2JPXx3L0+Jvd8/qCJ2p+ML0/XVkJ2q+Mr+UVdpJK5w== - -highlightjs-curl@^1.3.0: - version "1.3.0" - resolved "https://registry.yarnpkg.com/highlightjs-curl/-/highlightjs-curl-1.3.0.tgz#e61e303b4102aaa1b3a3302221257d5c2dd023a2" - integrity sha512-50UEfZq1KR0Lfk2Tr6xb/MUIZH3h10oNC0OTy9g7WELcs5Fgy/mKN1vEhuKTkKbdo8vr5F9GXstu2eLhApfQ3A== - -highlightjs-vue@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/highlightjs-vue/-/highlightjs-vue-1.0.0.tgz#fdfe97fbea6354e70ee44e3a955875e114db086d" - integrity sha512-PDEfEF102G23vHmPhLyPboFCD+BkMGu+GuJe2d9/eH4FsCwvgBpnc9n0pGE+ffKdph38s6foEZiEjdgHdzp+IA== - history@^4.9.0: version "4.10.1" resolved "https://registry.yarnpkg.com/history/-/history-4.10.1.tgz#33371a65e3a83b267434e2b3f3b1b4c58aad4cf3" @@ -6511,11 +5549,6 @@ hoist-non-react-statics@^3.1.0: dependencies: react-is "^16.7.0" -hookable@^5.5.3: - version "5.5.3" - resolved "https://registry.yarnpkg.com/hookable/-/hookable-5.5.3.tgz#6cfc358984a1ef991e2518cb9ed4a778bbd3215d" - integrity sha512-Yc+BQe8SvoXH1643Qez1zqLRmbA5rCL+sSmk6TVos0LWVfNIB7PGncdlId77WzLGSIB5KaWgTaNTs2lNVEI6VQ== - hpack.js@^2.1.6: version "2.1.6" resolved "https://registry.yarnpkg.com/hpack.js/-/hpack.js-2.1.6.tgz#87774c0949e513f42e84575b3c45681fade2a0b2" @@ -6583,11 +5616,6 @@ html-webpack-plugin@^5.6.0: pretty-error "^4.0.0" tapable "^2.0.0" -html-whitespace-sensitive-tag-names@^3.0.0: - version "3.0.1" - resolved "https://registry.yarnpkg.com/html-whitespace-sensitive-tag-names/-/html-whitespace-sensitive-tag-names-3.0.1.tgz#c35edd28205f3bf8c1fd03274608d60b923de5b2" - integrity sha512-q+310vW8zmymYHALr1da4HyXUQ0zgiIwIicEfotYPWGN0OJVEN/58IJ3A4GBYcEq3LGAZqKb+ugvP0GNB9CEAA== - htmlparser2@^6.1.0: version "6.1.0" resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-6.1.0.tgz#c4d762b6c3371a05dbe65e94ae43a9f845fb8fb7" @@ -6816,11 +5844,6 @@ ipaddr.js@^2.0.1: resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-2.2.0.tgz#d33fa7bac284f4de7af949638c9d68157c6b92e8" integrity sha512-Ag3wB2o37wslZS19hZqorUnrnzSkpOVy+IiiDEiTqNubEYpYuHWIf6K4psgN2ZWKExS4xhVCrRVfb/wfW8fWJA== -is-absolute-url@^4.0.0: - version "4.0.1" - resolved "https://registry.yarnpkg.com/is-absolute-url/-/is-absolute-url-4.0.1.tgz#16e4d487d4fded05cfe0685e53ec86804a5e94dc" - integrity sha512-/51/TKE88Lmm7Gc4/8btclNXWS+g50wXhYJq8HWIBAGUBnoAdRu1aXeh364t/O7wXDAcTJDP8PNuNKWUDWie+A== - is-alphabetical@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/is-alphabetical/-/is-alphabetical-2.0.1.tgz#01072053ea7c1036df3c7d19a6daaec7f19e789b" @@ -6925,11 +5948,6 @@ is-obj@^2.0.0: resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-2.0.0.tgz#473fb05d973705e3fd9620545018ca8e22ef4982" integrity sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w== -is-obj@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-3.0.0.tgz#b0889f1f9f8cb87e87df53a8d1230a2250f8b9be" - integrity sha512-IlsXEHOjtKhpN8r/tRFj2nDyTmHvcfNeu/nrRIcXE17ROeatXchkojffa1SpdqW4cr/Fj6QkEf/Gn4zf6KKvEQ== - is-path-cwd@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/is-path-cwd/-/is-path-cwd-2.2.0.tgz#67d43b82664a7b5191fd9119127eb300048a9fdb" @@ -6962,11 +5980,6 @@ is-regexp@^1.0.0: resolved "https://registry.yarnpkg.com/is-regexp/-/is-regexp-1.0.0.tgz#fd2d883545c46bac5a633e7b9a09e87fa2cb5069" integrity sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA== -is-regexp@^3.1.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/is-regexp/-/is-regexp-3.1.0.tgz#0235eab9cda5b83f96ac4a263d8c32c9d5ad7422" - integrity sha512-rbku49cWloU5bSMI+zaRaXdQHXnthP6DZ/vLnfdSKyL4zUzuWnomtOEiZZOd+ioQ+avFo/qau3KPTc7Fjy1uPA== - is-root@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/is-root/-/is-root-2.1.0.tgz#809e18129cf1129644302a4f8544035d51984a9c" @@ -7111,11 +6124,6 @@ json-schema-traverse@^1.0.0: resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== -json-stringify-deterministic@^1.0.12: - version "1.0.12" - resolved "https://registry.yarnpkg.com/json-stringify-deterministic/-/json-stringify-deterministic-1.0.12.tgz#aaa3f907466ed01e3afd77b898d0a2b3b132820a" - integrity sha512-q3PN0lbUdv0pmurkBNdJH3pfFvOTL/Zp0lquqpvcjfKzt6Y0j49EPHAmVHCAS4Ceq/Y+PejWTzyiVpoY71+D6g== - json5@^2.1.2, json5@^2.2.3: version "2.2.3" resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" @@ -7130,21 +6138,6 @@ jsonfile@^6.0.1: optionalDependencies: graceful-fs "^4.1.6" -jsonpointer@^5.0.1: - version "5.0.1" - resolved "https://registry.yarnpkg.com/jsonpointer/-/jsonpointer-5.0.1.tgz#2110e0af0900fd37467b5907ecd13a7884a1b559" - integrity sha512-p/nXbhSEcu3pZRdkW1OfJhpsVtW1gd4Wa1fnQc9YLiTfAjn0312eMKimbdIQzuZl9aa9xUGaRlP9T/CJE/ditQ== - -just-clone@^6.2.0: - version "6.2.0" - resolved "https://registry.yarnpkg.com/just-clone/-/just-clone-6.2.0.tgz#a4614d9bf7e4bbdcae7f9ba904aea5ea9cae8ae5" - integrity sha512-1IynUYEc/HAwxhi3WDpIpxJbZpMCvvrrmZVqvj9EhpvbH8lls7HhdhiByjL7DkAaWlLIzpC0Xc/VPvy/UxLNjA== - -just-curry-it@^5.3.0: - version "5.3.0" - resolved "https://registry.yarnpkg.com/just-curry-it/-/just-curry-it-5.3.0.tgz#1463602e932c5beb431a2a384dddcd48bb3c9c42" - integrity sha512-silMIRiFjUWlfaDhkgSzpuAyQ6EX/o09Eu8ZBfmFwQMbax7+LQzeIU2CBrICT6Ne4l86ITCGvUCBpCubWYy0Yw== - katex@^0.16.9: version "0.16.22" resolved "https://registry.yarnpkg.com/katex/-/katex-0.16.22.tgz#d2b3d66464b1e6d69e6463b28a86ced5a02c5ccd" @@ -7227,11 +6220,6 @@ leven@^3.1.0: resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" integrity sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A== -leven@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/leven/-/leven-4.0.0.tgz#b9c39c803f835950fabef9e122a9b47b95708710" - integrity sha512-puehA3YKku3osqPlNuzGDUHq8WpwXupUg1V6NXdV38G+gr+gkBwFC8g1b/+YcIvp8gnqVIus+eJCH/eGsRmJNw== - lilconfig@^3.1.1: version "3.1.3" resolved "https://registry.yarnpkg.com/lilconfig/-/lilconfig-3.1.3.tgz#a1bcfd6257f9585bf5ae14ceeebb7b559025e4c4" @@ -7341,15 +6329,6 @@ lowercase-keys@^3.0.0: resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-3.0.0.tgz#c5e7d442e37ead247ae9db117a9d0a467c89d4f2" integrity sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ== -lowlight@^3.1.0: - version "3.3.0" - resolved "https://registry.yarnpkg.com/lowlight/-/lowlight-3.3.0.tgz#007b8a5bfcfd27cc65b96246d2de3e9dd4e23c6c" - integrity sha512-0JNhgFoPvP6U6lE/UdVsSq99tn6DhjjpAj5MxG49ewd2mOBVtwWYIT8ClyABhq198aXXODMU6Ox8DrGy/CpTZQ== - dependencies: - "@types/hast" "^3.0.0" - devlop "^1.0.0" - highlight.js "~11.11.0" - lru-cache@^5.1.1: version "5.1.1" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-5.1.1.tgz#1da27e6710271947695daf6848e847f01d84b920" @@ -7362,13 +6341,6 @@ lunr@^2.3.9: resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1" integrity sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow== -magic-string@^0.30.11: - version "0.30.17" - resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.30.17.tgz#450a449673d2460e5bbcfba9a61916a1714c7453" - integrity sha512-sNPKHvyjVf7gyjwS4xGTaW/mCnF8wnjtifKBEhxfZ7E/S8tQ0rssrwGNn6q8JH/ohItJfSQp9mBtQYuTlH5QnA== - dependencies: - "@jridgewell/sourcemap-codec" "^1.5.0" - mark.js@^8.11.1: version "8.11.1" resolved "https://registry.yarnpkg.com/mark.js/-/mark.js-8.11.1.tgz#180f1f9ebef8b0e638e4166ad52db879beb2ffc5" @@ -7687,11 +6659,6 @@ methods@~1.1.2: resolved "https://registry.yarnpkg.com/methods/-/methods-1.1.2.tgz#5529a4d67654134edcc5266656835b0f851afcee" integrity sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w== -microdiff@^1.4.0: - version "1.5.0" - resolved "https://registry.yarnpkg.com/microdiff/-/microdiff-1.5.0.tgz#d16219b223396f11ffcf441da26a43d3e6bd06f8" - integrity sha512-Drq+/THMvDdzRYrK0oxJmOKiC24ayUV8ahrt8l3oRK51PWt6gdtrIGrlIH3pT/lFh1z93FbAcidtsHcWbnRz8Q== - micromark-core-commonmark@^2.0.0: version "2.0.3" resolved "https://registry.yarnpkg.com/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz#c691630e485021a68cf28dbc2b2ca27ebf678cd4" @@ -8230,10 +7197,10 @@ nanoid@^3.3.8: resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.10.tgz#7bc882237698ef787d5cbba109e3b0168ba6e7b1" integrity sha512-vSJJTG+t/dIKAUhUDw/dLdZ9s//5OxcHqLaDWWrW4Cdq7o6tdLIczUkMXt2MBNmk6sJRZBZRXVixs7URY1CmIg== -nanoid@^5.0.7, nanoid@^5.0.9: - version "5.1.4" - resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-5.1.4.tgz#10b15a91d2f727b1f200faf0ff73656fd96c497d" - integrity sha512-GTFcMIDgR7tqji/LpSY8rtg464VnJl/j6ypoehYnuGb+Y8qZUdtKB8WVCXon0UEZgFDbuUxpIl//6FHLHgXSNA== +nanoid@^5.1.5: + version "5.1.5" + resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-5.1.5.tgz#f7597f9d9054eb4da9548cdd53ca70f1790e87de" + integrity sha512-Ir/+ZpE9fDsNH0hQ3C68uyThDXzYcim2EqcZ8zn8Chtt1iylPT9xXJB0kPCnqzgcEGikO9RxSrh63MsmVCU7Fw== negotiator@0.6.3: version "0.6.3" @@ -8476,11 +7443,6 @@ package-manager-detector@^0.2.8: dependencies: quansync "^0.2.7" -packrup@^0.1.2: - version "0.1.2" - resolved "https://registry.yarnpkg.com/packrup/-/packrup-0.1.2.tgz#7e6c50e5b79a1e68cd717e79fd06d40abb8f1583" - integrity sha512-ZcKU7zrr5GlonoS9cxxrb5HVswGnyj6jQvwFBa6p5VFw7G71VAHcUKL5wyZSU/ECtPM/9gacWxy2KFQKt1gMNA== - param-case@^3.0.4: version "3.0.4" resolved "https://registry.yarnpkg.com/param-case/-/param-case-3.0.4.tgz#7d17fe4aa12bde34d4a77d91acfb6219caad01c5" @@ -8519,11 +7481,6 @@ parse-json@^5.0.0, parse-json@^5.2.0: json-parse-even-better-errors "^2.3.0" lines-and-columns "^1.1.6" -parse-ms@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/parse-ms/-/parse-ms-3.0.0.tgz#3ea24a934913345fcc3656deda72df921da3a70e" - integrity sha512-Tpb8Z7r7XbbtBTrM9UhpkzzaMrqA2VXMT3YChzYltwV3P3pM6t8wl7TvpMnSTosz1aQAdVib7kdoys7vYOPerw== - parse-numeric-range@^1.3.0: version "1.3.0" resolved "https://registry.yarnpkg.com/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz#7c63b61190d61e4d53a1197f0c83c47bb670ffa3" @@ -9252,7 +8209,7 @@ postcss-zindex@^6.0.2: resolved "https://registry.yarnpkg.com/postcss-zindex/-/postcss-zindex-6.0.2.tgz#e498304b83a8b165755f53db40e2ea65a99b56e1" integrity sha512-5BxW9l1evPB/4ZIc+2GobEBoKC+h8gPGCMi+jxsYvd2x0mjq7wazk6DrP71pStqxE9Foxh5TVnonbWpFZzXaYg== -postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.26, postcss@^8.4.33, postcss@^8.4.38, postcss@^8.4.48: +postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.26, postcss@^8.4.33, postcss@^8.4.38: version "8.5.3" resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.3.tgz#1463b6f1c7fb16fe258736cba29a2de35237eafb" integrity sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A== @@ -9261,11 +8218,6 @@ postcss@^8.4.21, postcss@^8.4.24, postcss@^8.4.26, postcss@^8.4.33, postcss@^8.4 picocolors "^1.1.1" source-map-js "^1.2.1" -pretty-bytes@^6.1.1: - version "6.1.1" - resolved "https://registry.yarnpkg.com/pretty-bytes/-/pretty-bytes-6.1.1.tgz#38cd6bb46f47afbf667c202cfc754bffd2016a3b" - integrity sha512-mQUvGU6aUFQ+rNvTIAcZuWGRT9a6f6Yrg9bHs4ImKF+HZCEK+plBvnAZYSIQztknZF2qnzNtr6F8s0+IuptdlQ== - pretty-error@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-4.0.0.tgz#90a703f46dd7234adb46d0f84823e9d1cb8f10d6" @@ -9274,13 +8226,6 @@ pretty-error@^4.0.0: lodash "^4.17.20" renderkid "^3.0.0" -pretty-ms@^8.0.0: - version "8.0.0" - resolved "https://registry.yarnpkg.com/pretty-ms/-/pretty-ms-8.0.0.tgz#a35563b2a02df01e595538f86d7de54ca23194a3" - integrity sha512-ASJqOugUF1bbzI35STMBUpZqdfYKlJugy6JBziGi2EE+AL5JPJGSzvpeVXojxrr0ViUYoToUjb5kjSEGf7Y83Q== - dependencies: - parse-ms "^3.0.0" - pretty-time@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/pretty-time/-/pretty-time-1.1.0.tgz#ffb7429afabb8535c346a34e41873adf3d74dd0e" @@ -9385,23 +8330,6 @@ quick-lru@^5.1.1: resolved "https://registry.yarnpkg.com/quick-lru/-/quick-lru-5.1.1.tgz#366493e6b3e42a3a6885e2e99d18f80fb7a8c932" integrity sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA== -radix-vue@^1.9.3: - version "1.9.17" - resolved "https://registry.yarnpkg.com/radix-vue/-/radix-vue-1.9.17.tgz#d6aec1727148e21cfb105c46a4c20bf100c8eee7" - integrity sha512-mVCu7I2vXt1L2IUYHTt0sZMz7s1K2ZtqKeTIxG3yC5mMFfLBG4FtE1FDeRMpDd+Hhg/ybi9+iXmAP1ISREndoQ== - dependencies: - "@floating-ui/dom" "^1.6.7" - "@floating-ui/vue" "^1.1.0" - "@internationalized/date" "^3.5.4" - "@internationalized/number" "^3.5.3" - "@tanstack/vue-virtual" "^3.8.1" - "@vueuse/core" "^10.11.0" - "@vueuse/shared" "^10.11.0" - aria-hidden "^1.2.4" - defu "^6.1.4" - fast-deep-equal "^3.1.3" - nanoid "^5.0.7" - randombytes@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/randombytes/-/randombytes-2.1.0.tgz#df6f84372f0270dc65cdf6291349ab7a473d4f2a" @@ -9711,35 +8639,6 @@ regjsparser@^0.12.0: dependencies: jsesc "~3.0.2" -rehype-external-links@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/rehype-external-links/-/rehype-external-links-3.0.0.tgz#2b28b5cda1932f83f045b6f80a3e1b15f168c6f6" - integrity sha512-yp+e5N9V3C6bwBeAC4n796kc86M4gJCdlVhiMTxIrJG5UHDMh+PJANf9heqORJbt1nrCbDwIlAZKjANIaVBbvw== - dependencies: - "@types/hast" "^3.0.0" - "@ungap/structured-clone" "^1.0.0" - hast-util-is-element "^3.0.0" - is-absolute-url "^4.0.0" - space-separated-tokens "^2.0.0" - unist-util-visit "^5.0.0" - -rehype-format@^5.0.0: - version "5.0.1" - resolved "https://registry.yarnpkg.com/rehype-format/-/rehype-format-5.0.1.tgz#e255e59bed0c062156aaf51c16fad5a521a1f5c8" - integrity sha512-zvmVru9uB0josBVpr946OR8ui7nJEdzZobwLOOqHb/OOD88W0Vk2SqLwoVOj0fM6IPCCO6TaV9CvQvJMWwukFQ== - dependencies: - "@types/hast" "^3.0.0" - hast-util-format "^1.0.0" - -rehype-parse@^9.0.0: - version "9.0.1" - resolved "https://registry.yarnpkg.com/rehype-parse/-/rehype-parse-9.0.1.tgz#9993bda129acc64c417a9d3654a7be38b2a94c20" - integrity sha512-ksCzCD0Fgfh7trPDxr2rSylbwq9iYDkSn8TCDmEJ49ljEUBxDVCzCHv7QNzZOfODanX4+bWQ4WZqLCRWYLfhag== - dependencies: - "@types/hast" "^3.0.0" - hast-util-from-html "^2.0.0" - unified "^11.0.0" - rehype-raw@^7.0.0: version "7.0.0" resolved "https://registry.yarnpkg.com/rehype-raw/-/rehype-raw-7.0.0.tgz#59d7348fd5dbef3807bbaa1d443efd2dd85ecee4" @@ -9758,23 +8657,6 @@ rehype-recma@^1.0.0: "@types/hast" "^3.0.0" hast-util-to-estree "^3.0.0" -rehype-sanitize@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/rehype-sanitize/-/rehype-sanitize-6.0.0.tgz#16e95f4a67a69cbf0f79e113c8e0df48203db73c" - integrity sha512-CsnhKNsyI8Tub6L4sm5ZFsme4puGfc6pYylvXo1AeqaGbjOYyzNv3qZPwvs0oMJ39eryyeOdmxwUIo94IpEhqg== - dependencies: - "@types/hast" "^3.0.0" - hast-util-sanitize "^5.0.0" - -rehype-stringify@^10.0.0: - version "10.0.1" - resolved "https://registry.yarnpkg.com/rehype-stringify/-/rehype-stringify-10.0.1.tgz#2ec1ebc56c6aba07905d3b4470bdf0f684f30b75" - integrity sha512-k9ecfXHmIPuFVI61B9DeLPN0qFHfawM6RsuX48hoqlaKSF61RskNjSm1lI8PhBEM0MRdLxVVm4WmTqJQccH9mA== - dependencies: - "@types/hast" "^3.0.0" - hast-util-to-html "^9.0.0" - unified "^11.0.0" - relateurl@^0.2.7: version "0.2.7" resolved "https://registry.yarnpkg.com/relateurl/-/relateurl-0.2.7.tgz#54dbf377e51440aca90a4cd274600d3ff2d888a9" @@ -9841,7 +8723,7 @@ remark-parse@^11.0.0: micromark-util-types "^2.0.0" unified "^11.0.0" -remark-rehype@^11.0.0, remark-rehype@^11.1.0: +remark-rehype@^11.0.0: version "11.1.1" resolved "https://registry.yarnpkg.com/remark-rehype/-/remark-rehype-11.1.1.tgz#f864dd2947889a11997c0a2667cd6b38f685bca7" integrity sha512-g/osARvjkBXb6Wo0XvAeXQohVta8i84ACbenPpoSsxTOQH/Ae0/RGP4WZgnMH5pMLpsj4FG7OHmcIcXxpza8eQ== @@ -10305,7 +9187,7 @@ sort-css-media-queries@2.2.0: resolved "https://registry.yarnpkg.com/sort-css-media-queries/-/sort-css-media-queries-2.2.0.tgz#aa33cf4a08e0225059448b6c40eddbf9f1c8334c" integrity sha512-0xtkGhWCC9MGt/EzgnvbbbKhqWjl1+/rncmhTh5qCpbYguXh6S/qwePfv/JQ8jePXXmqingylxoC49pCkSPIbA== -source-map-js@^1.0.1, source-map-js@^1.2.0, source-map-js@^1.2.1: +source-map-js@^1.0.1, source-map-js@^1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.2.1.tgz#1ce5650fddd87abc099eda37dcff024c2667ae46" integrity sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA== @@ -10430,15 +9312,6 @@ stringify-object@^3.3.0: is-obj "^1.0.1" is-regexp "^1.0.0" -stringify-object@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/stringify-object/-/stringify-object-5.0.0.tgz#d5b05649fedaf8860640471641f70906fea7f351" - integrity sha512-zaJYxz2FtcMb4f+g60KsRNFOpVMUyuJgA51Zi5Z1DOTC3S59+OQiVOzE9GZt0x72uBGWKsQIuBKeF9iusmKFsg== - dependencies: - get-own-enumerable-keys "^1.0.0" - is-obj "^3.0.0" - is-regexp "^3.1.0" - strip-ansi@^6.0.0, strip-ansi@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" @@ -10473,11 +9346,6 @@ strip-json-comments@~2.0.1: resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-2.0.1.tgz#3c531942e908c2697c0ec344858c286c7ca0a60a" integrity sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ== -style-mod@^4.0.0, style-mod@^4.1.0, style-mod@^4.1.2: - version "4.1.2" - resolved "https://registry.yarnpkg.com/style-mod/-/style-mod-4.1.2.tgz#ca238a1ad4786520f7515a8539d5a63691d7bf67" - integrity sha512-wnD1HyVqpJUI2+eKZ+eo1UwghftP6yuFheBqqe+bWCotBjC2K1YnteJILRMs3SM4V/0dLEW1SC27MWP5y+mwmw== - style-to-js@^1.0.0: version "1.1.16" resolved "https://registry.yarnpkg.com/style-to-js/-/style-to-js-1.1.16.tgz#e6bd6cd29e250bcf8fa5e6591d07ced7575dbe7a" @@ -10542,16 +9410,6 @@ svgo@^3.0.2, svgo@^3.2.0: csso "^5.0.5" picocolors "^1.0.0" -tabbable@^6.2.0: - version "6.2.0" - resolved "https://registry.yarnpkg.com/tabbable/-/tabbable-6.2.0.tgz#732fb62bc0175cfcec257330be187dcfba1f3b97" - integrity sha512-Cat63mxsVJlzYvN51JmVXIgNoUokrIaT2zLclCXjRd8boZ0004U4KCs/sToJ75C6sdlByWxpYnb5Boif1VSFew== - -tailwind-merge@^2.5.5: - version "2.6.0" - resolved "https://registry.yarnpkg.com/tailwind-merge/-/tailwind-merge-2.6.0.tgz#ac5fb7e227910c038d458f396b7400d93a3142d5" - integrity sha512-P+Vu1qXfzediirmHOC3xKGAYeZtPcV9g76X+xg2FD4tYgR71ewMA35Y3sCz3zhiN/dwefRpJX0yBcgwi1fXNQA== - tapable@^1.0.0: version "1.1.3" resolved "https://registry.yarnpkg.com/tapable/-/tapable-1.1.3.tgz#a1fccc06b58db61fd7a45da2da44f5f3a3e67ba2" @@ -10608,13 +9466,6 @@ tinyexec@^0.3.2: resolved "https://registry.yarnpkg.com/tinyexec/-/tinyexec-0.3.2.tgz#941794e657a85e496577995c6eef66f53f42b3d2" integrity sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA== -tippy.js@^6.3.7: - version "6.3.7" - resolved "https://registry.yarnpkg.com/tippy.js/-/tippy.js-6.3.7.tgz#8ccfb651d642010ed9a32ff29b0e9e19c5b8c61c" - integrity sha512-E1d3oP2emgJ9dRQZdf3Kkn0qJgI6ZLpyS5z6ZkY1DF3kaQaBsGZsndEpHwx+eC+tYM41HaSNvNtLx8tU57FzTQ== - dependencies: - "@popperjs/core" "^2.9.0" - to-regex-range@^5.0.1: version "5.0.1" resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" @@ -10647,12 +9498,7 @@ ts-dedent@^2.2.0: resolved "https://registry.yarnpkg.com/ts-dedent/-/ts-dedent-2.2.0.tgz#39e4bd297cd036292ae2394eb3412be63f563bb5" integrity sha512-q5W7tVM71e2xjHZTlgfTDoPF/SmqKG5hddq9SzR49CH2hayqRKJtQ4mtRlSxKaJlR/+9rEM+mnBHf7I2/BQcpQ== -ts-deepmerge@^7.0.1: - version "7.0.2" - resolved "https://registry.yarnpkg.com/ts-deepmerge/-/ts-deepmerge-7.0.2.tgz#6333adcde83e4c42366e9a9a7f955c74ee913547" - integrity sha512-akcpDTPuez4xzULo5NwuoKwYRtjQJ9eoNfBACiBMaXwNAx7B1PKfe5wqUFJuW5uKzQ68YjDFwPaWHDG1KnFGsA== - -tslib@^2.0.0, tslib@^2.0.3, tslib@^2.6.0, tslib@^2.8.0: +tslib@^2.0.3, tslib@^2.6.0: version "2.8.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== @@ -10702,16 +9548,6 @@ undici@^6.19.5: resolved "https://registry.yarnpkg.com/undici/-/undici-6.21.2.tgz#49c5884e8f9039c65a89ee9018ef3c8e2f1f4928" integrity sha512-uROZWze0R0itiAKVPsYhFov9LxrPMHLMEQFszeI2gCN6bnIIZ8twzBCJcN2LJrBBLfrP0t1FW0g+JmKVl8Vk1g== -unhead@1.11.20: - version "1.11.20" - resolved "https://registry.yarnpkg.com/unhead/-/unhead-1.11.20.tgz#910af0ddaac0bca24d32b4dbe0d6291cd813b9bc" - integrity sha512-3AsNQC0pjwlLqEYHLjtichGWankK8yqmocReITecmpB1H0aOabeESueyy+8X1gyJx4ftZVwo9hqQ4O3fPWffCA== - dependencies: - "@unhead/dom" "1.11.20" - "@unhead/schema" "1.11.20" - "@unhead/shared" "1.11.20" - hookable "^5.5.3" - unicode-canonical-property-names-ecmascript@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz#cb3173fe47ca743e228216e4a3ddc4c84d628cc2" @@ -10760,14 +9596,6 @@ unique-string@^3.0.0: dependencies: crypto-random-string "^4.0.0" -unist-util-find-after@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/unist-util-find-after/-/unist-util-find-after-5.0.0.tgz#3fccc1b086b56f34c8b798e1ff90b5c54468e896" - integrity sha512-amQa0Ep2m6hE2g72AugUItjbuM8X8cGQnFoHk0pGfrFeT9GZhzN5SW8nRsiGKK7Aif4CrACPENkA6P/Lw6fHGQ== - dependencies: - "@types/unist" "^3.0.0" - unist-util-is "^6.0.0" - unist-util-is@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/unist-util-is/-/unist-util-is-6.0.0.tgz#b775956486aff107a9ded971d996c173374be424" @@ -10897,11 +9725,6 @@ uuid@^8.3.2: resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2" integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg== -uuid@^9.0.0: - version "9.0.1" - resolved "https://registry.yarnpkg.com/uuid/-/uuid-9.0.1.tgz#e188d4c8853cc722220392c424cd637f32293f30" - integrity sha512-b+1eJOlsR9K8HJpow9Ok3fiWOWSIcIzXodvv0rQjVoOVNpWMpxf1wZNpt4y9h10odCNrqnYp1OBzRktckBe3sA== - validate-peer-dependencies@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/validate-peer-dependencies/-/validate-peer-dependencies-2.2.0.tgz#47b8ff008f66a66fc5d8699123844522c1d874f4" @@ -10979,39 +9802,6 @@ vscode-uri@~3.0.8: resolved "https://registry.yarnpkg.com/vscode-uri/-/vscode-uri-3.0.8.tgz#1770938d3e72588659a172d0fd4642780083ff9f" integrity sha512-AyFQ0EVmsOZOlAnxoFOGOq1SQDWAB7C6aqMGS23svWAllfOaxbuFvcT8D1i8z3Gyn8fraVeZNNmN6e9bxxXkKw== -vue-demi@>=0.13.0, vue-demi@>=0.14.10, vue-demi@>=0.14.8: - version "0.14.10" - resolved "https://registry.yarnpkg.com/vue-demi/-/vue-demi-0.14.10.tgz#afc78de3d6f9e11bf78c55e8510ee12814522f04" - integrity sha512-nMZBOwuzabUO0nLgIcc6rycZEebF6eeUfaiQx9+WSk8e29IbLvPU9feI6tqW4kTo3hvoYAJkMh8n8D0fuISphg== - -vue-router@^4.3.0: - version "4.5.0" - resolved "https://registry.yarnpkg.com/vue-router/-/vue-router-4.5.0.tgz#58fc5fe374e10b6018f910328f756c3dae081f14" - integrity sha512-HDuk+PuH5monfNuY+ct49mNmkCRK4xJAV9Ts4z9UFc4rzdDnxQLyCMGGc8pKhZhHTVzfanpNwB/lwqevcBwI4w== - dependencies: - "@vue/devtools-api" "^6.6.4" - -vue-sonner@^1.0.3: - version "1.3.0" - resolved "https://registry.yarnpkg.com/vue-sonner/-/vue-sonner-1.3.0.tgz#da8ab9be995dfea781d57a6ac52d170d02473d86" - integrity sha512-jAodBy4Mri8rQjVZGQAPs4ZYymc1ywPiwfa81qU0fFl+Suk7U8NaOxIDdI1oBGLeQJqRZi/oxNIuhCLqsBmOwg== - -vue@^3.5.12: - version "3.5.13" - resolved "https://registry.yarnpkg.com/vue/-/vue-3.5.13.tgz#9f760a1a982b09c0c04a867903fc339c9f29ec0a" - integrity sha512-wmeiSMxkZCSc+PM2w2VRsOYAZC8GdipNFRTsLSfodVqI9mbejKeXEGr8SckuLnrQPGe3oJN5c3K0vpoU9q/wCQ== - dependencies: - "@vue/compiler-dom" "3.5.13" - "@vue/compiler-sfc" "3.5.13" - "@vue/runtime-dom" "3.5.13" - "@vue/server-renderer" "3.5.13" - "@vue/shared" "3.5.13" - -w3c-keyname@^2.2.4: - version "2.2.8" - resolved "https://registry.yarnpkg.com/w3c-keyname/-/w3c-keyname-2.2.8.tgz#7b17c8c6883d4e8b86ac8aba79d39e880f8869c5" - integrity sha512-dpojBhNsCNN7T82Tm7k26A6G9ML3NkhDsnw9n/eoxSRlVBB4CEtIQ/KTCLI2Fwf3ataSXRhYFkQi3SlnFwPvPQ== - watchpack@^2.4.1: version "2.4.2" resolved "https://registry.yarnpkg.com/watchpack/-/watchpack-2.4.2.tgz#2feeaed67412e7c33184e5a79ca738fbd38564da" @@ -11280,11 +10070,6 @@ yaml@^1.7.2: resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg== -yaml@^2.4.5: - version "2.7.0" - resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.7.0.tgz#aef9bb617a64c937a9a748803786ad8d3ffe1e98" - integrity sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA== - yocto-queue@^0.1.0: version "0.1.0" resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b" @@ -11295,17 +10080,12 @@ yocto-queue@^1.0.0: resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-1.2.0.tgz#4a29a93e7591328fa31768701e6ea66962401f79" integrity sha512-KHBC7z61OJeaMGnF3wqNZj+GGNXOyypZviiKpQeiHirG5Ib1ImwcLBH70rbMSkKfSmUNBsdf2PwaEJtKvgmkNw== -zhead@^2.2.4: - version "2.2.4" - resolved "https://registry.yarnpkg.com/zhead/-/zhead-2.2.4.tgz#87cd1e2c3d2f465fa9f43b8db23f9716dfe6bed7" - integrity sha512-8F0OI5dpWIA5IGG5NHUg9staDwz/ZPxZtvGVf01j7vHqSyZ0raHY+78atOVxRqb73AotX22uV1pXt3gYSstGag== - -zod@^3.23.8: - version "3.24.2" - resolved "https://registry.yarnpkg.com/zod/-/zod-3.24.2.tgz#8efa74126287c675e92f46871cfc8d15c34372b3" - integrity sha512-lY7CDW43ECgW9u1TcT3IoXHflywfVqDYze4waEz812jR/bZ8FHDsl7pFQoSZTz5N+2NqRXs8GBwnAwo3ZNxqhQ== +zod@3.24.1: + version "3.24.1" + resolved "https://registry.yarnpkg.com/zod/-/zod-3.24.1.tgz#27445c912738c8ad1e9de1bea0359fa44d9d35ee" + integrity sha512-muH7gBL9sI1nciMZV67X5fTKKBLtwpZ5VBp1vsOQzj1MhrBZ4wlVCm3gedKZWLp0Oyel8sIGfeiz54Su+OVT+A== -zwitch@^2.0.0, zwitch@^2.0.4: +zwitch@^2.0.0: version "2.0.4" resolved "https://registry.yarnpkg.com/zwitch/-/zwitch-2.0.4.tgz#c827d4b0acb76fc3e685a4c6ec2902d51070e9d7" integrity sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A== From b419cccdf3aa3a30ed3a225f60ae6bd9da4b1cd5 Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Wed, 7 May 2025 22:04:05 -0300 Subject: [PATCH 05/13] chore: restore SearchTransactionsResponse schema to specs --- .../rosetta-specifications-1.4.15/api.yaml | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml index 6a937edda1..7a29f3f02c 100644 --- a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml +++ b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml @@ -2113,6 +2113,30 @@ components: success: type: boolean description: success is a synthetic condition populated by parsing network-specific operation statuses (using the mapping provided in `/network/options`). + SearchTransactionsResponse: + description: SearchTransactionsResponse contains an ordered collection of BlockTransactions that match the query in SearchTransactionsRequest. These BlockTransactions are sorted from most recent block to oldest block. + type: object + required: + - transactions + - total_count + properties: + transactions: + type: array + description: transactions is an array of BlockTransactions sorted by most recent BlockIdentifier (meaning that transactions in recent blocks appear first). If there are many transactions for a particular search, transactions may not contain all matching transactions. It is up to the caller to paginate these transactions using the max_block field. + items: + $ref: '#/components/schemas/BlockTransaction' + total_count: + description: total_count is the number of results for a given search. Callers typically use this value to concurrently fetch results by offset or to display a virtual page number associated with results. + type: integer + format: int64 + minimum: 0 + example: 5 + next_offset: + description: next_offset is the next offset to use when paginating through transaction results. If this field is not populated, there are no more transactions to query. + type: integer + format: int64 + minimum: 0 + example: 5 Error: description: Instead of utilizing HTTP status codes to describe node errors (which often do not have a good analog), rich errors are returned using this object. Both the code and message fields can be individually used to correctly identify an error. Implementations MUST use unique values for both fields. type: object From f6610f939a0b0e1bbc586287f7772a293befdee5 Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Mon, 2 Jun 2025 21:16:26 -0300 Subject: [PATCH 06/13] fix: remove schema 'examples' breaking CI validation Remove multiple 'examples' entries from schema definitions ('Operation', 'NetworkIdentifier'). These were intended solely for enhanced rendering in Scalar docs but caused spec-validation failures during CI builds. Single 'example' per schema retained to ensure OpenAPI compliance and fix build errors. --- .../rosetta-specifications-1.4.15/api.yaml | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml index 7a29f3f02c..44f484869e 100644 --- a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml +++ b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml @@ -542,10 +542,8 @@ components: network: description: This field contains the specific network identifier for the blockchain, such as 'mainnet', 'preprod', or 'preview' for Cardano. This helps identify which network you are connecting to. type: string - examples: + example: - mainnet - - preprod - - preview BlockIdentifier: description: The block_identifier uniquely identifies a block in a particular network. type: object @@ -831,24 +829,13 @@ components: type: description: Type is the network-specific type of the operation. Ensure that any type that can be returned here is also specified in the NetworkOptionsResponse. This can be very useful to downstream consumers that parse all block data. type: string - examples: + example: - 'input' - - 'output' - - 'stakeKeyRegistration' - - 'stakeDelegation' - - 'stakeKeyDeregistration' - - 'poolRegistration' - - 'poolRegistrationWithCert' - - 'poolRetirement' - - 'voteRegistration' - - 'dRepVoteDelegation' - - 'withdrawal' status: description: Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. Cardano transactions are generally atomic; they either succeed entirely and are included in a block or fail validation and are rejected. Therefore, the status for operations within a block transaction will typically be a single success value defined in NetworkOptionsResponse. On-chain operations (operations retrieved in the `/block` and `/block/transaction` endpoints) MUST have a populated status field. Operations provided during transaction construction (often called "intent") MUST NOT have a populated status field. type: string - examples: + example: - 'success' - - 'failure' account: $ref: '#/components/schemas/AccountIdentifier' amount: From 84a331aad42d4aa69ce0dc64588dbdb2ba8941d8 Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Tue, 3 Jun 2025 22:51:13 -0300 Subject: [PATCH 07/13] chore: update OpenAPI generator plugin version and refine example values in API specification - Upgraded the OpenAPI generator Maven plugin from version 6.4.0 to 7.13.0. - Simplified example values in the API specification by removing unnecessary array structures for 'network' and 'status' fields. --- .../rosetta-specifications-1.4.15/api.yaml | 17 ++++++----------- pom.xml | 2 +- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml index 44f484869e..871d6bdf15 100644 --- a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml +++ b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml @@ -542,8 +542,7 @@ components: network: description: This field contains the specific network identifier for the blockchain, such as 'mainnet', 'preprod', or 'preview' for Cardano. This helps identify which network you are connecting to. type: string - example: - - mainnet + example: mainnet BlockIdentifier: description: The block_identifier uniquely identifies a block in a particular network. type: object @@ -829,13 +828,11 @@ components: type: description: Type is the network-specific type of the operation. Ensure that any type that can be returned here is also specified in the NetworkOptionsResponse. This can be very useful to downstream consumers that parse all block data. type: string - example: - - 'input' + example: input status: description: Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. Cardano transactions are generally atomic; they either succeed entirely and are included in a block or fail validation and are rejected. Therefore, the status for operations within a block transaction will typically be a single success value defined in NetworkOptionsResponse. On-chain operations (operations retrieved in the `/block` and `/block/transaction` endpoints) MUST have a populated status field. Operations provided during transaction construction (often called "intent") MUST NOT have a populated status field. type: string - example: - - 'success' + example: success account: $ref: '#/components/schemas/AccountIdentifier' amount: @@ -959,16 +956,14 @@ components: items: $ref: '#/components/schemas/OperationStatus' example: - - status: 'success' + - status: success successful: true - - status: 'invalid' - successful: false operation_types: - description: All Operation.Type this implementation supports. This is crucial for Cardano, which has many distinct operation types beyond simple transfers. + description: All Operation.Type this implementation supports (input, output, stakeKeyRegistration, stakeDelegation, withdrawal, stakeKeyDeregistration, poolRegistration, poolRegistrationWithCert, poolRetirement, voteRegistration, dRepVoteDelegation). This is crucial for Cardano, which has many distinct operation types beyond simple transfers. type: array items: type: string - example: # Add all relevant Cardano operation types + example: - 'input' - 'output' - 'stakeKeyRegistration' diff --git a/pom.xml b/pom.xml index 298e55cd4c..b3a82636ba 100644 --- a/pom.xml +++ b/pom.xml @@ -31,7 +31,7 @@ UTF-8 3.4.3 1.6.15 - 6.4.0 + 7.13.0 3.13.0 3.2.5 0.8.11 From 560ad052422fa36eccbc0bd42e331da5c6899b3d Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Wed, 4 Jun 2025 12:40:04 -0300 Subject: [PATCH 08/13] chore: drop API spec and pom edits from PR 456 --- .../rosetta-specifications-1.4.15/api.yaml | 1285 +++++------------ pom.xml | 2 +- 2 files changed, 369 insertions(+), 918 deletions(-) diff --git a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml index 871d6bdf15..23f3a2b430 100644 --- a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml +++ b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml @@ -1,8 +1,8 @@ openapi: 3.0.2 info: version: 1.4.13 - title: Mesh (formerly Rosetta) API for Cardano - description: A lightweight Java implementation, built on Yaci-store for reduced resource footprint. + title: Rosetta + description: Build Once. Integrate Your Blockchain Everywhere. license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html @@ -36,7 +36,7 @@ paths: /network/status: post: summary: Get Network Status - description: This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list is accessible here. + description: This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. operationId: networkStatus tags: - Network @@ -62,7 +62,7 @@ paths: /network/options: post: summary: Get Network Options - description: This endpoint provides version information and supported types for the specified network. It helps users understand what features and options are available on the network they're connecting to. Each network may have different capabilities, so this endpoint allows you to discover what's supported before making other API calls. + description: This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. operationId: networkOptions tags: - Network @@ -114,7 +114,7 @@ paths: /block/transaction: post: summary: Get a Block Transaction - description: 'Get a transaction in a block by its Transaction Identifier. This endpoint should only be used when querying a node for a block does not return all transactions contained within it (e.g., only hashes are returned in /block). All transactions returned by this endpoint must be appended to any transactions returned by the /block method by consumers of this data. Calling this endpoint requires reference to a BlockIdentifier because transaction parsing (especially script context) can change depending on which block contains the transaction. Cardano transactions include inputs, outputs (which may contain native assets), certificates (e.g., staking, pool registration), withdrawals, metadata, minting information, and script witnesses. Implementations that require fetching previous transactions to populate the response (ex: UTXOs for inputs) may find it useful to run a cache.' + description: 'Get a transaction in a block by its Transaction Identifier. This endpoint should only be used when querying a node for a block does not return all transactions contained within it. All transactions returned by this endpoint must be appended to any transactions returned by the /block method by consumers of this data. Fetching a transaction by hash is considered an Explorer Method (which is classified under the Future Work section). This method can be used to let consumers to paginate results when the block trasactions count is too big to be returned in a single BlockResponse. Calling this endpoint requires reference to a BlockIdentifier because transaction parsing can change depending on which block contains the transaction. For example, in Bitcoin it is necessary to know which block contains a transaction to determine the destination of fee payments. Without specifying a block identifier, the node would have to infer which block to use (which could change during a re-org). Implementations that require fetching previous transactions to populate the response (ex: Previous UTXOs in Bitcoin) may find it useful to run a cache within the Rosetta server in the /data directory (on a path that does not conflict with the node).' operationId: blockTransaction tags: - Block @@ -137,62 +137,62 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' - # /mempool: # TODO: Add mempool endpoint support - # post: - # summary: Get All Mempool Transactions - # description: Not implemented. - # operationId: mempool - # tags: - # - Mempool - # requestBody: - # required: true - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/NetworkRequest' - # responses: - # '200': - # description: Expected response to a valid request - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/MempoolResponse' - # '500': - # description: unexpected error - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/Error' - # /mempool/transaction: # TODO: Add mempool transaction endpoint support - # post: - # summary: Get a Mempool Transaction - # description: Not implemented. - # operationId: mempoolTransaction - # tags: - # - Mempool - # requestBody: - # required: true - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/MempoolTransactionRequest' - # responses: - # '200': - # description: Expected response to a valid request - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/MempoolTransactionResponse' - # '500': - # description: unexpected error - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/Error' + /mempool: + post: + summary: Get All Mempool Transactions + description: Get all Transaction Identifiers in the mempool + operationId: mempool + tags: + - Mempool + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkRequest' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MempoolResponse' + '500': + description: unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + /mempool/transaction: + post: + summary: Get a Mempool Transaction + description: 'Get a transaction in the mempool by its Transaction Identifier. This is a separate request than fetching a block transaction (/block/transaction) because some blockchain nodes need to know that a transaction query is for something in the mempool instead of a transaction in a block. Transactions may not be fully parsable until they are in a block (ex: may not be possible to determine the fee to pay before a transaction is executed). On this endpoint, it is ok that returned transactions are only estimates of what may actually be included in a block.' + operationId: mempoolTransaction + tags: + - Mempool + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MempoolTransactionRequest' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MempoolTransactionResponse' + '500': + description: unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' /account/balance: post: summary: Get an Account's Balance - description: 'Get an array of all AccountBalances for an AccountIdentifier (typically a Cardano payment address `addr...`) and the BlockIdentifier at which the balance lookup was performed. Balances include ADA and any native assets (tokens) held by the account at that block. The BlockIdentifier must always be returned for reconciliation. In Cardano, accounts often consist of a payment part (controlled by payment credentials) and an optional delegation part (controlled by stake credentials/address `stake...`). This endpoint typically queries based on the payment address. Querying rewards or stake delegation status might require specific handling or different endpoints/calls. Making a balance request without populating SubAccountIdentifier should return the balance associated with the main address, not aggregated sub-balances. It is also possible to perform a historical balance lookup (if the server supports it) by passing in an optional BlockIdentifier.' + description: Get an array of all AccountBalances for an AccountIdentifier and the BlockIdentifier at which the balance lookup was performed. The BlockIdentifier must always be returned because some consumers of account balance data need to know specifically at which block the balance was calculated to compare balances they compute from operations with the balance returned by the node. It is important to note that making a balance request for an account without populating the SubAccountIdentifier should not result in the balance of all possible SubAccountIdentifiers being returned. Rather, it should result in the balance pertaining to no SubAccountIdentifiers being returned (sometimes called the liquid balance). To get all balances associated with an account, it may be necessary to perform multiple balance requests with unique AccountIdentifiers. It is also possible to perform a historical balance lookup (if the server supports it) by passing in an optional BlockIdentifier. operationId: accountBalance tags: - Account @@ -217,8 +217,8 @@ paths: $ref: '#/components/schemas/Error' /account/coins: post: - summary: Get an Account's Unspent Coins (UTXOs) - description: Get an array of all unspent coins (UTXOs) for an AccountIdentifier (typically a Cardano payment address `addr...`) and the BlockIdentifier at which the lookup was performed. This endpoint is essential for UTXO-based blockchains like Cardano. Each Coin (UTXO) includes its identifier (tx_hash:index), its ADA value, and potentially native assets held within it (often returned in Coin.metadata). Implementations MUST also complete the `/account/balance` endpoint. Making a coins request without populating SubAccountIdentifier should return coins associated with the main address. Optionally, an implementation may support `include_mempool` to show coins considering pending transactions, but this breaks idempotency guarantees. + summary: Get an Account's Unspent Coins + description: Get an array of all unspent coins for an AccountIdentifier and the BlockIdentifier at which the lookup was performed. If your implementation does not support coins (i.e. it is for an account-based blockchain), you do not need to implement this endpoint. If you implementation does support coins (i.e. it is fro a UTXO-based blockchain), you MUST also complete the `/account/balance` endpoint. It is important to note that making a coins request for an account without populating the SubAccountIdentifier should not result in the coins of all possible SubAccountIdentifiers being returned. Rather, it should result in the coins pertaining to no SubAccountIdentifiers being returned. To get all coins associated with an account, it may be necessary to perform multiple coin requests with unique AccountIdentifiers. Optionally, an implementation may choose to support updating an AccountIdentifier's unspent coins based on the contents of the mempool. Note, using this functionality breaks any guarantee of idempotency. operationId: accountCoins tags: - Account @@ -244,7 +244,7 @@ paths: /construction/derive: post: summary: Derive an AccountIdentifier from a PublicKey - description: Derive returns the AccountIdentifier (typically a payment address `addr...` potentially associated with a stake address `stake...`) associated with a public key and optional derivation parameters (e.g., specifying network or address type). Cardano uses hierarchical deterministic key derivation (e.g., BIP-44, CIP-1852) and different address types (Base, Enterprise, Reward). Metadata might be needed to specify the desired address type or associated staking key. + description: Derive returns the AccountIdentifier associated with a public key. Blockchains that require an on-chain action to create an account should not implement this method. operationId: constructionDerive tags: - Construction @@ -269,8 +269,8 @@ paths: $ref: '#/components/schemas/Error' /construction/preprocess: post: - summary: Create a Request to Fetch Metadata for Construction - description: Preprocess is called prior to `/construction/payloads` to construct a request for any metadata needed for transaction construction given the intended operations (e.g., calculating fees requires estimated transaction size, which depends on inputs, outputs, certificates etc.; deposit amounts might be needed). The `options` object returned (e.g., containing relative TTL, estimated size) will be sent to `/construction/metadata`. Configuration options (like specific era constraints) MUST be specified in the `metadata` field of this request if needed. Cardano transaction construction involves details like TTL (slot number), fees, potentially certificates, withdrawals, scripts, and native assets. + summary: Create a Request to Fetch Metadata + description: Preprocess is called prior to `/construction/payloads` to construct a request for any metadata that is needed for transaction construction given (i.e. account nonce). The `options` object returned from this endpoint will be sent to the `/construction/metadata` endpoint UNMODIFIED by the caller (in an offline execution environment). If your Construction API implementation has configuration options, they MUST be specified in the `/construction/preprocess` request (in the `metadata` field). operationId: constructionPreprocess tags: - Construction @@ -296,7 +296,7 @@ paths: /construction/metadata: post: summary: Get Metadata for Transaction Construction - description: Get network-specific information required to construct a transaction based on the request from `/construction/preprocess`. For Cardano, this typically includes current protocol parameters (needed for fee calculation, deposit amounts, script cost models), and potentially the current slot number to calculate absolute TTL. The request is created by calling `/construction/preprocess` offline. You should NEVER assume the request sent to this endpoint will be populated with custom parameters; they must come from `/construction/preprocess`. This endpoint returns metadata like protocol parameters and calculated absolute TTL, not a pre-constructed transaction. + description: Get any information required to construct a transaction for a specific network. Metadata returned here could be a recent hash to use, an account sequence number, or even arbitrary chain state. The request used when calling this endpoint is created by calling `/construction/preprocess` in an offline environment. You should NEVER assume that the request sent to this endpoint will be created by the caller or populated with any custom parameters. This must occur in `/construction/preprocess`. It is important to clarify that this endpoint should not pre-construct any transactions for the client (this should happen in `/construction/payloads`). This endpoint is left purposely unstructured because of the wide scope of metadata that could be required. operationId: constructionMetadata tags: - Construction @@ -322,7 +322,7 @@ paths: /construction/payloads: post: summary: Generate an Unsigned Transaction and Signing Payloads - description: Payloads is called with an array of intended operations and the response from `/construction/metadata`. It returns an unsigned transaction blob (typically the CBOR transaction body for Cardano) and a collection of signing payloads (hashes of the transaction body) that must be signed by specific keys (identified by AccountIdentifiers). The operations provided specify the "intent" (inputs, outputs, certificates, withdrawals, minting). Parsing the final transaction on-chain might yield a superset of these operations if intermediary steps occurred (though less common in Cardano than EVM). Cardano signing requires witnesses (signatures) for inputs, certificates, withdrawals, and potentially scripts. + description: Payloads is called with an array of operations and the response from `/construction/metadata`. It returns an unsigned transaction blob and a collection of payloads that must be signed by particular AccountIdentifiers using a certain SignatureType. The array of operations provided in transaction construction often times can not specify all "effects" of a transaction (consider invoked transactions in Ethereum). However, they can deterministically specify the "intent" of the transaction, which is sufficient for construction. For this reason, parsing the corresponding transaction in the Data API (when it lands on chain) will contain a superset of whatever operations were provided during construction. operationId: constructionPayloads tags: - Construction @@ -348,7 +348,7 @@ paths: /construction/combine: post: summary: Create Network Transaction from Signatures - description: Combine creates a network-specific signed transaction from an unsigned transaction blob (the CBOR transaction body from `/construction/payloads`) and an array of provided signatures (typically forming a Cardano `TransactionWitnessSet`). The signed transaction returned (the full CBOR transaction including body and witness set) will be sent to the `/construction/submit` endpoint by the caller. + description: Combine creates a network-specific transaction from an unsigned transaction and an array of provided signatures. The signed transaction returned from this method will be sent to the `/construction/submit` endpoint by the caller. operationId: constructionCombine tags: - Construction @@ -374,7 +374,7 @@ paths: /construction/parse: post: summary: Parse a Transaction - description: 'Parse is called on both unsigned (CBOR tx body) and signed (CBOR full tx) Cardano transactions to understand the intent and verify signers. This is run as a sanity check before signing (after `/construction/payloads`) and before broadcast (after `/construction/combine`). The response should detail the operations (inputs, outputs, certificates, withdrawals, minting) and the required/provided signers.' + description: 'Parse is called on both unsigned and signed transactions to understand the intent of the formulated transaction. This is run as a sanity check before signing (after `/construction/payloads`) and before broadcast (after `/construction/combine`). ' operationId: constructionParse tags: - Construction @@ -400,7 +400,7 @@ paths: /construction/hash: post: summary: Get the Hash of a Signed Transaction - description: TransactionHash returns the network-specific transaction hash (typically Blake2b-256 of the CBOR transaction body) for a signed Cardano transaction (CBOR full transaction including body and witnesses). + description: TransactionHash returns the network-specific transaction hash for a signed transaction. operationId: constructionHash tags: - Construction @@ -426,7 +426,7 @@ paths: /construction/submit: post: summary: Submit a Signed Transaction - description: Submit a pre-signed Cardano transaction (full CBOR transaction) to the node. This call should not block on the transaction being included in a block. Rather, it should return immediately with an indication of whether or not the transaction was accepted into the mempool. The transaction submission response should only return a 200 status if the submitted transaction could be included in the mempool. Otherwise, it should return an error detailing the rejection reason (e.g., invalid TTL, fee too low, validation error). + description: Submit a pre-signed transaction to the node. This call should not block on the transaction being included in a block. Rather, it should return immediately with an indication of whether or not the transaction was included in the mempool. The transaction submission response should only return a 200 status if the submitted transaction could be included in the mempool. Otherwise, it should return an error. operationId: constructionSubmit tags: - Construction @@ -449,62 +449,62 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' - # /call: - # post: - # summary: Make a Network-Specific Procedure Call - # description: Call invokes an arbitrary, network-specific procedure call with network-specific parameters. The guidance for what this endpoint should or could do is purposely left vague. In Ethereum, this could be used to invoke `eth_call` to implement an entire Rosetta API interface for some smart contract that is not parsed by the implementation creator (like a DEX). This endpoint could also be used to provide access to data that does not map to any Rosetta models instead of requiring an integrator to use some network-specific SDK and call some network-specific endpoint (like surfacing staking parameters). Call is NOT a replacement for implementing Rosetta API endpoints or mapping network-specific data to Rosetta models. Rather, it enables developers to build additional Rosetta API interfaces for things they care about without introducing complexity into a base-level Rosetta implementation. Simply put, imagine that the average integrator will use layered Rosetta API implementations that each surfaces unique data. - # operationId: call - # tags: - # - Call - # requestBody: - # required: true - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/CallRequest' - # responses: - # '200': - # description: Expected response to a valid request - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/CallResponse' - # '500': - # description: unexpected error - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/Error' - # /events/blocks: - # post: - # summary: '[INDEXER] Get a range of BlockEvents' - # description: '`/events/blocks` allows the caller to query a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. Following BlockEvents allows lightweight clients to update their state without needing to implement their own syncing logic (like finding the common parent in a reorg). `/events/blocks` is considered an "indexer" endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' - # operationId: eventsBlocks - # tags: - # - Events - # requestBody: - # required: true - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/EventsBlocksRequest' - # responses: - # '200': - # description: Expected response to a valid request - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/EventsBlocksResponse' - # '500': - # description: unexpected error - # content: - # application/json: - # schema: - # $ref: '#/components/schemas/Error' + /call: + post: + summary: Make a Network-Specific Procedure Call + description: Call invokes an arbitrary, network-specific procedure call with network-specific parameters. The guidance for what this endpoint should or could do is purposely left vague. In Ethereum, this could be used to invoke `eth_call` to implement an entire Rosetta API interface for some smart contract that is not parsed by the implementation creator (like a DEX). This endpoint could also be used to provide access to data that does not map to any Rosetta models instead of requiring an integrator to use some network-specific SDK and call some network-specific endpoint (like surfacing staking parameters). Call is NOT a replacement for implementing Rosetta API endpoints or mapping network-specific data to Rosetta models. Rather, it enables developers to build additional Rosetta API interfaces for things they care about without introducing complexity into a base-level Rosetta implementation. Simply put, imagine that the average integrator will use layered Rosetta API implementations that each surfaces unique data. + operationId: call + tags: + - Call + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CallRequest' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CallResponse' + '500': + description: unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + /events/blocks: + post: + summary: '[INDEXER] Get a range of BlockEvents' + description: '`/events/blocks` allows the caller to query a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. Following BlockEvents allows lightweight clients to update their state without needing to implement their own syncing logic (like finding the common parent in a reorg). `/events/blocks` is considered an "indexer" endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' + operationId: eventsBlocks + tags: + - Events + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsBlocksRequest' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EventsBlocksResponse' + '500': + description: unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' /search/transactions: post: summary: '[INDEXER] Search for Transactions' - description: '`/search/transactions` allows the caller to search for transactions that meet certain conditions within canonical blocks. Conditions can include matching a transaction hash, involving a specific address (`AccountIdentifier.Address`), containing operations of a specific type (e.g., `StakeDelegation`) or status, or involving a specific native asset (`Currency`). `/search/transactions` is considered an indexer endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' + description: '`/search/transactions` allows the caller to search for transactions that meet certain conditions. Some conditions include matching a transaction hash, containing an operation with a certain status, or containing an operation that affects a certain account. `/search/transactions` is considered an "indexer" endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.' operationId: searchTransactions tags: - Search @@ -538,11 +538,26 @@ components: properties: blockchain: type: string - example: cardano + example: bitcoin network: - description: This field contains the specific network identifier for the blockchain, such as 'mainnet', 'preprod', or 'preview' for Cardano. This helps identify which network you are connecting to. + description: If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet. type: string example: mainnet + sub_network_identifier: + $ref: '#/components/schemas/SubNetworkIdentifier' + SubNetworkIdentifier: + description: In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains. + type: object + required: + - network + properties: + network: + type: string + example: shard 1 + metadata: + type: object + example: + producer: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' BlockIdentifier: description: The block_identifier uniquely identifies a block in a particular network. type: object @@ -554,10 +569,10 @@ components: description: This is also known as the block height. type: integer format: int64 - example: 11832620 + example: 1123941 hash: type: string - example: '4797bd63a225277231bd02f87be986c33a1ff61eb12681fb5eaa5620f638fa05' + example: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85' description: This should be normalized according to the case specified in the block_hash_case network options. PartialBlockIdentifier: type: object @@ -566,10 +581,10 @@ components: index: type: integer format: int64 - example: 3430923 + example: 1123941 hash: type: string - example: '7985774c96490dfcde55b80523ac4c2dc27243a479ee8d236800ed4e1773fd8b' + example: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85' TransactionIdentifier: description: The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool. type: object @@ -579,7 +594,7 @@ components: hash: description: 'Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier. This should be normalized according to the case specified in the transaction_hash_case in network options.' type: string - example: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73' + example: '0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f' OperationIdentifier: description: The operation_identifier uniquely identifies an operation within a transaction. type: object @@ -599,7 +614,7 @@ components: minimum: 0 example: 0 AccountIdentifier: - description: The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated). For Cardano, the `address` field typically contains the bech32 payment address (`addr...`). The associated stake address (`stake...`) might be derivable or stored/queried separately, potentially indicated via `metadata` or specific API calls if supported. Implementations should clarify how stake addresses and rewards are handled. + description: The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated). type: object required: - address @@ -607,25 +622,23 @@ components: address: description: The address may be a cryptographic public key (or some encoding of it) or a provided username. type: string - example: 'addr1qxx6qfrre0mynlmcst5wj3h0flk093zjx9wl86k6gnksztp693mm58mml2ckdm09rgycahv5ex68c36a7kp4r2sgcx7q3rqcx8' - # Not implemented for Cardano - #sub_account: - # $ref: '#/components/schemas/SubAccountIdentifier' + example: '0x3a065000ab4183c6bf581dc1e55a605455fc6d61' + sub_account: + $ref: '#/components/schemas/SubAccountIdentifier' + metadata: + $ref: '#/components/schemas/AccountIdentifierMetadata' + SubAccountIdentifier: + description: An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to. + type: object + required: + - address + properties: + address: + description: 'The SubAccount address may be a cryptographic value or some other identifier (ex: bonded) that uniquely specifies a SubAccount.' + type: string + example: '0x6b175474e89094c44da98b954eedeac495271d0f' metadata: $ref: '#/components/schemas/AccountIdentifierMetadata' - # Not implemented for Cardano - # SubAccountIdentifier: - # description: An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to. - # type: object - # required: - # - address - # properties: - # address: - # description: 'The SubAccount address may be a cryptographic value or some other identifier (ex: bonded) that uniquely specifies a SubAccount.' - # type: string - # example: '0x6b175474e89094c44da98b954eedeac495271d0f' - # metadata: - # $ref: '#/components/schemas/AccountIdentifierMetadata' Block: description: 'Blocks contain an array of Transactions that occurred at a particular BlockIdentifier. A hard requirement for blocks returned by Rosetta implementations is that they MUST be _inalterable_: once a client has requested and received a block identified by a specific BlockIndentifier, all future calls for that same BlockIdentifier must return the same block contents.' type: object @@ -647,84 +660,6 @@ components: $ref: '#/components/schemas/Transaction' metadata: $ref: '#/components/schemas/BlockMetadata' - example: - block_identifier: - index: 11832620 - hash: '4797bd63a225277231bd02f87be986c33a1ff61eb12681fb5eaa5620f638fa05' - parent_block_identifier: - index: 11832619 - hash: 'b5781a495eb21b613136fe09a19321c9a9f7fa8978e8d26105e3306287061625' - timestamp: 1746607844000 - transactions: - - transaction_identifier: - hash: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73' - operations: - - operation_identifier: - index: 0 - type: 'input' - status: 'success' - account: - address: 'addr1q8n85ymr09p8czlya59z5k6vyrfuhmg0zf3vfll46jqn25pgjy6j9tzkpzlupfjgmssf25nkudk6dk8nraesvygnntjs3m5fnu' - amount: - value: '-3000000' - currency: - symbol: 'ADA' - decimals: 6 - coin_change: - coin_identifier: - identifier: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' - coin_action: 'coin_spent' - metadata: - tokenBundle: - - policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' - tokens: - - value: '-161333000000' - currency: - symbol: '41474958' - decimals: 0 - - operation_identifier: - index: 1 - type: 'input' - status: 'success' - account: - address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' - amount: - value: '-502066491' - currency: - symbol: 'ADA' - decimals: 6 - coin_change: - coin_identifier: - identifier: 'f81b467c4c23af80d498956ea0540427a325cb87e0881b1d8a3d63d47d17fa2d:0' - coin_action: 'coin_spent' - - operation_identifier: - index: 2 - network_index: 0 - related_operations: - - index: 0 - - index: 1 - type: 'output' - status: 'success' - account: - address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' - amount: - value: '504663471' - currency: - symbol: 'ADA' - decimals: 6 - coin_change: - coin_identifier: - identifier: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73:0' - coin_action: 'coin_created' - metadata: - size: 503 - scriptSize: 2932 - metadata: - transactionsCount: 1 - createdBy: '2a748e3885f6f73320ad16a8331247b81fe01b8d39f57eec9caa5091' - size: 3674 - epochNo: 556 - slotNo: 155041553 Transaction: description: Transactions contain an array of Operations that are attributable to the same TransactionIdentifier. type: object @@ -744,70 +679,6 @@ components: $ref: '#/components/schemas/RelatedTransaction' metadata: $ref: '#/components/schemas/TransactionMetadata' - example: - transaction_identifier: - hash: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73' - operations: - - operation_identifier: - index: 0 - type: 'input' - status: 'success' - account: - address: 'addr1q8n85ymr09p8czlya59z5k6vyrfuhmg0zf3vfll46jqn25pgjy6j9tzkpzlupfjgmssf25nkudk6dk8nraesvygnntjs3m5fnu' - amount: - value: '-3000000' - currency: - symbol: 'ADA' - decimals: 6 - coin_change: - coin_identifier: - identifier: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' - coin_action: 'coin_spent' - metadata: - tokenBundle: - - policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' - tokens: - - value: '-161333000000' - currency: - symbol: '41474958' - decimals: 0 - - operation_identifier: - index: 1 - type: 'input' - status: 'success' - account: - address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' - amount: - value: '-502066491' - currency: - symbol: 'ADA' - decimals: 6 - coin_change: - coin_identifier: - identifier: 'f81b467c4c23af80d498956ea0540427a325cb87e0881b1d8a3d63d47d17fa2d:0' - coin_action: 'coin_spent' - - operation_identifier: - index: 2 - network_index: 0 - related_operations: - - index: 0 - - index: 1 - type: 'output' - status: 'success' - account: - address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' - amount: - value: '504663471' - currency: - symbol: 'ADA' - decimals: 6 - coin_change: - coin_identifier: - identifier: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73:0' - coin_action: 'coin_created' - metadata: - size: 503 - scriptSize: 2932 Operation: description: Operations contain all balance-changing information within a transaction. They are always one-sided (only affect 1 AccountIdentifier) and can succeed or fail independently from a Transaction. Operations are used both to represent on-chain data (Data API) and to construct new transactions (Construction API), creating a standard interface for reading and writing to blockchains. type: object @@ -823,16 +694,16 @@ components: items: $ref: '#/components/schemas/OperationIdentifier' example: - - index: 0 - index: 1 + - index: 2 type: description: Type is the network-specific type of the operation. Ensure that any type that can be returned here is also specified in the NetworkOptionsResponse. This can be very useful to downstream consumers that parse all block data. type: string - example: input + example: Transfer status: - description: Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. Cardano transactions are generally atomic; they either succeed entirely and are included in a block or fail validation and are rejected. Therefore, the status for operations within a block transaction will typically be a single success value defined in NetworkOptionsResponse. On-chain operations (operations retrieved in the `/block` and `/block/transaction` endpoints) MUST have a populated status field. Operations provided during transaction construction (often called "intent") MUST NOT have a populated status field. + description: Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. On-chain operations (operations retrieved in the `/block` and `/block/transaction` endpoints) MUST have a populated status field (anything on-chain must have succeeded or failed). However, operations provided during transaction construction (often times called "intent" in the documentation) MUST NOT have a populated status field (operations yet to be included on-chain have not yet succeeded or failed). type: string - example: success + example: Reverted account: $ref: '#/components/schemas/AccountIdentifier' amount: @@ -851,18 +722,13 @@ components: value: description: Value of the transaction in atomic units represented as an arbitrary-sized signed integer. For example, 1 BTC would be represented by a value of 100000000. type: string - example: '-3000000' + example: '1238089899992' currency: $ref: '#/components/schemas/Currency' metadata: type: object - example: - value: '-3000000' - currency: - symbol: 'ADA' - decimals: 6 Currency: - description: Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (e.g., Lovelace for ADA) to standard units (e.g., ADA). For Cardano native assets, the `symbol` is often the asset name (or hex-encoded name), `decimals` is 0, and `metadata` contains the `policyId` and potentially the human-readable `assetName`. + description: Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins). type: object required: - symbol @@ -871,18 +737,15 @@ components: symbol: description: Canonical symbol associated with a currency. type: string - example: 'ADA' + example: BTC decimals: - description: Number of decimal places in the standard unit representation of the amount. For example, ADA has 6 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10. + description: Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10. type: integer format: int32 minimum: 0 - example: 6 + example: 8 metadata: $ref: '#/components/schemas/CurrencyMetadata' - example: - symbol: 'ADA' - decimals: 6 SyncStatus: description: SyncStatus is used to provide additional context about an implementation's sync status. This object is often used by implementations to indicate healthiness when block data cannot be queried until some sync phase completes or cannot be determined by comparing the timestamp of the most recent block with the current time. type: object @@ -896,11 +759,11 @@ components: description: TargetIndex is the index of the block that the implementation is attempting to sync to in the current stage. type: integer format: int64 - example: 3430923 - #stage: # TODO: Add stage property to SyncStatus - # description: Stage is the phase of the sync process. - # type: string - # example: header sync + example: 150 + stage: + description: Stage is the phase of the sync process. + type: string + example: header sync synced: description: synced is a boolean that indicates if an implementation has synced up to the most recent block. If this field is not populated, the caller should rely on a traditional tip timestamp comparison to determine if an implementation is synced. This field is particularly useful for quiescent blockchains (blocks only produced when there are pending transactions). In these blockchains, the most recent block could have a timestamp far behind the current time but the node could be healthy and at tip. type: boolean @@ -912,7 +775,7 @@ components: properties: peer_id: type: string - example: '' # TODO: Add a proper example for peer_id (issue #450) + example: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' metadata: type: object Version: @@ -925,19 +788,18 @@ components: rosetta_version: description: The rosetta_version is the version of the Rosetta interface the implementation adheres to. This can be useful for clients looking to reliably parse responses. type: string - example: 1.4.13 + example: 1.2.5 node_version: description: The node_version is the canonical version of the node runtime. This can help clients manage deployments. type: string - example: 10.2.1 + example: 1.0.2 middleware_version: description: When a middleware server is used to adhere to the Rosetta interface, it should return its version here. This can help clients manage deployments. type: string - example: 1.2.8 + example: 0.2.7 metadata: description: Any other information that may be useful about versioning of dependent services should be returned here. type: object - example: {} Allow: description: Allow specifies supported Operation status, Operation types, and all possible error statuses. This Allow object is used by clients to validate the correctness of a Rosetta Server implementation. It is expected that these clients will error if they receive some response that contains any of the above information that is not specified here. type: object @@ -951,205 +813,24 @@ components: - mempool_coins properties: operation_statuses: - description: All Operation.Status this implementation supports. For Cardano, typically only a single status representing success is needed for block transactions, as failed transactions are usually rejected by the node before inclusion. + description: All Operation.Status this implementation supports. Any status that is returned during parsing that is not listed here will cause client validation to error. type: array items: $ref: '#/components/schemas/OperationStatus' - example: - - status: success - successful: true operation_types: - description: All Operation.Type this implementation supports (input, output, stakeKeyRegistration, stakeDelegation, withdrawal, stakeKeyDeregistration, poolRegistration, poolRegistrationWithCert, poolRetirement, voteRegistration, dRepVoteDelegation). This is crucial for Cardano, which has many distinct operation types beyond simple transfers. + description: All Operation.Type this implementation supports. Any type that is returned during parsing that is not listed here will cause client validation to error. type: array items: type: string - example: - - 'input' - - 'output' - - 'stakeKeyRegistration' - - 'stakeDelegation' - - 'withdrawal' - - 'stakeKeyDeregistration' - - 'poolRegistration' - - 'poolRegistrationWithCert' - - 'poolRetirement' - - 'voteRegistration' - - 'dRepVoteDelegation' + example: TRANSFER errors: - description: All Errors that this implementation could return. Include Cardano-specific transaction submission errors and node query errors. + description: All Errors that this implementation could return. Any error that is returned during parsing that is not listed here will cause client validation to error. type: array items: $ref: '#/components/schemas/Error' - example: # Add relevant Cardano error examples - - code: 4001 - message: 'Block not found' - retriable: false - - code: 4002 - message: 'Network not found' - retriable: false - - code: 4003 - message: 'Networks not found' - retriable: false - - code: 4004 - message: 'Invalid blockchain' - retriable: false - - code: 4005 - message: 'Genesis block not found' - retriable: false - - code: 4006 - message: 'Transaction not found' - retriable: false - - code: 4007 - message: 'Invalid public key format' - retriable: false - - code: 4008 - message: 'Transaction inputs parameters errors in operations array' - retriable: false - - code: 4009 - message: 'Transaction outputs parameters errors in operations array' - retriable: false - - code: 4010 - message: 'The transaction you are trying to build has more outputs than inputs' - retriable: false - - code: 4011 - message: 'Cant create signed transaction from transaction bytes' - retriable: false - - code: 4012 - message: 'Cant create unsigned transaction from transaction bytes' - retriable: false - - code: 4013 - message: 'Cant deserialize transaction input from transaction body' - retriable: false - - code: 4014 - message: 'Cant deserialize transaction output from transaction body' - retriable: false - - code: 4015 - message: 'Provided address is invalid' - retriable: true - - code: 4016 - message: 'Provided address type is invalid' - retriable: true - - code: 4017 - message: 'Invalid staking key format' - retriable: false - - code: 4018 - message: 'Staking key is required for this type of address' - retriable: false - - code: 4019 - message: 'Provided operation type is invalid' - retriable: true - - code: 4020 - message: 'Pool key hash is required to operate' - retriable: false - - code: 4021 - message: 'Assets are required for output operation token bundle' - retriable: false - - code: 4022 - message: 'Asset value is required for token asset' - retriable: false - - code: 4023 - message: 'Invalid policy id' - retriable: false - - code: 4024 - message: 'Invalid token name' - retriable: false - - code: 4025 - message: 'Provided pool key hash has invalid format' - retriable: false - - code: 4026 - message: 'Pool registration certificate is required for pool registration' - retriable: false - - code: 4027 - message: 'Invalid pool registration certificate format' - retriable: false - - code: 4028 - message: 'Invalid certificate type. Expected pool registration certificate' - retriable: false - - code: 4029 - message: 'Pool registration parameters were expected' - retriable: false - - code: 4030 - message: 'Pool relays are invalid' - retriable: false - - code: 4031 - message: 'Pool metadata is invalid' - retriable: false - - code: 4032 - message: 'Dns name expected for pool relay' - retriable: false - - code: 4033 - message: 'Invalid pool relay type received' - retriable: false - - code: 4034 - message: 'Invalid pool owners received' - retriable: false - - code: 4035 - message: 'Invalid pool registration parameters received' - retriable: false - - code: 4036 - message: 'Mandatory parameter is missing: Epoch' - retriable: false - - code: 4037 - message: 'Error when sending the transaction - OutsideValidityIntervalUTxO' - retriable: false - - code: 5000 - message: 'An error occurred' - retriable: true - - code: 5001 - message: 'Not implemented' - retriable: false - - code: 5002 - message: 'Address generation error' - retriable: false - - code: 5003 - message: 'Parse signed transaction error' - retriable: false - - code: 5004 - message: 'Cant create signed transaction probably because of unsigned transaction bytes' - retriable: false - - code: 5005 - message: 'Cant build witnesses set for transaction probably because of provided signatures' - retriable: false - - code: 5006 - message: 'Error when sending the transaction' - retriable: true - - code: 5007 - message: 'Voting nonce not valid' - retriable: false - - code: 5008 - message: 'Invalid voting signature' - retriable: false - - code: 5009 - message: 'Voting key is missing' - retriable: false - - code: 5010 - message: 'Voting key format is invalid' - retriable: false - - code: 5011 - message: 'Missing vote registration metadata' - retriable: false - - code: 5012 - message: 'Missing chain code' - retriable: false - - code: 5013 - message: 'Invalid operation status' - retriable: false - - code: 5014 - message: 'Given operation status and success state does not match' - retriable: false - - code: 5015 - message: 'Transaction hash does not match to given coin identifier' - retriable: false - - code: 5016 - message: 'Address and account identifier does not match' - retriable: false - - code: 5017 - message: 'Coin identifier has an invalid format' - retriable: false historical_balance_lookup: type: boolean description: Any Rosetta implementation that supports querying the balance of an account at any height in the past should set this to true. - example: true timestamp_start_index: type: integer format: int64 @@ -1160,22 +841,18 @@ components: description: All methods that are supported by the /call endpoint. Communicating which parameters should be provided to /call is the responsibility of the implementer (this is en lieu of defining an entire type system and requiring the implementer to define that in Allow). items: type: string - example: [] + example: eth_call balance_exemptions: type: array description: BalanceExemptions is an array of BalanceExemption indicating which account balances could change without a corresponding Operation. BalanceExemptions should be used sparingly as they may introduce significant complexity for integrators that attempt to reconcile all account balance changes. If your implementation relies on any BalanceExemptions, you MUST implement historical balance lookup (the ability to query an account balance at any BlockIdentifier). items: $ref: '#/components/schemas/BalanceExemption' - example: [] mempool_coins: type: boolean description: Any Rosetta implementation that can update an AccountIdentifier's unspent coins based on the contents of the mempool should populate this field as true. If false, requests to `/account/coins` that set `include_mempool` as true will be automatically rejected. - example: false - # TODO: Verify if block_hash_case is implemented block_hash_case: $ref: '#/components/schemas/Case' description: This specifies the normalized case for block hash in the BlockIdentifier. If not specified, it's assumed to be case sensitive. - # TODO: Verify if transaction_hash_case is implemented transaction_hash_case: $ref: '#/components/schemas/Case' description: This specifies the normalized case for transaction hash in the TransactionIdentifier. If not specified, it's assumed to be case sensitive. @@ -1200,7 +877,7 @@ components: type: integer format: int64 minimum: 0 - example: 1746607844000 + example: 1582833600000 PublicKey: description: PublicKey contains a public key byte array for a particular CurveType encoded in hex. Note that there is no PrivateKey struct as this is NEVER the concern of an implementation. type: object @@ -1281,7 +958,7 @@ components: identifier: description: Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction_hash:index. type: string - example: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' + example: 0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f:1 CoinChange: description: CoinChange is used to represent a change in state of a some coin identified by a coin_identifier. This object is part of the Operation model and must be populated for UTXO-based blockchains. Coincidentally, this abstraction of UTXOs allows for supporting both account-based transfers and UTXO-based transfers on the same blockchain (when a transfer is account-based, don't populate this model). type: object @@ -1293,10 +970,6 @@ components: $ref: '#/components/schemas/CoinIdentifier' coin_action: $ref: '#/components/schemas/CoinAction' - example: - coin_identifier: - identifier: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' - coin_action: 'coin_spent' Coin: description: Coin contains its unique identifier and the amount it represents. type: object @@ -1310,7 +983,6 @@ components: $ref: '#/components/schemas/Amount' metadata: $ref: '#/components/schemas/CoinMetadata' - # TODO: Verify if BalanceExemption is implemented BalanceExemption: description: BalanceExemption indicates that the balance for an exempt account could change without a corresponding Operation. This typically occurs with staking rewards, vesting balances, and Currencies with a dynamic supply. Currently, it is possible to exempt an account from strict reconciliation by SubAccountIdentifier.Address or by Currency. This means that any account with SubAccountIdentifier.Address would be exempt or any balance of a particular Currency would be exempt, respectively. BalanceExemptions should be used sparingly as they may introduce significant complexity for integrators that attempt to reconcile all account balance changes. If your implementation relies on any BalanceExemptions, you MUST implement historical balance lookup (the ability to query an account balance at any BlockIdentifier). type: object @@ -1330,31 +1002,30 @@ components: - greater_or_equal - less_or_equal - dynamic - # Not implemented for Cardano - # BlockEvent: - # description: BlockEvent represents the addition or removal of a BlockIdentifier from storage. Streaming BlockEvents allows lightweight clients to update their own state without needing to implement their own syncing logic. - # type: object - # required: - # - sequence - # - block_identifier - # - type - # properties: - # sequence: - # description: sequence is the unique identifier of a BlockEvent within the context of a NetworkIdentifier. - # type: integer - # format: int64 - # minimum: 0 - # example: 5 - # block_identifier: - # $ref: '#/components/schemas/BlockIdentifier' - # type: - # $ref: '#/components/schemas/BlockEventType' - # BlockEventType: - # description: BlockEventType determines if a BlockEvent represents the addition or removal of a block. - # type: string - # enum: - # - block_added - # - block_removed + BlockEvent: + description: BlockEvent represents the addition or removal of a BlockIdentifier from storage. Streaming BlockEvents allows lightweight clients to update their own state without needing to implement their own syncing logic. + type: object + required: + - sequence + - block_identifier + - type + properties: + sequence: + description: sequence is the unique identifier of a BlockEvent within the context of a NetworkIdentifier. + type: integer + format: int64 + minimum: 0 + example: 5 + block_identifier: + $ref: '#/components/schemas/BlockIdentifier' + type: + $ref: '#/components/schemas/BlockEventType' + BlockEventType: + description: BlockEventType determines if a BlockEvent represents the addition or removal of a block. + type: string + enum: + - block_added + - block_removed Operator: description: Operator is used by query-related endpoints to determine how to apply conditions. If this field is not populated, the default `and` value will be used. type: string @@ -1419,22 +1090,6 @@ components: description: In some cases, the caller may not want to retrieve all available balances for an AccountIdentifier. If the currencies field is populated, only balances for the specified currencies will be returned. If not populated, all available balances will be returned. items: $ref: '#/components/schemas/Currency' - example: - network_identifier: - blockchain: 'cardano' - network: 'mainnet' - account_identifier: - address: 'addr1qxx6qfrre0mynlmcst5wj3h0flk093zjx9wl86k6gnksztp693mm58mml2ckdm09rgycahv5ex68c36a7kp4r2sgcx7q3rqcx8' - block_identifier: - index: 11835193 - hash: '63a22fe4206c78794a54d5837e0f35d93f3c6eedb8689bcc73842795e3f425cd' - currencies: - - symbol: 'ADA' - decimals: 6 - - symbol: '0014df1047454e53' - decimals: 0 - metadata: - policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' AccountBalanceResponse: description: 'An AccountBalanceResponse is returned on the /account/balance endpoint. If an account has a balance for each AccountIdentifier describing it (ex: an ERC-20 token balance on a few smart contracts), an account balance request must be made with each AccountIdentifier. The `coins` field was removed and replaced by by `/account/coins` in `v1.4.7`.' type: object @@ -1449,27 +1104,11 @@ components: description: A single account may have a balance in multiple currencies. items: $ref: '#/components/schemas/Amount' - # Not implemented for Cardano - # metadata: - # description: Account-based blockchains that utilize a nonce or sequence number should include that number in the metadata. This number could be unique to the identifier or global across the account address. - # type: object - # example: - # sequence_number: 23 - example: - block_identifier: - index: 11835193 - hash: '63a22fe4206c78794a54d5837e0f35d93f3c6eedb8689bcc73842795e3f425cd' - balances: - - value: '1988397' - currency: - symbol: 'ADA' - decimals: 6 - - value: '60000000000' - currency: - symbol: '0014df1047454e53' - decimals: 0 - metadata: - policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' + metadata: + description: Account-based blockchains that utilize a nonce or sequence number should include that number in the metadata. This number could be unique to the identifier or global across the account address. + type: object + example: + sequence_number: 23 AccountCoinsRequest: description: AccountCoinsRequest is utilized to make a request on the /account/coins endpoint. type: object @@ -1481,29 +1120,15 @@ components: $ref: '#/components/schemas/NetworkIdentifier' account_identifier: $ref: '#/components/schemas/AccountIdentifier' - # Not implemented for Cardano - # include_mempool: - # type: boolean - # default: false - # description: Include state from the mempool when looking up an account's unspent coins. Note, using this functionality breaks any guarantee of idempotency. + include_mempool: + type: boolean + default: false + description: Include state from the mempool when looking up an account's unspent coins. Note, using this functionality breaks any guarantee of idempotency. currencies: type: array description: In some cases, the caller may not want to retrieve coins for all currencies for an AccountIdentifier. If the currencies field is populated, only coins for the specified currencies will be returned. If not populated, all unspent coins will be returned. items: $ref: '#/components/schemas/Currency' - example: - network_identifier: - blockchain: 'cardano' - network: 'mainnet' - account_identifier: - address: 'addr1qxx6qfrre0mynlmcst5wj3h0flk093zjx9wl86k6gnksztp693mm58mml2ckdm09rgycahv5ex68c36a7kp4r2sgcx7q3rqcx8' - currencies: - - symbol: 'ADA' - decimals: 6 - - symbol: '0014df1047454e53' - decimals: 0 - metadata: - policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' AccountCoinsResponse: description: AccountCoinsResponse is returned on the /account/coins endpoint and includes all unspent Coins owned by an AccountIdentifier. type: object @@ -1523,28 +1148,6 @@ components: type: object example: sequence_number: 23 - example: - block_identifier: - index: 11835240 - hash: 'ade2395f21cc26ebfb86c1e74fd910193902a87b289be18b67a3903813141b39' - coins: - - coin_identifier: - identifier: '82014e975b195c77d296fa1c8947c4614bb6392ade219dffb47b2fdda88f837f:1' - amount: - value: '1988397' - currency: - symbol: 'ADA' - decimals: 6 - metadata: - '82014e975b195c77d296fa1c8947c4614bb6392ade219dffb47b2fdda88f837f:1': # The metadata key here is the coin_identifier.identifier, this needs to be reflected in the CoinMetadata schema or a specific Coin.metadata schema - - policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' - tokens: - - value: '60000000000' - currency: - symbol: '0014df1047454e53' - decimals: 0 - metadata: - policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' BlockRequest: description: A BlockRequest is utilized to make a block request on the /block endpoint. type: object @@ -1563,89 +1166,10 @@ components: block: $ref: '#/components/schemas/Block' other_transactions: - description: "Some blockchains may require additional transactions to be fetched that weren't returned in the block response (ex: block only returns transaction hashes). For blockchains with a lot of transactions in each block, this can be very useful as consumers can concurrently fetch all transactions returned." + description: 'Some blockchains may require additional transactions to be fetched that weren''t returned in the block response (ex: block only returns transaction hashes). For blockchains with a lot of transactions in each block, this can be very useful as consumers can concurrently fetch all transactions returned.' type: array items: $ref: '#/components/schemas/TransactionIdentifier' - example: - block: - block_identifier: - index: 11832620 - hash: '4797bd63a225277231bd02f87be986c33a1ff61eb12681fb5eaa5620f638fa05' - parent_block_identifier: - index: 11832619 - hash: 'b5781a495eb21b613136fe09a19321c9a9f7fa8978e8d26105e3306287061625' - timestamp: 1746607844000 - transactions: - - transaction_identifier: - hash: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73' - operations: - - operation_identifier: - index: 0 - type: 'input' - status: 'success' - account: - address: 'addr1q8n85ymr09p8czlya59z5k6vyrfuhmg0zf3vfll46jqn25pgjy6j9tzkpzlupfjgmssf25nkudk6dk8nraesvygnntjs3m5fnu' - amount: - value: '-3000000' - currency: - symbol: 'ADA' - decimals: 6 - coin_change: - coin_identifier: - identifier: '48163f224d387426bf05c0a22a2415a7e071602e717aeb43ce46d7909ee5ba46:0' - coin_action: 'coin_spent' - metadata: - tokenBundle: - - policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' - tokens: - - value: '-161333000000' - currency: - symbol: '41474958' - decimals: 0 - - operation_identifier: - index: 1 - type: 'input' - status: 'success' - account: - address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' - amount: - value: '-502066491' - currency: - symbol: 'ADA' - decimals: 6 - coin_change: - coin_identifier: - identifier: 'f81b467c4c23af80d498956ea0540427a325cb87e0881b1d8a3d63d47d17fa2d:0' - coin_action: 'coin_spent' - - operation_identifier: - index: 2 - network_index: 0 - related_operations: - - index: 0 - - index: 1 - type: 'output' - status: 'success' - account: - address: 'addr1q9alhvsg2v0frsx4a020jhmsh4jurlfxay5rq5x7d694cmcln5rrwydxdct67zxv62ue507wzevh2357hyusmxnz7aysqaa8q7' - amount: - value: '504663471' - currency: - symbol: 'ADA' - decimals: 6 - coin_change: - coin_identifier: - identifier: 'a4020acf2e7d743dda705593c758295ebe46b31e61b970797ace0524ffbbdc73:0' - coin_action: 'coin_created' - metadata: - size: 503 - scriptSize: 2932 - metadata: - transactionsCount: 1 - createdBy: '2a748e3885f6f73320ad16a8331247b81fe01b8d39f57eec9caa5091' - size: 3674 - epochNo: 556 - slotNo: 155041553 BlockTransactionRequest: description: A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse. type: object @@ -1668,41 +1192,40 @@ components: properties: transaction: $ref: '#/components/schemas/Transaction' - # Not implemented for Cardano - # MempoolResponse: - # description: A MempoolResponse contains all transaction identifiers in the mempool for a particular network_identifier. - # type: object - # required: - # - transaction_identifiers - # properties: - # transaction_identifiers: - # type: array - # items: - # $ref: '#/components/schemas/TransactionIdentifier' - # MempoolTransactionRequest: - # description: A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool. - # type: object - # required: - # - network_identifier - # - transaction_identifier - # properties: - # network_identifier: - # $ref: '#/components/schemas/NetworkIdentifier' - # transaction_identifier: - # $ref: '#/components/schemas/TransactionIdentifier' - # MempoolTransactionResponse: - # description: 'A MempoolTransactionResponse contains an estimate of a mempool transaction. It may not be possible to know the full impact of a transaction in the mempool (ex: fee paid).' - # type: object - # required: - # - transaction - # properties: - # transaction: - # $ref: '#/components/schemas/Transaction' - # metadata: - # type: object - # example: - # descendant_fees: 123923 - # ancestor_count: 2 + MempoolResponse: + description: A MempoolResponse contains all transaction identifiers in the mempool for a particular network_identifier. + type: object + required: + - transaction_identifiers + properties: + transaction_identifiers: + type: array + items: + $ref: '#/components/schemas/TransactionIdentifier' + MempoolTransactionRequest: + description: A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool. + type: object + required: + - network_identifier + - transaction_identifier + properties: + network_identifier: + $ref: '#/components/schemas/NetworkIdentifier' + transaction_identifier: + $ref: '#/components/schemas/TransactionIdentifier' + MempoolTransactionResponse: + description: 'A MempoolTransactionResponse contains an estimate of a mempool transaction. It may not be possible to know the full impact of a transaction in the mempool (ex: fee paid).' + type: object + required: + - transaction + properties: + transaction: + $ref: '#/components/schemas/Transaction' + metadata: + type: object + example: + descendant_fees: 123923 + ancestor_count: 2 MetadataRequest: description: A MetadataRequest is utilized in any request where the only argument is optional metadata. type: object @@ -1743,15 +1266,14 @@ components: $ref: '#/components/schemas/Timestamp' genesis_block_identifier: $ref: '#/components/schemas/BlockIdentifier' - #oldest_block_identifier: # TODO: Add oldest_block_identifier property to NetworkStatusResponse (issue #439) - # description: Not implemented. - # $ref: '#/components/schemas/BlockIdentifier' + oldest_block_identifier: + $ref: '#/components/schemas/BlockIdentifier' sync_status: $ref: '#/components/schemas/SyncStatus' - #peers: # TODO: Fix empty peers property in NetworkStatusResponse (issue #450) - # type: array - # items: - # $ref: '#/components/schemas/Peer' + peers: + type: array + items: + $ref: '#/components/schemas/Peer' NetworkOptionsResponse: description: NetworkOptionsResponse contains information about the versioning of the node and the allowed operation statuses, operation types, and errors. type: object @@ -1895,7 +1417,6 @@ components: properties: signed_transaction: type: string - description: Hex-encoded CBOR bytes of the fully signed Cardano transaction, including the transaction body and the transaction witness set. This is ready for submission to the network. ConstructionParseRequest: description: ConstructionParseRequest is the input to the `/construction/parse` endpoint. It allows the caller to parse either an unsigned or signed transaction. type: object @@ -1911,7 +1432,7 @@ components: description: Signed is a boolean indicating whether the transaction is signed. transaction: type: string - description: This must be either the hex-encoded unsigned transaction blob (CBOR transaction body) returned by `/construction/payloads` or the hex-encoded signed transaction blob (CBOR full transaction) returned by `/construction/combine`. + description: This must be either the unsigned transaction blob returned by `/construction/payloads` or the signed transaction blob returned by `/construction/combine`. ConstructionParseResponse: description: ConstructionParseResponse contains an array of operations that occur in a transaction blob. This should match the array of operations provided to `/construction/preprocess` and `/construction/payloads`. type: object @@ -1933,9 +1454,6 @@ components: $ref: '#/components/schemas/AccountIdentifier' metadata: type: object - signed_transaction: - type: string - description: Hex-encoded CBOR bytes of the fully signed Cardano transaction. ConstructionHashRequest: description: ConstructionHashRequest is the input to the `/construction/hash` endpoint. type: object @@ -1958,7 +1476,6 @@ components: $ref: '#/components/schemas/NetworkIdentifier' signed_transaction: type: string - description: Hex-encoded CBOR bytes of the fully signed Cardano transaction, ready for submission. TransactionIdentifierResponse: description: TransactionIdentifierResponse contains the transaction_identifier of a transaction that was submitted to either `/construction/hash` or `/construction/submit`. type: object @@ -1969,79 +1486,79 @@ components: $ref: '#/components/schemas/TransactionIdentifier' metadata: type: object - # CallRequest: - # description: CallRequest is the input to the `/call` endpoint. - # type: object - # required: - # - network_identifier - # - method - # - parameters - # properties: - # network_identifier: - # $ref: '#/components/schemas/NetworkIdentifier' - # method: - # type: string - # description: Method is some network-specific procedure call. This method could map to a network-specific RPC endpoint, a method in an SDK generated from a smart contract, or some hybrid of the two. The implementation must define all available methods in the Allow object. However, it is up to the caller to determine which parameters to provide when invoking `/call`. - # example: eth_call - # parameters: - # type: object - # description: Parameters is some network-specific argument for a method. It is up to the caller to determine which parameters to provide when invoking `/call`. - # example: - # block_number: 23 - # address: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' - # CallResponse: - # description: CallResponse contains the result of a `/call` invocation. - # type: object - # required: - # - result - # - idempotent - # properties: - # result: - # type: object - # description: Result contains the result of the `/call` invocation. This result will not be inspected or interpreted by Rosetta tooling and is left to the caller to decode. - # example: - # count: 1000 - # idempotent: - # type: boolean - # description: Idempotent indicates that if `/call` is invoked with the same CallRequest again, at any point in time, it will return the same CallResponse. Integrators may cache the CallResponse if this is set to true to avoid making unnecessary calls to the Rosetta implementation. For this reason, implementers should be very conservative about returning true here or they could cause issues for the caller. - # EventsBlocksRequest: - # description: EventsBlocksRequest is utilized to fetch a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. - # type: object - # required: - # - network_identifier - # properties: - # network_identifier: - # $ref: '#/components/schemas/NetworkIdentifier' - # offset: - # description: offset is the offset into the event stream to sync events from. If this field is not populated, we return the limit events backwards from tip. If this is set to 0, we start from the beginning. - # type: integer - # format: int64 - # minimum: 0 - # example: 5 - # limit: - # description: limit is the maximum number of events to fetch in one call. The implementation may return <= limit events. - # type: integer - # format: int64 - # minimum: 0 - # example: 5 - # EventsBlocksResponse: - # description: EventsBlocksResponse contains an ordered collection of BlockEvents and the max retrievable sequence. - # type: object - # required: - # - max_sequence - # - events - # properties: - # max_sequence: - # description: max_sequence is the maximum available sequence number to fetch. - # type: integer - # format: int64 - # minimum: 0 - # example: 5 - # events: - # type: array - # description: events is an array of BlockEvents indicating the order to add and remove blocks to maintain a canonical view of blockchain state. Lightweight clients can use this event stream to update state without implementing their own block syncing logic. - # items: - # $ref: '#/components/schemas/BlockEvent' + CallRequest: + description: CallRequest is the input to the `/call` endpoint. + type: object + required: + - network_identifier + - method + - parameters + properties: + network_identifier: + $ref: '#/components/schemas/NetworkIdentifier' + method: + type: string + description: Method is some network-specific procedure call. This method could map to a network-specific RPC endpoint, a method in an SDK generated from a smart contract, or some hybrid of the two. The implementation must define all available methods in the Allow object. However, it is up to the caller to determine which parameters to provide when invoking `/call`. + example: eth_call + parameters: + type: object + description: Parameters is some network-specific argument for a method. It is up to the caller to determine which parameters to provide when invoking `/call`. + example: + block_number: 23 + address: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5' + CallResponse: + description: CallResponse contains the result of a `/call` invocation. + type: object + required: + - result + - idempotent + properties: + result: + type: object + description: Result contains the result of the `/call` invocation. This result will not be inspected or interpreted by Rosetta tooling and is left to the caller to decode. + example: + count: 1000 + idempotent: + type: boolean + description: Idempotent indicates that if `/call` is invoked with the same CallRequest again, at any point in time, it will return the same CallResponse. Integrators may cache the CallResponse if this is set to true to avoid making unnecessary calls to the Rosetta implementation. For this reason, implementers should be very conservative about returning true here or they could cause issues for the caller. + EventsBlocksRequest: + description: EventsBlocksRequest is utilized to fetch a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. + type: object + required: + - network_identifier + properties: + network_identifier: + $ref: '#/components/schemas/NetworkIdentifier' + offset: + description: offset is the offset into the event stream to sync events from. If this field is not populated, we return the limit events backwards from tip. If this is set to 0, we start from the beginning. + type: integer + format: int64 + minimum: 0 + example: 5 + limit: + description: limit is the maximum number of events to fetch in one call. The implementation may return <= limit events. + type: integer + format: int64 + minimum: 0 + example: 5 + EventsBlocksResponse: + description: EventsBlocksResponse contains an ordered collection of BlockEvents and the max retrievable sequence. + type: object + required: + - max_sequence + - events + properties: + max_sequence: + description: max_sequence is the maximum available sequence number to fetch. + type: integer + format: int64 + minimum: 0 + example: 5 + events: + type: array + description: events is an array of BlockEvents indicating the order to add and remove blocks to maintain a canonical view of blockchain state. Lightweight clients can use this event stream to update state without implementing their own block syncing logic. + items: + $ref: '#/components/schemas/BlockEvent' SearchTransactionsRequest: description: SearchTransactionsRequest is used to search for transactions matching a set of provided conditions in canonical blocks. type: object @@ -2151,7 +1668,7 @@ components: address: '0x1dcc4de8dec75d7aab85b567b6' error: not base64 BlockMetadata: - description: BlockMetadata contains Cardano-specific block information, such as epoch, slot, transaction count, size, and block creator (slot leader), beyond the standard Rosetta Block fields. + description: BlockMetadata is used to provide any additional data needed for a Block. It is important to populate this object with any data a consumer will need to fully understand a Block. type: object properties: transactionsCount: @@ -2171,14 +1688,8 @@ components: description: slotNo type: integer format: int64 - example: - transactionsCount: 1 - createdBy: '2a748e3885f6f73320ad16a8331247b81fe01b8d39f57eec9caa5091' - size: 3674 - epochNo: 556 - slotNo: 155041553 TransactionMetadata: - description: Contains Cardano-specific transaction details beyond the core operations, such as fees, TTL, certificates, withdrawals, minting information, collateral, script data hash, and required signers. + description: Transactions that are related to other transactions (like a cross-shard transaction) should include the tranaction_identifier of these transactions in the metadata. type: object properties: size: @@ -2186,54 +1697,14 @@ components: type: integer format: int64 scriptSize: - description: ScriptSize is the size of the transaction script section in bytes. - type: integer - format: int64 - fee: - description: Transaction fee in Lovelace. - $ref: '#/components/schemas/Amount' - ttl: - description: Time-To-Live. The absolute slot number after which the transaction is no longer valid. - type: integer - format: int64 - validity_interval_start: - description: Optional absolute slot number indicating the start of the transaction's validity interval. + description: ScriptSize is the size of the transaction script in bytes. type: integer format: int64 - certificates: - description: List of certificates included in the transaction (e.g., stake registration, delegation, pool registration). - type: array - items: - type: object # Define specific certificate schemas or use a generic object - description: Represents a Cardano certificate (structure varies by type). - withdrawals: - description: Map of stake addresses (`stake...`) to the amount of ADA withdrawn. - type: object - additionalProperties: - $ref: '#/components/schemas/Amount' - mint: - description: Net mint/burn amount for native assets in this transaction. Positive values for minting, negative for burning. - type: array - items: - $ref: '#/components/schemas/Amount' - collateral: - description: List of UTXO inputs provided as collateral for Plutus script execution. - type: array - items: - $ref: '#/components/schemas/CoinIdentifier' - script_data_hash: - description: Optional hash of the datums provided in the transaction witness set. - type: string - required_signers: - description: Optional list of key hashes required as signers by Plutus scripts. - type: array - items: - type: string example: - size: 503 - scriptSize: 2932 + size: 12378 + lockTime: 1582272577 OperationMetadata: - description: OperationMetadata provides Cardano-specific context for an Operation, such as withdrawal/deposit amounts, staking credentials, pool details, DRep information, voting metadata, or the native assets involved (via tokenBundle if the operation affects a UTXO). + description: OperationMetadata is used to provide any additional data needed for an Operation. It is important to populate this object with any data a consumer will need to fully understand an Operation. type: object properties: withdrawalAmount: @@ -2254,10 +1725,10 @@ components: description: DRep $ref: '#/components/schemas/DRepParams' epoch: - description: Epoch associated with the operation, if relevant (e.g., for rewards). + description: Epoch type: integer tokenBundle: - description: Represents native assets associated with a UTXO output operation. Each item contains a policy ID and the amounts of tokens under that policy. + description: TokenBundle type: array items: $ref: '#/components/schemas/TokenBundleItem' @@ -2268,14 +1739,6 @@ components: $ref: '#/components/schemas/PoolRegistrationParams' voteRegistrationMetadata: $ref: '#/components/schemas/VoteRegistrationMetadata' - example: - tokenBundle: - - policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' - tokens: - - value: '-161333000000' - currency: - symbol: '41474958' - decimals: 0 VoteRegistrationMetadata: description: VoteRegistrationMetadata type: object @@ -2307,33 +1770,24 @@ components: type: array items: $ref: '#/components/schemas/Amount' - example: - policyId: 'f43a62fdc3965df486de8a0d32fe800963589c41b38946602a0dc535' - tokens: - - value: '-161333000000' - currency: - symbol: '41474958' - decimals: 0 - DRepTypeParams: # required if id has 29 bytes, otherwise not required + DRepTypeParams: description: DRepTypeParams type: string - required: - - id enum: - key_hash - script_hash - no_confidence - abstain DRepParams: - description: DRep - type: object - properties: - id: - description: DRepId - type: string - type: - description: DRepType - $ref: '#/components/schemas/DRepTypeParams' + description: DRep + type: object + properties: + id: + description: DRepId + type: string + type: + description: DRepType + $ref: '#/components/schemas/DRepTypeParams' PoolRegistrationParams: description: PoolRegistrationParams type: object @@ -2497,17 +1951,12 @@ components: description: 'ChainCode ' type: string CurrencyMetadata: - description: Contains metadata specific to a Cardano currency, particularly for native assets. + description: '' type: object properties: policyId: - description: The hex-encoded policy ID of the native asset. - type: string - assetName: - description: Optional human-readable asset name (UTF-8 encoded, then hex-encoded if needed). + description: '' type: string - example: - policyId: 'dda5fdb1002f7389b33e036b6afee82a8189becb6cba852e8b79b4fb' ConstructionMetadataRequestOption: description: '' type: object @@ -2528,22 +1977,24 @@ components: protocol_parameters: $ref: '#/components/schemas/ProtocolParameters' CoinMetadata: + description: CoinMetadata is used to provide additional data for a Coin object. It is often used to store human-readable information that a client can use to display information to a user. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/CoinTokens' + CoinTokens: description: | - Contains the native assets held by this UTXO (Coin). The ADA amount is represented in the main Coin.Amount field. - #TODO: BUG/INCONSISTENCY - The AccountCoinsResponse example shows Coin.metadata having a dynamic key (the coin_identifier.identifier) - #and a value structure like [{policyId: string, tokens: Amount[]}]. - #This contradicts this CoinMetadata schema, which expects a fixed "assets" key. - #Investigate whether the schema or the example (and potentially API implementation) is correct and align them. + CoinTokens contains the policyId and the tokens + it represents. type: object + required: + - policyId + - tokens properties: - assets: + policyId: + type: string + tokens: type: array - description: List of Amounts representing native assets (excluding ADA) held by the coin. items: $ref: '#/components/schemas/Amount' - #CoinTokens: - # This schema is no longer used by CoinMetadata and can potentially be removed if not used elsewhere. - #description: | - # DEPRECATED by simplified CoinMetadata.assets. CoinTokens contains the policyId and the tokens - # it represents. - #type: object diff --git a/pom.xml b/pom.xml index b3a82636ba..298e55cd4c 100644 --- a/pom.xml +++ b/pom.xml @@ -31,7 +31,7 @@ UTF-8 3.4.3 1.6.15 - 7.13.0 + 6.4.0 3.13.0 3.2.5 0.8.11 From 78bf58d100328eea5c3418dbab0aaaf16e0ed8ae Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Wed, 4 Jun 2025 12:51:55 -0300 Subject: [PATCH 09/13] chore: update Docker compose command and version in documentation --- README.md | 2 +- docs/docs/install-and-deploy/docker.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a545036e7f..49a69bcf8d 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ This will start: ### Entry level hardware profile ```bash - docker-compose --env-file .env.docker-compose --env-file .env.docker-compose-profile-mid-level -f docker-compose.yaml up -d + docker compose --env-file .env.docker-compose --env-file .env.docker-compose-profile-mid-level -f docker-compose.yaml up -d ``` ### A complete list of hardware profiles: diff --git a/docs/docs/install-and-deploy/docker.md b/docs/docs/install-and-deploy/docker.md index 7f8d0714a8..16b82bf8f2 100644 --- a/docs/docs/install-and-deploy/docker.md +++ b/docs/docs/install-and-deploy/docker.md @@ -79,7 +79,7 @@ docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node \ --env-file ./docker/.env.dockerfile \ --env-file ./docker/.env.docker-profile-mid-level \ -p 8082:8082 --shm-size=4g -d \ - cardanofoundation/cardano-rosetta-java:1.2.7 + cardanofoundation/cardano-rosetta-java:1.2.8 ``` #### Using the Submit API @@ -91,7 +91,7 @@ docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node \ --env-file ./docker/.env.dockerfile \ --env-file ./docker/.env.docker-profile-mid-level \ -p 8090:8090 -p 8082:8082 --shm-size=4g -d \ - cardanofoundation/cardano-rosetta-java:1.2.7 + cardanofoundation/cardano-rosetta-java:1.2.8 ``` :::tip From b76c5a81df934e4bd2e87a05583793f32afa4bb3 Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Wed, 4 Jun 2025 18:08:24 -0300 Subject: [PATCH 10/13] refactor: update documentation for spent UTXO pruning - Renamed "Pruning UTXOs" to "Spent UTXO Pruning" for clarity. - Enhanced explanations regarding the impact and configuration of spent UTXO pruning. - Updated resource requirements in README and intro documentation to specify spent UTXO pruning. --- README.md | 4 +- docs/docs/advanced-configuration/pruning.md | 132 ++++++++++++++++--- docs/docs/install-and-deploy/env-vars.md | 135 ++++++++++---------- docs/docs/intro.md | 12 +- 4 files changed, 189 insertions(+), 94 deletions(-) diff --git a/README.md b/README.md index 49a69bcf8d..9f63261dae 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,8 @@ Since [Yaci-Store](https://github.com/bloxbean/yaci-store) is a comparatively li - 4CPU Cores - 32GB RAM -- 1TB of storage (PRUNING_ENABLED=false) [default] -- 400GB of storage (PRUNING_ENABLED=true) +- 1TB of storage (spent UTXO pruning disabled) [default] +- 400GB of storage (spent UTXO pruning enabled) Better hardware will improve the performance of the indexer and the node, which will result in faster syncing times. diff --git a/docs/docs/advanced-configuration/pruning.md b/docs/docs/advanced-configuration/pruning.md index b0e6e9ff17..23534c5d09 100644 --- a/docs/docs/advanced-configuration/pruning.md +++ b/docs/docs/advanced-configuration/pruning.md @@ -1,42 +1,136 @@ --- sidebar_position: 1 -title: Pruning UTXOs -description: Optimizing disk usage with pruning +title: Spent UTXO Pruning +description: Optimizing disk usage with spent UTXO pruning --- -# Pruning UTXOs +# Spent UTXO Pruning -This guide explains how to optimize disk usage in **cardano-rosetta-java** through pruning. +This guide explains how to optimize disk usage in **cardano-rosetta-java** through spent UTXO pruning, including its impact on Rosetta API endpoints and configuration options. -## What is Pruning? +## Understanding Spent UTXO Pruning -Pruning removes spent (consumed) UTXOs from local storage, keeping only unspent UTXOs. This can reduce on-disk storage from ~1TB down to ~400GB, but discards historical transaction data. +Spent UTXO pruning is a disk optimization mechanism in `cardano-rosetta-java`, powered by its underlying indexer, Yaci-Store. This feature selectively removes data related to spent UTXOs from the local database. -- Only unspent outputs are preserved. -- You can still validate the chain's current state (and spend tokens), since active UTXOs remain. -- **Enable Pruning**: Set `PRUNING_ENABLED=true` in your environment (e.g., in `.env.dockerfile` or `.env.docker-compose`). -- **Disable Pruning** (default): Set `PRUNING_ENABLED=false`. +**Core Principles:** + +- **Targeted Deletion**: Only _spent_ UTXOs are removed. All _current, unspent_ UTXOs are preserved, ensuring the accuracy of the present blockchain state and balances. +- **Distinction from Other Pruning**: This mechanism differs from what is commonly understood as 'pruning' in some other blockchain contexts, including certain descriptions in the Coinbase Mesh API (formerly Rosetta). Unlike methods such as Bitcoin's pruning (which removes entire historical blocks), our approach retains full block history but selectively trims the UTXO set by removing only spent outputs. + +**How it Works:** +When enabled, the pruning process operates as follows: + +1. New UTXOs are indexed as transactions occur. +2. UTXOs are marked as spent when consumed in subsequent transactions. +3. A background job (default: every 10 minutes) permanently deletes spent UTXOs that are older than a configurable safety margin (default: 2,160 blocks, ~12 hours on mainnet). This buffer safeguards data integrity against chain rollbacks within Cardano's finality window. + +**Impact Summary:** + +| Aspect | Effect | +| :------------------------- | :----------------------------------------------------------- | +| **Disk Storage** | ✅ Significantly reduced (e.g., mainnet from ~1TB to ~400GB) | +| **Current UTXO Set** | ✅ Fully preserved; current balances remain accurate | +| **Historical Spent UTXOs** | ⚠️ Permanently deleted beyond the safety margin | +| **Query Performance** | ✅ Improved for queries against the current UTXO set | + +## Impact on Rosetta API Endpoints + +Spent UTXO pruning affects Rosetta API endpoints differently based on their reliance on historical transaction data. The table below summarizes the impact. Note that "Recent" refers to data within the safety margin (default ~12 hours). + +:::info Oldest Block Identifier +When pruning is enabled, the `/network/status` endpoint includes an additional `oldest_block_identifier` object in its response. This identifier corresponds to the latest fully queryable block with complete data. Below this block index, blocks might have missing data due to pruning, making historical queries unreliable. +::: + +| **Endpoint** | **Current State** | **Historical Queries** | **Impact & Notes** | +| ---------------------- | ----------------- | ---------------------- | ---------------------------------------------------------------------------- | +| `/account/balance` | ✅ Works | ⚠️ Limited | **Low** - Current balances unaffected | +| `/account/coins` | ✅ Works | ⚠️ Limited | **Low** - Current UTXO lists complete | +| `/block` | ✅ Recent only | ❌ Incomplete | **High** - Missing old transaction inputs | +| `/block/transaction` | ✅ Recent only | ❌ Incomplete | **High** - Missing input operation details | +| `/search/transactions` | ⚠️ Recent only | ❌ Limited | **Medium** - Hash search works, address limited | +| `/network/status` | ✅ Works | ✅ Works | **None** - Returns additional `oldest_block_identifier` when pruning enabled | +| `/network/*` | ✅ Works | ✅ Works | **None** - Independent of UTXO data | +| `/construction/*` | ✅ Works | ✅ Works | **None** - Uses current UTXOs only | ## When to Enable Pruning -- **Low Disk Environments**: If you need to minimize disk usage and only require UTXO data for current balances. -- **Exploratory / Dev Environments**: If historical queries are not critical. +:::tip Recommended Use Cases +Pruning is beneficial in scenarios where optimizing disk space and focusing on current data is prioritized over maintaining a complete historical record. Consider enabling pruning if your use case aligns with the following: + +- **Exchange Integrations & Wallet Services**: Primarily for tracking current balances, processing recent deposits/withdrawals, and validating recent transactions. +- **Resource-Constrained Environments**: Ideal when disk space is a significant limitation (e.g., under 1TB available for mainnet data). +- **Tip-of-Chain Operations**: For applications focused on the latest blockchain state rather than deep historical analysis. +- **Development and Testing**: Useful when a full historical dataset is not essential for development or testing purposes. + ::: ## When to Avoid Pruning -- **Full Historical Data Requirements**: If you need the complete transaction history—whether for exchange operations, audit trails, or compliance mandates—do not enable pruning. Pruning discards spent UTXOs, which removes older transaction data and prevents certain types of historical lookups or reporting. +:::warning Not Suitable For +Avoid pruning if your operational or regulatory requirements necessitate access to complete and auditable historical blockchain data. Pruning is generally not suitable if you need: + +- **Complete Historical Data & Deep Queries**: For comprehensive auditing, compliance, data analytics, or block explorer-like functionality that requires querying full transaction history from any point in time. +- **Strict Compliance and Audit Trails**: If regulatory mandates demand immutable, complete historical records. Pruned data cannot be recovered without a full resync, and historical queries for `/block` and `/block/transaction` become unreliable beyond the safety window. + ::: + +:::danger Data Loss Warning +Once data is pruned, it cannot be recovered without a full blockchain resynchronization. Assess your historical data needs carefully before enabling pruning. +::: -## Example Configuration +## Configuration -Below is a snippet of how you might configure `.env.dockerfile` or `.env.docker-compose` for pruning: +Spent UTXO pruning is configured via environment variables, typically set in your `.env.dockerfile` or `.env.docker-compose` file. Below is an example demonstrating the available settings and their default values: ```bash -# --- Pruning Toggle --- -PRUNING_ENABLED=true -# Enables pruning to reduce disk space requirements +# --- Spent UTXO Pruning Configuration --- + +# Enable or disable spent UTXO pruning. +# Default: false (Pruning is disabled by default) +# To enable, set to: true +REMOVE_SPENT_UTXOS=true + +# Pruning interval in seconds: How often the cleanup job runs. +# Default: 600 (10 minutes) +# Example: To run every hour, set to 3600. +PRUNING_INTERVAL=600 + +# Safety margin: Number of recent blocks for which spent UTXOs are retained. +# Default: 2160 (approximately 12 hours of blocks on mainnet) +# This value balances safety for rollbacks against storage savings. +# Example: To keep ~24 hours of spent UTXOs, set to 4320. +# Note: Larger PRUNING_SAFE_BLOCKS values provide longer historical query support +# but use more disk space and delay the realization of storage benefits. +PRUNING_SAFE_BLOCKS=2160 ``` +:::note Configuration Guidelines + +- Start with the default settings (`REMOVE_SPENT_UTXOS=false` means pruning is initially off). +- If enabling, the provided defaults (`PRUNING_INTERVAL=600`, `PRUNING_SAFE_BLOCKS=2160`) are sensible starting points. +- Adjust `PRUNING_SAFE_BLOCKS` based on your specific needs for recent historical data access. A larger value offers a longer window for historical queries but increases storage. +- The default `PRUNING_INTERVAL` (10 minutes) provides regular cleanup without excessive overhead. Adjust only if you have specific performance considerations. + ::: + +## Migration and Operational Notes + +This section outlines key considerations when changing pruning settings or managing a system with pruning enabled. + +### Enabling Pruning on an Existing Deployment + +1. **Configuration**: Update the necessary environment variables (e.g., `REMOVE_SPENT_UTXOS=true`) and restart your cardano-rosetta-java services. +2. **Initial Monitoring**: After enabling, closely monitor your application for any errors. Disk usage benefits will typically appear after the first pruning cycle completes. + +### Disabling Pruning + +:::caution Important Considerations + +- **Halts Deletion, No Restoration**: Setting `REMOVE_SPENT_UTXOS=false` and restarting services will stop further deletion of spent UTXOs. However, this action **does not restore** any data already pruned. +- **Full Resync for Complete History**: To regain a complete historical dataset after pruning has been active, a full resynchronization of the blockchain data is required. +- **Storage Growth Resumes**: Once pruning is disabled, expect storage usage to gradually increase again as new UTXOs (both spent and unspent) accumulate. + ::: + ## Further Reading -- [Rosetta API Reference](https://docs.cdp.coinbase.com/mesh/docs/api-reference/) +- [Environment Variables Reference](../install-and-deploy/env-vars.md) - [Yaci-Store Repository](https://github.com/bloxbean/yaci-store) +- [Coinbase Mesh (formerly Rosetta) API Specification](https://docs.cdp.coinbase.com/mesh/docs/api-reference/) +- [Cardano UTXO Model Documentation](https://docs.cardano.org/learn/eutxo-explainer/) diff --git a/docs/docs/install-and-deploy/env-vars.md b/docs/docs/install-and-deploy/env-vars.md index c6189e34d8..1e3562bad8 100644 --- a/docs/docs/install-and-deploy/env-vars.md +++ b/docs/docs/install-and-deploy/env-vars.md @@ -13,70 +13,71 @@ Within root folder of the project there are example `.env` files, which can be c - `.env.IntegrationTest` - Is used for integration tests with yaci devkit - `.env.docker-compose` - Is used for standard docker-compose setup (Copy this file and adjusted it to your needs) -| Variable | Description | Default | Notes | -|-----------------------------------------|-----------------------------------------------------|---------------------------------------|----------------------------| -| `LOG` | Log level | INFO | added in release 1.0.0 | -| `NETWORK` | Network | mainnet | added in release 1.0.0 | -| `MITHRIL_SYNC` | Sync from Mithril snapshot | true | added in release 1.0.0 | -| `PROTOCOL_MAGIC` | Cardano protocol magic | 764824073 | added in release 1.0.0 | -| `DB_IMAGE_NAME` | Postgres docker image name | postgres | added in release 1.0.0 | -| `DB_IMAGE_TAG` | Postgres docker image tag | 14.11-bullseye | added in release 1.0.0 | -| `DB_NAME` | Postgres database | rosetta-java | added in release 1.0.0 | -| `DB_USER` | Postgres admin user | rosetta_db_admin | added in release 1.0.0 | -| `DB_SECRET` | Postgres admin secret | weakpwd#123_d | added in release 1.0.0 | -| `DB_HOST` | Postgres host | db | added in release 1.0.0 | -| `DB_PORT` | Postgres port | 5432 | added in release 1.0.0 | -| `DB_SCHEMA` | Database schema | mainnet | added in release 1.0.0 | -| `DB_PATH` | Database path | /data | added in release 1.0.0 | -| `CARDANO_NODE_HOST` | Cardano node host | cardano-node | added in release 1.0.0 | -| `CARDANO_NODE_PORT` | Cardano node port | 3001 | added in release 1.0.0 | -| `CARDANO_NODE_VERSION` | Cardano node version | 8.9.2 | added in release 1.0.0 | -| `CARDANO_NODE_SUBMIT_HOST` | Cardano node submit API host | cardano-submit-api | added in release 1.0.0 | -| `NODE_SUBMIT_API_PORT` | Cardano node submit API port | 8090 | added in release 1.0.0 | -| `CARDANO_NODE_SOCKET_PATH` | Cardano node socket path | /node | added in release 1.0.0 | -| `CARDANO_NODE_SOCKET` | Cardano node socket file | /node/node.socket | added in release 1.0.0 | -| `CARDANO_NODE_DB` | Cardano node db path | /node/db | added in release 1.0.0 | -| `CARDANO_CONFIG` | Cardano node config path | /config/mainnet | added in release 1.0.0 | -| `API_DOCKER_IMAGE_TAG` | Docker Tag for API Image | main | added in release 1.0.0 | -| `API_SPRING_PROFILES_ACTIVE` | API spring profile | staging | added in release 1.0.0 | -| `API_PORT` | Rosetta API exposed port | 8082 | added in release 1.0.0 | -| `ROSETTA_VERSION` | Rosetta version | 1.4.13 | added in release 1.0.0 | -| `TOPOLOGY_FILEPATH` | Topology file path | ./config/mainnet/topology.json | added in release 1.0.0 | -| `GENESIS_SHELLEY_PATH` | Genesis file path | ./config/mainnet/shelley-genesis.json | added in release 1.0.0 | -| `GENESIS_BYRON_PATH` | Genesis file path | ./config/mainnet/byron-genesis.json | added in release 1.0.0 | -| `GENESIS_ALONZO_PATH` | Genesis file path | ./config/mainnet/alonzo-genesis.json | added in release 1.0.0 | -| `GENESIS_CONWAY_PATH` | Genesis file path | ./config/mainnet/conway-genesis.json | added in release 1.0.0 | -| `INDEXER_DOCKER_IMAGE_TAG` | Yaci indexer Docker version | main | added in release 1.0.0 | -| `PRUNING_ENABLED` | If pruning should be enabled | false | added in release 1.0.0 | -| `PRUNING_INTERVAL` | The pruning interval in seconds | 600 | added in release 1.2.4 | -| `PRUNING_SAFE_BLOCKS` | Number of safe blocks to keep in the store | 2160 | added in release 1.2.4 | -| `YACI_SPRING_PROFILES` | Yaci indexer spring profile | postgres | added in release 1.0.0 | -| `DEVKIT_ENABLED` | Devkit enabled | false | added in release 1.0.0 | -| `YACI_HTTP_BASE_URL` | Yaci Indexer's URL | http://yaci-indexer:9095/api/v1 | added in release 1.2.1 | -| `YACI_INDEXER_PORT` | Yaci Indexer's port | 9095 | added in release 1.2.1 | -| `HTTP_CONNECT_TIMEOUT_SECONDS` | Yaci connection timeout in seconds | 5 | added in release 1.2.1 | -| `HTTP_REQUEST_TIMEOUT_SECONDS` | Yaci request timeout in seconds | 5 | added in release 1.2.1 | -| `API_DB_POOL_MIN_COUNT` | Minimum number of connections API↔DB | 12 | added in release 1.2.5 | -| `API_DB_POOL_MAX_COUNT` | Maximum number of connections API↔DB | 12 | added in release 1.2.5 | -| `API_DB_POOL_MAX_LIFETIME_MS` | Description | 2000000 | added in release 1.2.5 | -| `API_DB_POOL_CONNECTION_TIMEOUT_MS` | Connection timeout in milliseconds | 100000 | added in release 1.2.5 | -| `API_DB_KEEP_ALIVE_MS` | Keep alive in milliseconds | 60000 | added in release 1.2.5 | -| `API_DB_LEAK_CONNECTIONS_WARNING_MS` | Leak connection warning threshold (ms) | 60000 | added in release 1.2.5 | -| `API_DB_MONITOR_PERFORMANCE` | Monitor performance enable? | false | added in release 1.2.5 | -| `DB_POSTGRES_MAX_CONNECTIONS` | Maximum concurrent database connections | 300 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_SHARED_BUFFERS` | Memory for caching | 4GB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_EFFECTIVE_CACHE_SIZE` | Disk cache size | 8GB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_WORK_MEM` | Memory per operation for query processing | 64MB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_MAINTENANCE_WORK_MEM` | Memory for maintenance tasks like index creation | 512GB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_WAL_BUFFERS` | Write-ahead log buffer memory | 512MB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_CHECKPOINT_COMPLETION_TARGET` | Target checkpoint completion | 0.7 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_RANDOM_PAGE_COST` | Cost estimate for random disk page access | 1.3 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_EFFECTIVE_IO_CONCURRENCY` | Concurrent I/O for table scans | 2 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_PARALLEL_TUPLE_COST` | Cost per tuple in parallel queries | 0.05 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_PARALLEL_SETUP_COST` | Cost for initiating parallel query workers | 500 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_MAX_PARALLEL_WORKERS_PER_GATHER` | Parallel workers per query | 4 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_MAX_PARALLEL_WORKERS` | Total parallel workers across all queries | 8 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_SEQ_PAGE_COST` | Cost estimate for sequential disk page access | 1.0 | added in release 1.2.6 | -| `DB_POSTGRES_JIT` | Just-In-Time compilation setting | off | added in release 1.2.6 | -| `DB_POSTGRES_BGWRITER_LRU_MAXPAGES` | Max pages for background writer per cycle | 100 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_BGWRITER_DELAY` | Delay between background writer cycles | 200ms (mid-level profile) | added in release 1.2.6 | +| Variable | Description | Default | Notes | +| --------------------------------------------- | --------------------------------------------------------------- | ------------------------------------- | ----------------------------------- | +| `LOG` | Log level | INFO | added in release 1.0.0 | +| `NETWORK` | Network | mainnet | added in release 1.0.0 | +| `MITHRIL_SYNC` | Sync from Mithril snapshot | true | added in release 1.0.0 | +| `PROTOCOL_MAGIC` | Cardano protocol magic | 764824073 | added in release 1.0.0 | +| `DB_IMAGE_NAME` | Postgres docker image name | postgres | added in release 1.0.0 | +| `DB_IMAGE_TAG` | Postgres docker image tag | 14.11-bullseye | added in release 1.0.0 | +| `DB_NAME` | Postgres database | rosetta-java | added in release 1.0.0 | +| `DB_USER` | Postgres admin user | rosetta_db_admin | added in release 1.0.0 | +| `DB_SECRET` | Postgres admin secret | weakpwd#123_d | added in release 1.0.0 | +| `DB_HOST` | Postgres host | db | added in release 1.0.0 | +| `DB_PORT` | Postgres port | 5432 | added in release 1.0.0 | +| `DB_SCHEMA` | Database schema | mainnet | added in release 1.0.0 | +| `DB_PATH` | Database path | /data | added in release 1.0.0 | +| `CARDANO_NODE_HOST` | Cardano node host | cardano-node | added in release 1.0.0 | +| `CARDANO_NODE_PORT` | Cardano node port | 3001 | added in release 1.0.0 | +| `CARDANO_NODE_VERSION` | Cardano node version | 8.9.2 | added in release 1.0.0 | +| `CARDANO_NODE_SUBMIT_HOST` | Cardano node submit API host | cardano-submit-api | added in release 1.0.0 | +| `NODE_SUBMIT_API_PORT` | Cardano node submit API port | 8090 | added in release 1.0.0 | +| `CARDANO_NODE_SOCKET_PATH` | Cardano node socket path | /node | added in release 1.0.0 | +| `CARDANO_NODE_SOCKET` | Cardano node socket file | /node/node.socket | added in release 1.0.0 | +| `CARDANO_NODE_DB` | Cardano node db path | /node/db | added in release 1.0.0 | +| `CARDANO_CONFIG` | Cardano node config path | /config/mainnet | added in release 1.0.0 | +| `API_DOCKER_IMAGE_TAG` | Docker Tag for API Image | main | added in release 1.0.0 | +| `API_SPRING_PROFILES_ACTIVE` | API spring profile | staging | added in release 1.0.0 | +| `API_PORT` | Rosetta API exposed port | 8082 | added in release 1.0.0 | +| `ROSETTA_VERSION` | Rosetta version | 1.4.13 | added in release 1.0.0 | +| `TOPOLOGY_FILEPATH` | Topology file path | ./config/mainnet/topology.json | added in release 1.0.0 | +| `GENESIS_SHELLEY_PATH` | Genesis file path | ./config/mainnet/shelley-genesis.json | added in release 1.0.0 | +| `GENESIS_BYRON_PATH` | Genesis file path | ./config/mainnet/byron-genesis.json | added in release 1.0.0 | +| `GENESIS_ALONZO_PATH` | Genesis file path | ./config/mainnet/alonzo-genesis.json | added in release 1.0.0 | +| `GENESIS_CONWAY_PATH` | Genesis file path | ./config/mainnet/conway-genesis.json | added in release 1.0.0 | +| `INDEXER_DOCKER_IMAGE_TAG` | Yaci indexer Docker version | main | added in release 1.0.0 | +| `PRUNING_ENABLED` | Enable spent UTXO pruning to reduce storage requirements | false | available in releases 1.0.0 - 1.2.8 | +| `REMOVE_SPENT_UTXOS` | Enable spent UTXO pruning to reduce storage requirements | false | added in release 1.2.9 | +| `PRUNING_INTERVAL` | Interval in seconds between pruning cleanup jobs | 600 | added in release 1.2.4 | +| `PRUNING_SAFE_BLOCKS` | Number of recent blocks to keep spent UTXOs for (safety margin) | 2160 | added in release 1.2.4 | +| `YACI_SPRING_PROFILES` | Yaci indexer spring profile | postgres | added in release 1.0.0 | +| `DEVKIT_ENABLED` | Devkit enabled | false | added in release 1.0.0 | +| `YACI_HTTP_BASE_URL` | Yaci Indexer's URL | http://yaci-indexer:9095/api/v1 | added in release 1.2.1 | +| `YACI_INDEXER_PORT` | Yaci Indexer's port | 9095 | added in release 1.2.1 | +| `HTTP_CONNECT_TIMEOUT_SECONDS` | Yaci connection timeout in seconds | 5 | added in release 1.2.1 | +| `HTTP_REQUEST_TIMEOUT_SECONDS` | Yaci request timeout in seconds | 5 | added in release 1.2.1 | +| `API_DB_POOL_MIN_COUNT` | Minimum number of connections API↔DB | 12 | added in release 1.2.5 | +| `API_DB_POOL_MAX_COUNT` | Maximum number of connections API↔DB | 12 | added in release 1.2.5 | +| `API_DB_POOL_MAX_LIFETIME_MS` | Description | 2000000 | added in release 1.2.5 | +| `API_DB_POOL_CONNECTION_TIMEOUT_MS` | Connection timeout in milliseconds | 100000 | added in release 1.2.5 | +| `API_DB_KEEP_ALIVE_MS` | Keep alive in milliseconds | 60000 | added in release 1.2.5 | +| `API_DB_LEAK_CONNECTIONS_WARNING_MS` | Leak connection warning threshold (ms) | 60000 | added in release 1.2.5 | +| `API_DB_MONITOR_PERFORMANCE` | Monitor performance enable? | false | added in release 1.2.5 | +| `DB_POSTGRES_MAX_CONNECTIONS` | Maximum concurrent database connections | 300 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_SHARED_BUFFERS` | Memory for caching | 4GB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_EFFECTIVE_CACHE_SIZE` | Disk cache size | 8GB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_WORK_MEM` | Memory per operation for query processing | 64MB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_MAINTENANCE_WORK_MEM` | Memory for maintenance tasks like index creation | 512GB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_WAL_BUFFERS` | Write-ahead log buffer memory | 512MB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_CHECKPOINT_COMPLETION_TARGET` | Target checkpoint completion | 0.7 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_RANDOM_PAGE_COST` | Cost estimate for random disk page access | 1.3 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_EFFECTIVE_IO_CONCURRENCY` | Concurrent I/O for table scans | 2 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_PARALLEL_TUPLE_COST` | Cost per tuple in parallel queries | 0.05 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_PARALLEL_SETUP_COST` | Cost for initiating parallel query workers | 500 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_MAX_PARALLEL_WORKERS_PER_GATHER` | Parallel workers per query | 4 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_MAX_PARALLEL_WORKERS` | Total parallel workers across all queries | 8 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_SEQ_PAGE_COST` | Cost estimate for sequential disk page access | 1.0 | added in release 1.2.6 | +| `DB_POSTGRES_JIT` | Just-In-Time compilation setting | off | added in release 1.2.6 | +| `DB_POSTGRES_BGWRITER_LRU_MAXPAGES` | Max pages for background writer per cycle | 100 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_BGWRITER_DELAY` | Delay between background writer cycles | 200ms (mid-level profile) | added in release 1.2.6 | diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 186a8aefe6..9821ccd1b5 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -23,12 +23,12 @@ For a more detailed architecture overview, see the [Architecture](core-concepts/ Running Cardano Rosetta Java requires the following minimum resources: -| Component | Requirement | Notes | -| :---------- | :---------- | :----------------------- | -| **CPU** | 4 Cores | | -| **RAM** | 32 GB | | -| **Storage** | 1 TB | When pruning is disabled | -| | 400 GB | When pruning is enabled | +| Component | Requirement | Notes | +| :---------- | :---------- | :---------------------------------- | +| **CPU** | 4 Cores | | +| **RAM** | 32 GB | | +| **Storage** | 1 TB | When spent UTXO pruning is disabled | +| | 400 GB | When spent UTXO pruning is enabled | :::tip Performance Note Better hardware resources (more CPU cores, RAM) will improve indexer and node performance, resulting in faster chain synchronization and better API response times. From 9e05c103859d4d4a5af8956eced8822ec42e7171 Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Wed, 4 Jun 2025 21:35:12 -0300 Subject: [PATCH 11/13] docs: enhance documentation for queryng stake addresses and rename multi-assets section - Added a note on stake addresses to clarify the response from the `/account/balance` endpoint when queried with a stake address (available rewards). - Renamed the "Multi-Assets" section to "Native Tokens" for better alignment with terminology used in Cardano documentation. --- docs/docs/core-concepts/cardano-addons.md | 6 ++++++ docs/docs/user-guides/multi-assets.md | 16 +++++++++++----- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/docs/core-concepts/cardano-addons.md b/docs/docs/core-concepts/cardano-addons.md index 9f282304ce..4f3933c5ae 100644 --- a/docs/docs/core-concepts/cardano-addons.md +++ b/docs/docs/core-concepts/cardano-addons.md @@ -165,6 +165,12 @@ For accounts that have a multi asset balance, these will be returned with the co Also, `coins` will be returned with the token bundle list corresponding to each coin as metadata. +:::info Note on Stake Addresses +When the `/account/balance` endpoint is queried with a stake address (also known as a reward address), the response will include the available rewards that can be withdrawn from the stake address. + +This means the API provides a consolidated view of both spendable funds (from payment addresses) and claimable rewards when a stake address is used in the query. +::: + ### `/account/coins` :::warning diff --git a/docs/docs/user-guides/multi-assets.md b/docs/docs/user-guides/multi-assets.md index dd343eec0f..865f75cc40 100644 --- a/docs/docs/user-guides/multi-assets.md +++ b/docs/docs/user-guides/multi-assets.md @@ -1,17 +1,17 @@ --- sidebar_position: 1 -title: Multi-Assets +title: Native Tokens description: Native token support in Cardano Rosetta implementation --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Multi-Assets +# Native Tokens ## Overview -Native tokens (Multi-Assets) on Cardano allow users to create and transact with custom tokens alongside ADA. In the Rosetta API implementation, these tokens are represented in both transaction operations and account balances. +Native tokens on Cardano allow users to create and transact with custom tokens alongside ADA. In the Rosetta API implementation, these tokens are represented in both transaction operations and account balances. :::info More information about Native Tokens can be found in the [Cardano Documentation](https://docs.cardano.org/developer-resources/native-tokens). @@ -27,9 +27,9 @@ More information about Native Tokens can be found in the [Cardano Documentation] Token Name is not required by Cardano protocol rules. Since Rosetta [symbol](https://www.rosetta-api.org/docs/1.4.4/models/Currency.html) is a required field, it will be represented as `\\x` when no name is provided. ::: -## Operations with Multi-Assets +## Operations with Native Tokens -Multi-Assets can be included in both input and output operations. The token bundles are associated with each operation as metadata. +Native tokens can be included in both input and output operations. The token bundles are associated with each operation as metadata. @@ -107,6 +107,12 @@ Multi-Assets can be included in both input and output operations. The token bund When querying account balances using `/account/balance`, the response will include both ADA and any native tokens owned by the address. +:::info Note on Stake Addresses +When the `/account/balance` endpoint is queried with a stake address (also known as a reward address), the response will include the available rewards that can be withdrawn from the stake address. + +This means the API provides a consolidated view of both spendable funds (from payment addresses) and claimable rewards when a stake address is used in the query. +::: + ```json { "balances": [ From 9ab932c7372852693a096a3ccc116c9a3ccfa2fc Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Tue, 10 Jun 2025 22:09:43 -0300 Subject: [PATCH 12/13] docs: update performance measurement documentation and environment variables - Enhanced the performance measurements section with load test results for versions 1.2.6, 1.2.7, and 1.2.9. - Updated environment variables documentation to reflect changes in version 1.2.9, including the introduction of `REMOVE_SPENT_UTXOS` and `REMOVE_SPENT_UTXOS_LAST_BLOCKS_GRACE_COUNT`, while deprecating older variables. --- docs/docs/advanced-configuration/pruning.md | 29 ++-- .../development/performance-measurements.md | 88 +++++++++-- .../1.2.6-dev_2025-04-16/docker-compose.md | 21 --- .../1.2.6-dev_2025-04-16/single-docker.md | 14 -- .../1.2.6}/docker-compose.md | 6 +- .../1.2.6}/single-docker.md | 6 +- .../test-results/1.2.7/docker-compose.md | 14 ++ .../test-results/1.2.7/single-docker.md | 5 + .../test-results/1.2.9/docker-compose.md | 11 ++ .../test-results/1.2.9/huge-address-1.6M.md | 23 +++ .../test-results/1.2.9/huge-address-373k.md | 23 +++ .../test-results/1.2.9/single-docker.md | 5 + docs/docs/install-and-deploy/env-vars.md | 147 ++++++++++-------- .../install-and-deploy/hardware-profiles.md | 24 ++- 14 files changed, 262 insertions(+), 154 deletions(-) delete mode 100644 docs/docs/development/test-results/1.2.6-dev_2025-04-16/docker-compose.md delete mode 100644 docs/docs/development/test-results/1.2.6-dev_2025-04-16/single-docker.md rename docs/docs/development/{_test-results/1.2.6-dev_2025-04-16 => test-results/1.2.6}/docker-compose.md (79%) rename docs/docs/development/{_test-results/1.2.6-dev_2025-04-16 => test-results/1.2.6}/single-docker.md (79%) create mode 100644 docs/docs/development/test-results/1.2.7/docker-compose.md create mode 100644 docs/docs/development/test-results/1.2.7/single-docker.md create mode 100644 docs/docs/development/test-results/1.2.9/docker-compose.md create mode 100644 docs/docs/development/test-results/1.2.9/huge-address-1.6M.md create mode 100644 docs/docs/development/test-results/1.2.9/huge-address-373k.md create mode 100644 docs/docs/development/test-results/1.2.9/single-docker.md diff --git a/docs/docs/advanced-configuration/pruning.md b/docs/docs/advanced-configuration/pruning.md index 23534c5d09..a68f2791e1 100644 --- a/docs/docs/advanced-configuration/pruning.md +++ b/docs/docs/advanced-configuration/pruning.md @@ -22,16 +22,15 @@ When enabled, the pruning process operates as follows: 1. New UTXOs are indexed as transactions occur. 2. UTXOs are marked as spent when consumed in subsequent transactions. -3. A background job (default: every 10 minutes) permanently deletes spent UTXOs that are older than a configurable safety margin (default: 2,160 blocks, ~12 hours on mainnet). This buffer safeguards data integrity against chain rollbacks within Cardano's finality window. +3. A background job periodically permanently deletes spent UTXOs that are older than a configurable safety margin (default: 2,160 blocks, ~12 hours on mainnet). This buffer safeguards data integrity against chain rollbacks within Cardano's finality window. **Impact Summary:** - -| Aspect | Effect | +| Aspect | Effect | | :------------------------- | :----------------------------------------------------------- | -| **Disk Storage** | ✅ Significantly reduced (e.g., mainnet from ~1TB to ~400GB) | -| **Current UTXO Set** | ✅ Fully preserved; current balances remain accurate | -| **Historical Spent UTXOs** | ⚠️ Permanently deleted beyond the safety margin | -| **Query Performance** | ✅ Improved for queries against the current UTXO set | +| **Disk Storage** | ✅ Significantly reduced (e.g., mainnet from ~1TB to ~400GB) | +| **Current UTXO Set** | ✅ Fully preserved; current balances remain accurate | +| **Historical Spent UTXOs** | ⚠️ Permanently deleted beyond the safety margin | +| **Query Performance** | ✅ Improved for queries against the current UTXO set | ## Impact on Rosetta API Endpoints @@ -46,7 +45,7 @@ When pruning is enabled, the `/network/status` endpoint includes an additional ` | `/account/balance` | ✅ Works | ⚠️ Limited | **Low** - Current balances unaffected | | `/account/coins` | ✅ Works | ⚠️ Limited | **Low** - Current UTXO lists complete | | `/block` | ✅ Recent only | ❌ Incomplete | **High** - Missing old transaction inputs | -| `/block/transaction` | ✅ Recent only | ❌ Incomplete | **High** - Missing input operation details | +| `/block/transaction` | ✅ Recent only | ❌ Incomplete | **High** - Missing spent UTXOs operation details | | `/search/transactions` | ⚠️ Recent only | ❌ Limited | **Medium** - Hash search works, address limited | | `/network/status` | ✅ Works | ✅ Works | **None** - Returns additional `oldest_block_identifier` when pruning enabled | | `/network/*` | ✅ Works | ✅ Works | **None** - Independent of UTXO data | @@ -88,26 +87,20 @@ Spent UTXO pruning is configured via environment variables, typically set in you # To enable, set to: true REMOVE_SPENT_UTXOS=true -# Pruning interval in seconds: How often the cleanup job runs. -# Default: 600 (10 minutes) -# Example: To run every hour, set to 3600. -PRUNING_INTERVAL=600 - # Safety margin: Number of recent blocks for which spent UTXOs are retained. # Default: 2160 (approximately 12 hours of blocks on mainnet) # This value balances safety for rollbacks against storage savings. # Example: To keep ~24 hours of spent UTXOs, set to 4320. -# Note: Larger PRUNING_SAFE_BLOCKS values provide longer historical query support +# Note: Larger REMOVE_SPENT_UTXOS_LAST_BLOCKS_GRACE_COUNT values provide longer historical query support # but use more disk space and delay the realization of storage benefits. -PRUNING_SAFE_BLOCKS=2160 +REMOVE_SPENT_UTXOS_LAST_BLOCKS_GRACE_COUNT=2160 ``` :::note Configuration Guidelines - Start with the default settings (`REMOVE_SPENT_UTXOS=false` means pruning is initially off). -- If enabling, the provided defaults (`PRUNING_INTERVAL=600`, `PRUNING_SAFE_BLOCKS=2160`) are sensible starting points. -- Adjust `PRUNING_SAFE_BLOCKS` based on your specific needs for recent historical data access. A larger value offers a longer window for historical queries but increases storage. -- The default `PRUNING_INTERVAL` (10 minutes) provides regular cleanup without excessive overhead. Adjust only if you have specific performance considerations. +- If enabling, the provided defaults (`REMOVE_SPENT_UTXOS_LAST_BLOCKS_GRACE_COUNT=2160`) are sensible starting points. +- Adjust `REMOVE_SPENT_UTXOS_LAST_BLOCKS_GRACE_COUNT` based on your specific needs for recent historical data access. A larger value offers a longer window for historical queries but increases storage. ::: ## Migration and Operational Notes diff --git a/docs/docs/development/performance-measurements.md b/docs/docs/development/performance-measurements.md index e93df044c3..c364522677 100644 --- a/docs/docs/development/performance-measurements.md +++ b/docs/docs/development/performance-measurements.md @@ -4,36 +4,98 @@ title: Performance Measurements description: Performance measurement methodologies and results --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + # Performance Measurements -This page documents the performance measurements and load test results for different releases of `cardano-rosetta-java`. +This page documents load test results for different releases of `cardano-rosetta-java`, evaluating performance across various deployment scenarios. + +### Service Level Agreements (SLAs) + +Our performance evaluation is based on the following Service Level Agreements (SLAs), which define the acceptable thresholds for production environments: + +- **Response Time**: A **p99 of less than 1 second** is the target for all standard API endpoints. +- **Error Rate**: A **non-2xx response rate of less than 1%** is considered acceptable. -## Load Test Results +In specific high-load scenarios, such as querying addresses with hundreds of thousands of transactions, these SLAs may be adjusted to assess system stability under extreme conditions. Any such adjustments are noted in the relevant test results. -Below you can find the load test results for various releases, comparing different deployment options. All performance tests are evaluated against a Service Level Agreement (SLA) target of 1 second response time, which we consider the acceptable threshold for API responsiveness in production environments. +:::note +Load tests are conducted using Apache Bench (ab) with a ramp-up strategy, progressively increasing concurrency to a predefined ceiling of 500 simultaneous requests. +::: + +:::tip +To better understand the environments in which these results were obtained, please refer to our [hardware profiles documentation](../install-and-deploy/hardware-profiles). +:::

-### Release 1.2.7 (Test Run: 2025-04-16) +### v1.2.9 (Jun 11, 2025) -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import SingleDocker from './\_test-results/1.2.6-dev_2025-04-16/single-docker.md'; -import DockerCompose from './\_test-results/1.2.6-dev_2025-04-16/docker-compose.md'; +- [Release Notes](https://github.com/cardano-foundation/cardano-rosetta-java/releases/tag/1.2.9) + +The following tests were conducted on a **mid-level** hardware profile with the following specifications: **8 cores, 8 threads, 47GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+**. + +import DockerCompose129 from './test-results/1.2.9/docker-compose.md'; +import HugeAddress373k from './test-results/1.2.9/huge-address-373k.md'; +import HugeAddress16M from './test-results/1.2.9/huge-address-1.6M.md'; - - + + + + + + + + + +
+ +
+ + +### v1.2.7 (Apr 29, 2025) + + + +import SingleDocker127 from './test-results/1.2.7/single-docker.md'; +import DockerCompose127 from './test-results/1.2.7/docker-compose.md'; + +- [Release Notes](https://github.com/cardano-foundation/cardano-rosetta-java/releases/tag/1.2.7) + + + - +
---- +
+ + +### v1.2.6 (Apr 15, 2025) + + + +import SingleDocker126 from './test-results/1.2.6/single-docker.md'; +import DockerCompose126 from './test-results/1.2.6/docker-compose.md'; + +- [Release Notes](https://github.com/cardano-foundation/cardano-rosetta-java/releases/tag/1.2.6) -_Future results will be added here, each as a collapsible section._ + + + + + + + + +
diff --git a/docs/docs/development/test-results/1.2.6-dev_2025-04-16/docker-compose.md b/docs/docs/development/test-results/1.2.6-dev_2025-04-16/docker-compose.md deleted file mode 100644 index 98094a46ad..0000000000 --- a/docs/docs/development/test-results/1.2.6-dev_2025-04-16/docker-compose.md +++ /dev/null @@ -1,21 +0,0 @@ -**Hardware Profile:** mid_level - -**Machine Specs:** 8 cores, 8 threads, 47GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+ - - -Hardware Profiles - - -Maximum concurrency achieved per endpoint - -| ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | -| --- | ---------------------- | --------------- | -------- | -------- | -| 1 | /network/status | 500 | 150ms | 171ms | -| 2 | /account/balance | 150 | 640ms | 777ms | -| 3 | /account/coins | 225 | 812ms | 949ms | -| 4 | /block | 200 | 706ms | 960ms | -| 5 | /block/transaction | 125 | 397ms | 469ms | -| 6 | /search/transactions | 175 | 130ms | 161ms | -| 7 | /construction/metadata | 500 | 127ms | 178ms | diff --git a/docs/docs/development/test-results/1.2.6-dev_2025-04-16/single-docker.md b/docs/docs/development/test-results/1.2.6-dev_2025-04-16/single-docker.md deleted file mode 100644 index fe11f528fb..0000000000 --- a/docs/docs/development/test-results/1.2.6-dev_2025-04-16/single-docker.md +++ /dev/null @@ -1,14 +0,0 @@ -**Hardware:** mid-level -**Machine Specs:** 16 cores, 16 threads, 125GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+ - -Maximum concurrency achieved per endpoint - -| ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | -| --- | ---------------------- | --------------- | -------- | -------- | -| 1 | /network/status | 500 | 82ms | 103ms | -| 2 | /account/balance | 500 | 750ms | 902ms | -| 3 | /account/coins | 500 | 720ms | 883ms | -| 4 | /block | 200 | 726ms | 980ms | -| 5 | /block/transaction | 175 | 596ms | 733ms | -| 6 | /search/transactions | 175 | 74ms | 94ms | -| 7 | /construction/metadata | 500 | 72ms | 97ms | diff --git a/docs/docs/development/_test-results/1.2.6-dev_2025-04-16/docker-compose.md b/docs/docs/development/test-results/1.2.6/docker-compose.md similarity index 79% rename from docs/docs/development/_test-results/1.2.6-dev_2025-04-16/docker-compose.md rename to docs/docs/development/test-results/1.2.6/docker-compose.md index 22da141a76..9dc450b2bf 100644 --- a/docs/docs/development/_test-results/1.2.6-dev_2025-04-16/docker-compose.md +++ b/docs/docs/development/test-results/1.2.6/docker-compose.md @@ -1,7 +1,7 @@ -**Hardware:** mid-level -**Machine Specs:** 8 cores, 8 threads, 47GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+ +- **Hardware Profile:** mid-level +- **Machine Specs:** 8 cores, 8 threads, 47GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+ -Maximum concurrency achieved per endpoint +**Maximum concurrency achieved per endpoint** | ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | | --- | ---------------------- | --------------- | -------- | -------- | diff --git a/docs/docs/development/_test-results/1.2.6-dev_2025-04-16/single-docker.md b/docs/docs/development/test-results/1.2.6/single-docker.md similarity index 79% rename from docs/docs/development/_test-results/1.2.6-dev_2025-04-16/single-docker.md rename to docs/docs/development/test-results/1.2.6/single-docker.md index fe11f528fb..de8473d966 100644 --- a/docs/docs/development/_test-results/1.2.6-dev_2025-04-16/single-docker.md +++ b/docs/docs/development/test-results/1.2.6/single-docker.md @@ -1,7 +1,7 @@ -**Hardware:** mid-level -**Machine Specs:** 16 cores, 16 threads, 125GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+ +- **Hardware Profile:** mid-level +- **Machine Specs:** 16 cores, 16 threads, 125GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+ -Maximum concurrency achieved per endpoint +**Maximum concurrency achieved per endpoint** | ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | | --- | ---------------------- | --------------- | -------- | -------- | diff --git a/docs/docs/development/test-results/1.2.7/docker-compose.md b/docs/docs/development/test-results/1.2.7/docker-compose.md new file mode 100644 index 0000000000..85b398c655 --- /dev/null +++ b/docs/docs/development/test-results/1.2.7/docker-compose.md @@ -0,0 +1,14 @@ +- **Hardware Profile:** mid-level +- **Machine Specs:** 8 cores, 8 threads, 47GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+ + +**Maximum concurrency achieved per endpoint** + +| ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | +| --- | ---------------------- | --------------- | -------- | -------- | +| 1 | /network/status | 200 | 61ms | 73ms | +| 2 | /account/balance | 200 | 708ms | 833ms | +| 3 | /account/coins | 200 | 737ms | 875ms | +| 4 | /block | 200 | 618ms | 722ms | +| 5 | /block/transaction | 175 | 552ms | 691ms | +| 6 | /search/transactions | 175 | 119ms | 143ms | +| 7 | /construction/metadata | 56 | 11ms | 15ms | diff --git a/docs/docs/development/test-results/1.2.7/single-docker.md b/docs/docs/development/test-results/1.2.7/single-docker.md new file mode 100644 index 0000000000..2536233f4b --- /dev/null +++ b/docs/docs/development/test-results/1.2.7/single-docker.md @@ -0,0 +1,5 @@ +- **Hardware Profile:** mid-level +- **Machine Specs:** 16 cores, 16 threads, 125GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+ + +**Maximum concurrency achieved per endpoint** +TBD diff --git a/docs/docs/development/test-results/1.2.9/docker-compose.md b/docs/docs/development/test-results/1.2.9/docker-compose.md new file mode 100644 index 0000000000..8f6c7c63a6 --- /dev/null +++ b/docs/docs/development/test-results/1.2.9/docker-compose.md @@ -0,0 +1,11 @@ +**Maximum concurrency achieved per endpoint** + +| ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | Non-2xx | Error Rate (%) | Reqs/sec | +| --- | ---------------------- | --------------- | -------- | -------- | ------- | -------------- | -------- | +| 1 | /network/status | 500 | 169ms | 198ms | 0 | 0.00% | 6120.35 | +| 2 | /account/balance | 225 | 824ms | 958ms | 0 | 0.00% | 391.41 | +| 3 | /account/coins | 225 | 783ms | 917ms | 0 | 0.00% | 411.56 | +| 4 | /block | 175 | 684ms | 837ms | 0 | 0.00% | 407.10 | +| 5 | /block/transaction | 200 | 691ms | 967ms | 10 | 0.04% | 435.23 | +| 6 | /search/transactions | 175 | 154ms | 204ms | 150 | 0.30% | 1727.60 | +| 7 | /construction/metadata | 500 | 210ms | 379ms | 0 | 0.00% | 8331.37 | diff --git a/docs/docs/development/test-results/1.2.9/huge-address-1.6M.md b/docs/docs/development/test-results/1.2.9/huge-address-1.6M.md new file mode 100644 index 0000000000..5c7f4b6a6d --- /dev/null +++ b/docs/docs/development/test-results/1.2.9/huge-address-1.6M.md @@ -0,0 +1,23 @@ +This scenario evaluates the performance of querying an address with approximately 1.6 million transactions under different pruning configurations. For details on pruning, see [Spent UTXO Pruning](../../../advanced-configuration/pruning.md). + +#### Pruning Enabled (`REMOVE_SPENT_UTXOS=true`) + +**Maximum concurrency achieved per endpoint** + +| ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | Non-2xx | Error Rate (%) | Reqs/sec | +| --- | ---------------- | --------------- | -------- | -------- | ------- | -------------- | -------- | +| 1 | /account/balance | 500 | 1304ms | 1710ms | 0 | 0.00% | 694.10 | +| 2 | /account/coins | 500 | 1184ms | 1551ms | 0 | 0.00% | 779.39 | + +#### Pruning Disabled (`REMOVE_SPENT_UTXOS=false`) + +:::note SLA Adjustment for Extreme Load +For this specific test with pruning disabled on an address with ~1.6M transactions, the standard 1-second Service Level Agreement (SLA) is not achievable. The SLA was adjusted to 10 seconds to evaluate system stability under extreme load. The results for `/account/balance` at concurrency 1 are reported despite slightly exceeding this adjusted SLA to provide a transparent view of the performance boundary. +::: + +**Maximum concurrency achieved per endpoint** + +| ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | Non-2xx | Error Rate (%) | Reqs/sec | +| --- | ---------------- | --------------- | -------- | -------- | ------- | -------------- | -------- | +| 1 | /account/balance | 1 | 10427ms | 10427ms | 0 | 0.00% | 0.16 | +| 2 | /account/coins | 1 | 9612ms | 9612ms | 0 | 0.00% | 0.11 | diff --git a/docs/docs/development/test-results/1.2.9/huge-address-373k.md b/docs/docs/development/test-results/1.2.9/huge-address-373k.md new file mode 100644 index 0000000000..eefe427a58 --- /dev/null +++ b/docs/docs/development/test-results/1.2.9/huge-address-373k.md @@ -0,0 +1,23 @@ +This scenario evaluates the performance of querying an address with approximately 373,000 transactions under different pruning configurations. For details on pruning, see [Spent UTXO Pruning](../../../advanced-configuration/pruning.md). + +#### Pruning Enabled (`REMOVE_SPENT_UTXOS=true`) + +**Maximum concurrency achieved per endpoint** + +| ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | Non-2xx | Error Rate (%) | Reqs/sec | +| --- | ---------------- | --------------- | -------- | -------- | ------- | -------------- | -------- | +| 1 | /account/balance | 500 | 153ms | 414ms | 0 | 0.00% | 7012.95 | +| 2 | /account/coins | 500 | 184ms | 402ms | 0 | 0.00% | 5964.08 | + +#### Pruning Disabled (`REMOVE_SPENT_UTXOS=false`) + +:::note SLA Adjustment for Extreme Load +For this specific test with pruning disabled, the standard 1-second Service Level Agreement (SLA) is not achievable. Therefore, the SLA was adjusted to 10 seconds to evaluate system stability under extreme load, even with degraded performance. +::: + +**Maximum concurrency achieved per endpoint** + +| ID | Endpoint | Max Concurrency | p95 (ms) | p99 (ms) | Non-2xx | Error Rate (%) | Reqs/sec | +| --- | ---------------- | --------------- | -------- | -------- | ------- | -------------- | -------- | +| 1 | /account/balance | 4 | 6486ms | 7263ms | 0 | 0.00% | 1.02 | +| 2 | /account/coins | 8 | 9011ms | 9384ms | 0 | 0.00% | 1.20 | diff --git a/docs/docs/development/test-results/1.2.9/single-docker.md b/docs/docs/development/test-results/1.2.9/single-docker.md new file mode 100644 index 0000000000..2536233f4b --- /dev/null +++ b/docs/docs/development/test-results/1.2.9/single-docker.md @@ -0,0 +1,5 @@ +- **Hardware Profile:** mid-level +- **Machine Specs:** 16 cores, 16 threads, 125GB RAM, 3.9TB NVMe, QEMU Virtual CPU v2.5+ + +**Maximum concurrency achieved per endpoint** +TBD diff --git a/docs/docs/install-and-deploy/env-vars.md b/docs/docs/install-and-deploy/env-vars.md index 1e3562bad8..df9deae5a9 100644 --- a/docs/docs/install-and-deploy/env-vars.md +++ b/docs/docs/install-and-deploy/env-vars.md @@ -13,71 +13,82 @@ Within root folder of the project there are example `.env` files, which can be c - `.env.IntegrationTest` - Is used for integration tests with yaci devkit - `.env.docker-compose` - Is used for standard docker-compose setup (Copy this file and adjusted it to your needs) -| Variable | Description | Default | Notes | -| --------------------------------------------- | --------------------------------------------------------------- | ------------------------------------- | ----------------------------------- | -| `LOG` | Log level | INFO | added in release 1.0.0 | -| `NETWORK` | Network | mainnet | added in release 1.0.0 | -| `MITHRIL_SYNC` | Sync from Mithril snapshot | true | added in release 1.0.0 | -| `PROTOCOL_MAGIC` | Cardano protocol magic | 764824073 | added in release 1.0.0 | -| `DB_IMAGE_NAME` | Postgres docker image name | postgres | added in release 1.0.0 | -| `DB_IMAGE_TAG` | Postgres docker image tag | 14.11-bullseye | added in release 1.0.0 | -| `DB_NAME` | Postgres database | rosetta-java | added in release 1.0.0 | -| `DB_USER` | Postgres admin user | rosetta_db_admin | added in release 1.0.0 | -| `DB_SECRET` | Postgres admin secret | weakpwd#123_d | added in release 1.0.0 | -| `DB_HOST` | Postgres host | db | added in release 1.0.0 | -| `DB_PORT` | Postgres port | 5432 | added in release 1.0.0 | -| `DB_SCHEMA` | Database schema | mainnet | added in release 1.0.0 | -| `DB_PATH` | Database path | /data | added in release 1.0.0 | -| `CARDANO_NODE_HOST` | Cardano node host | cardano-node | added in release 1.0.0 | -| `CARDANO_NODE_PORT` | Cardano node port | 3001 | added in release 1.0.0 | -| `CARDANO_NODE_VERSION` | Cardano node version | 8.9.2 | added in release 1.0.0 | -| `CARDANO_NODE_SUBMIT_HOST` | Cardano node submit API host | cardano-submit-api | added in release 1.0.0 | -| `NODE_SUBMIT_API_PORT` | Cardano node submit API port | 8090 | added in release 1.0.0 | -| `CARDANO_NODE_SOCKET_PATH` | Cardano node socket path | /node | added in release 1.0.0 | -| `CARDANO_NODE_SOCKET` | Cardano node socket file | /node/node.socket | added in release 1.0.0 | -| `CARDANO_NODE_DB` | Cardano node db path | /node/db | added in release 1.0.0 | -| `CARDANO_CONFIG` | Cardano node config path | /config/mainnet | added in release 1.0.0 | -| `API_DOCKER_IMAGE_TAG` | Docker Tag for API Image | main | added in release 1.0.0 | -| `API_SPRING_PROFILES_ACTIVE` | API spring profile | staging | added in release 1.0.0 | -| `API_PORT` | Rosetta API exposed port | 8082 | added in release 1.0.0 | -| `ROSETTA_VERSION` | Rosetta version | 1.4.13 | added in release 1.0.0 | -| `TOPOLOGY_FILEPATH` | Topology file path | ./config/mainnet/topology.json | added in release 1.0.0 | -| `GENESIS_SHELLEY_PATH` | Genesis file path | ./config/mainnet/shelley-genesis.json | added in release 1.0.0 | -| `GENESIS_BYRON_PATH` | Genesis file path | ./config/mainnet/byron-genesis.json | added in release 1.0.0 | -| `GENESIS_ALONZO_PATH` | Genesis file path | ./config/mainnet/alonzo-genesis.json | added in release 1.0.0 | -| `GENESIS_CONWAY_PATH` | Genesis file path | ./config/mainnet/conway-genesis.json | added in release 1.0.0 | -| `INDEXER_DOCKER_IMAGE_TAG` | Yaci indexer Docker version | main | added in release 1.0.0 | -| `PRUNING_ENABLED` | Enable spent UTXO pruning to reduce storage requirements | false | available in releases 1.0.0 - 1.2.8 | -| `REMOVE_SPENT_UTXOS` | Enable spent UTXO pruning to reduce storage requirements | false | added in release 1.2.9 | -| `PRUNING_INTERVAL` | Interval in seconds between pruning cleanup jobs | 600 | added in release 1.2.4 | -| `PRUNING_SAFE_BLOCKS` | Number of recent blocks to keep spent UTXOs for (safety margin) | 2160 | added in release 1.2.4 | -| `YACI_SPRING_PROFILES` | Yaci indexer spring profile | postgres | added in release 1.0.0 | -| `DEVKIT_ENABLED` | Devkit enabled | false | added in release 1.0.0 | -| `YACI_HTTP_BASE_URL` | Yaci Indexer's URL | http://yaci-indexer:9095/api/v1 | added in release 1.2.1 | -| `YACI_INDEXER_PORT` | Yaci Indexer's port | 9095 | added in release 1.2.1 | -| `HTTP_CONNECT_TIMEOUT_SECONDS` | Yaci connection timeout in seconds | 5 | added in release 1.2.1 | -| `HTTP_REQUEST_TIMEOUT_SECONDS` | Yaci request timeout in seconds | 5 | added in release 1.2.1 | -| `API_DB_POOL_MIN_COUNT` | Minimum number of connections API↔DB | 12 | added in release 1.2.5 | -| `API_DB_POOL_MAX_COUNT` | Maximum number of connections API↔DB | 12 | added in release 1.2.5 | -| `API_DB_POOL_MAX_LIFETIME_MS` | Description | 2000000 | added in release 1.2.5 | -| `API_DB_POOL_CONNECTION_TIMEOUT_MS` | Connection timeout in milliseconds | 100000 | added in release 1.2.5 | -| `API_DB_KEEP_ALIVE_MS` | Keep alive in milliseconds | 60000 | added in release 1.2.5 | -| `API_DB_LEAK_CONNECTIONS_WARNING_MS` | Leak connection warning threshold (ms) | 60000 | added in release 1.2.5 | -| `API_DB_MONITOR_PERFORMANCE` | Monitor performance enable? | false | added in release 1.2.5 | -| `DB_POSTGRES_MAX_CONNECTIONS` | Maximum concurrent database connections | 300 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_SHARED_BUFFERS` | Memory for caching | 4GB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_EFFECTIVE_CACHE_SIZE` | Disk cache size | 8GB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_WORK_MEM` | Memory per operation for query processing | 64MB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_MAINTENANCE_WORK_MEM` | Memory for maintenance tasks like index creation | 512GB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_WAL_BUFFERS` | Write-ahead log buffer memory | 512MB (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_CHECKPOINT_COMPLETION_TARGET` | Target checkpoint completion | 0.7 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_RANDOM_PAGE_COST` | Cost estimate for random disk page access | 1.3 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_EFFECTIVE_IO_CONCURRENCY` | Concurrent I/O for table scans | 2 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_PARALLEL_TUPLE_COST` | Cost per tuple in parallel queries | 0.05 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_PARALLEL_SETUP_COST` | Cost for initiating parallel query workers | 500 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_MAX_PARALLEL_WORKERS_PER_GATHER` | Parallel workers per query | 4 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_MAX_PARALLEL_WORKERS` | Total parallel workers across all queries | 8 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_SEQ_PAGE_COST` | Cost estimate for sequential disk page access | 1.0 | added in release 1.2.6 | -| `DB_POSTGRES_JIT` | Just-In-Time compilation setting | off | added in release 1.2.6 | -| `DB_POSTGRES_BGWRITER_LRU_MAXPAGES` | Max pages for background writer per cycle | 100 (mid-level profile) | added in release 1.2.6 | -| `DB_POSTGRES_BGWRITER_DELAY` | Delay between background writer cycles | 200ms (mid-level profile) | added in release 1.2.6 | +## Current Environment Variables (Version 1.2.9) + +| Variable | Description | Default | Notes | +| --------------------------------------------- | --------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------- | +| `LOG` | Log level | INFO | added in release 1.0.0 | +| `NETWORK` | Network | mainnet | added in release 1.0.0 | +| `MITHRIL_SYNC` | Sync from Mithril snapshot | true | added in release 1.0.0 | +| `PROTOCOL_MAGIC` | Cardano protocol magic | 764824073 | added in release 1.0.0 | +| `DB_IMAGE_NAME` | Postgres docker image name | postgres | added in release 1.0.0 | +| `DB_IMAGE_TAG` | Postgres docker image tag | 14.11-bullseye | added in release 1.0.0 | +| `DB_NAME` | Postgres database | rosetta-java | added in release 1.0.0 | +| `DB_USER` | Postgres admin user | rosetta_db_admin | added in release 1.0.0 | +| `DB_SECRET` | Postgres admin secret | weakpwd#123_d | added in release 1.0.0 | +| `DB_HOST` | Postgres host | db | added in release 1.0.0 | +| `DB_PORT` | Postgres port | 5432 | added in release 1.0.0 | +| `DB_SCHEMA` | Database schema | mainnet | added in release 1.0.0 | +| `DB_PATH` | Database path | /data | added in release 1.0.0 | +| `CARDANO_NODE_HOST` | Cardano node host | cardano-node | added in release 1.0.0 | +| `CARDANO_NODE_PORT` | Cardano node port | 3001 | added in release 1.0.0 | +| `CARDANO_NODE_VERSION` | Cardano node version | 10.3.1 | added in release 1.0.0 | +| `CARDANO_NODE_SUBMIT_HOST` | Cardano node submit API host | cardano-submit-api | added in release 1.0.0 | +| `NODE_SUBMIT_API_PORT` | Cardano node submit API port | 8090 | added in release 1.0.0 | +| `CARDANO_NODE_SOCKET_PATH` | Cardano node socket path | /node | added in release 1.0.0 | +| `CARDANO_NODE_SOCKET` | Cardano node socket file | /node/node.socket | added in release 1.0.0 | +| `CARDANO_NODE_DB` | Cardano node db path | /node/db | added in release 1.0.0 | +| `CARDANO_CONFIG` | Cardano node config path | /config/mainnet | added in release 1.0.0 | +| `API_DOCKER_IMAGE_TAG` | Docker Tag for API Image | main | added in release 1.0.0 | +| `API_SPRING_PROFILES_ACTIVE` | API spring profile | staging | added in release 1.0.0 | +| `API_PORT` | Rosetta API exposed port | 8082 | added in release 1.0.0 | +| `ROSETTA_VERSION` | Rosetta version | 1.4.13 | added in release 1.0.0 | +| `TOPOLOGY_FILEPATH` | Topology file path | ./config/mainnet/topology.json | added in release 1.0.0 | +| `GENESIS_SHELLEY_PATH` | Genesis file path | ./config/mainnet/shelley-genesis.json | added in release 1.0.0 | +| `GENESIS_BYRON_PATH` | Genesis file path | ./config/mainnet/byron-genesis.json | added in release 1.0.0 | +| `GENESIS_ALONZO_PATH` | Genesis file path | ./config/mainnet/alonzo-genesis.json | added in release 1.0.0 | +| `GENESIS_CONWAY_PATH` | Genesis file path | ./config/mainnet/conway-genesis.json | added in release 1.0.0 | +| `INDEXER_DOCKER_IMAGE_TAG` | Yaci indexer Docker version | main | added in release 1.0.0 | +| `REMOVE_SPENT_UTXOS` | Enable spent UTXO pruning to reduce storage requirements | false | added in release 1.2.9 | +| `REMOVE_SPENT_UTXOS_LAST_BLOCKS_GRACE_COUNT` | Number of recent blocks to keep spent UTXOs for (safety margin) | 2160 | added in release 1.2.9 | +| `YACI_SPRING_PROFILES` | Yaci indexer spring profile | postgres | added in release 1.0.0 | +| `DEVKIT_ENABLED` | Devkit enabled | false | added in release 1.0.0 | +| `YACI_HTTP_BASE_URL` | Yaci Indexer's URL | http://yaci-indexer:9095/api/v1 | added in release 1.2.1 | +| `YACI_INDEXER_PORT` | Yaci Indexer's port | 9095 | added in release 1.2.1 | +| `HTTP_CONNECT_TIMEOUT_SECONDS` | Yaci connection timeout in seconds | 5 | added in release 1.2.1 | +| `HTTP_REQUEST_TIMEOUT_SECONDS` | Yaci request timeout in seconds | 5 | added in release 1.2.1 | +| `API_DB_POOL_MIN_COUNT` | Minimum number of connections API↔DB | 12 (mid-level profile) | added in release 1.2.5, moved to profile env file in 1.2.6 | +| `API_DB_POOL_MAX_COUNT` | Maximum number of connections API↔DB | 12 (mid-level profile) | added in release 1.2.5, moved to profile env file in 1.2.6 | +| `API_DB_POOL_MAX_LIFETIME_MS` | Description | 2000000 | added in release 1.2.5 | +| `API_DB_POOL_CONNECTION_TIMEOUT_MS` | Connection timeout in milliseconds | 100000 | added in release 1.2.5 | +| `API_DB_KEEP_ALIVE_MS` | Keep alive in milliseconds | 60000 | added in release 1.2.5 | +| `API_DB_LEAK_CONNECTIONS_WARNING_MS` | Leak connection warning threshold (ms) | 60000 | added in release 1.2.5 | +| `API_DB_MONITOR_PERFORMANCE` | Monitor performance enable? | false | added in release 1.2.5 | +| `API_DB_SHOW_SQL` | Show formatted SQL queries in logs for debugging | false | added in release 1.2.5 | +| `DB_POSTGRES_MAX_CONNECTIONS` | Maximum concurrent database connections | 300 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_SHARED_BUFFERS` | Memory for caching | 4GB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_EFFECTIVE_CACHE_SIZE` | Disk cache size | 8GB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_WORK_MEM` | Memory per operation for query processing | 64MB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_MAINTENANCE_WORK_MEM` | Memory for maintenance tasks like index creation | 512MB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_WAL_BUFFERS` | Write-ahead log buffer memory | 512MB (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_CHECKPOINT_COMPLETION_TARGET` | Target checkpoint completion | 0.7 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_RANDOM_PAGE_COST` | Cost estimate for random disk page access | 1.3 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_EFFECTIVE_IO_CONCURRENCY` | Concurrent I/O for table scans | 2 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_PARALLEL_TUPLE_COST` | Cost per tuple in parallel queries | 0.05 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_PARALLEL_SETUP_COST` | Cost for initiating parallel query workers | 500 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_MAX_PARALLEL_WORKERS_PER_GATHER` | Parallel workers per query | 4 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_MAX_PARALLEL_WORKERS` | Total parallel workers across all queries | 8 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_SEQ_PAGE_COST` | Cost estimate for sequential disk page access | 1.0 | added in release 1.2.6 | +| `DB_POSTGRES_JIT` | Just-In-Time compilation setting | off | added in release 1.2.6 | +| `DB_POSTGRES_BGWRITER_LRU_MAXPAGES` | Max pages for background writer per cycle | 100 (mid-level profile) | added in release 1.2.6 | +| `DB_POSTGRES_BGWRITER_DELAY` | Delay between background writer cycles | 200ms (mid-level profile) | added in release 1.2.6 | + +## Deprecated Environment Variables (Previous Versions) + +The following environment variables were available in previous versions but are no longer supported in version 1.2.9: + +| Variable | Description | Default | Notes | +| --------------------- | --------------------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------- | +| `PRUNING_ENABLED` | Enable spent UTXO pruning to reduce storage requirements | false | available in releases 1.0.0 - 1.2.8, replaced by `REMOVE_SPENT_UTXOS` | +| `PRUNING_SAFE_BLOCKS` | Number of recent blocks to keep spent UTXOs for (safety margin) | 2160 | available in releases 1.2.4 - 1.2.8, replaced by `REMOVE_SPENT_UTXOS_LAST_BLOCKS_GRACE_COUNT` | +| `PRUNING_INTERVAL` | Interval in seconds between pruning cleanup jobs | 600 | available in releases 1.2.4 - 1.2.8, no longer configurable | diff --git a/docs/docs/install-and-deploy/hardware-profiles.md b/docs/docs/install-and-deploy/hardware-profiles.md index a27e8e7726..3fc60599a8 100644 --- a/docs/docs/install-and-deploy/hardware-profiles.md +++ b/docs/docs/install-and-deploy/hardware-profiles.md @@ -18,26 +18,22 @@ Hardware profiles are implemented as environment files that are passed to Docker Cardano Rosetta Java provides preconfigured hardware profiles to match different deployment scenarios: - - -### Entry-Level Hardware Profile + -Designed for development environments or smaller deployments with limited resources: +Optimized for **production environments** with moderate resources: -- 4 CPU cores -- 32 GB RAM -- Suitable for development, testing, or light production use +- 8 CPU cores +- 48 GB RAM +- Suitable for standard production deployments with moderate traffic - - -### Mid-Level Hardware Profile + -Optimized for production environments with moderate resources: +Designed for **development environments** or smaller deployments with limited resources: -- 8 CPU cores -- 48 GB RAM -- Suitable for standard production deployments with moderate traffic +- 4 CPU cores +- 32 GB RAM +- Suitable for development, testing, or light production use From 66220293d80d9f19b50bb3487458754a0a767da5 Mon Sep 17 00:00:00 2001 From: Lincon Vidal Date: Thu, 12 Jun 2025 17:16:12 -0300 Subject: [PATCH 13/13] docs: update storage requirements and pruning notes in documentation - Revised storage requirements in README and intro documentation to reflect updated values for both pruning enabled and disabled scenarios. - Added clarifications regarding the limitations of searching transactions by address when pruning is enabled in the pruning and cardano-addons documentation. --- README.md | 4 ++-- docs/docs/advanced-configuration/pruning.md | 4 +++- docs/docs/core-concepts/cardano-addons.md | 22 +++++++++++++++++---- docs/docs/intro.md | 12 +++++------ 4 files changed, 29 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9f63261dae..c978f92f41 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,8 @@ Since [Yaci-Store](https://github.com/bloxbean/yaci-store) is a comparatively li - 4CPU Cores - 32GB RAM -- 1TB of storage (spent UTXO pruning disabled) [default] -- 400GB of storage (spent UTXO pruning enabled) +- ~1.3 TB total storage (node ~250 GB + Rosetta DB ~1 TB) — pruning disabled [default] +- ~750 GB total storage (node ~250 GB + Rosetta DB ~500 GB) — pruning enabled Better hardware will improve the performance of the indexer and the node, which will result in faster syncing times. diff --git a/docs/docs/advanced-configuration/pruning.md b/docs/docs/advanced-configuration/pruning.md index a68f2791e1..1fe1bd3fa5 100644 --- a/docs/docs/advanced-configuration/pruning.md +++ b/docs/docs/advanced-configuration/pruning.md @@ -27,7 +27,7 @@ When enabled, the pruning process operates as follows: **Impact Summary:** | Aspect | Effect | | :------------------------- | :----------------------------------------------------------- | -| **Disk Storage** | ✅ Significantly reduced (e.g., mainnet from ~1TB to ~400GB) | +| **Disk Storage** | ✅ Significantly reduced (e.g., mainnet from ~1TB to ~500GB) | | **Current UTXO Set** | ✅ Fully preserved; current balances remain accurate | | **Historical Spent UTXOs** | ⚠️ Permanently deleted beyond the safety margin | | **Query Performance** | ✅ Improved for queries against the current UTXO set | @@ -51,6 +51,8 @@ When pruning is enabled, the `/network/status` endpoint includes an additional ` | `/network/*` | ✅ Works | ✅ Works | **None** - Independent of UTXO data | | `/construction/*` | ✅ Works | ✅ Works | **None** - Uses current UTXOs only | +After enabling pruning, searching for transactions by their hash will always work, because transaction records themselves are never pruned. However, searching by address is limited: address-based searches rely on the UTXO set, and once spent UTXOs older than the pruning window are deleted, only transactions involving current or recently spent UTXOs can be found by address. Older history is not returned once pruned. + ## When to Enable Pruning :::tip Recommended Use Cases diff --git a/docs/docs/core-concepts/cardano-addons.md b/docs/docs/core-concepts/cardano-addons.md index 4f3933c5ae..b175122e6c 100644 --- a/docs/docs/core-concepts/cardano-addons.md +++ b/docs/docs/core-concepts/cardano-addons.md @@ -73,6 +73,10 @@ Max amount of transactions allowed to be requested is defined by `PAGE_SIZE` env `status` and `maxBlock` filters work as excluding filters, if they are set, besides operator value. ::: +:::warning Pruning limitation +Searching for transactions by hash is always possible, because transaction records themselves are never pruned. However, searching by address is limited: address-based searches depend on the UTXO set, and once spent UTXOs older than the pruning window are deleted, only transactions involving current or recently spent UTXOs can be found by address. Older history is not returned once pruned. +::: + ### `/block` The following metadata is also returned, when querying for block information: @@ -163,14 +167,24 @@ For accounts that have a multi asset balance, these will be returned with the co } ``` -Also, `coins` will be returned with the token bundle list corresponding to each coin as metadata. +When querying `/account/balance`, the result depends on the type of address: -:::info Note on Stake Addresses -When the `/account/balance` endpoint is queried with a stake address (also known as a reward address), the response will include the available rewards that can be withdrawn from the stake address. +- For a **payment address** (Base or Enterprise), the response contains the sum of all unspent UTXOs for that address (the "spendable" balance). +- For a **stake address** (reward address), the response contains only the available rewards that can be withdrawn from that stake address. + +To present a wallet's total value, clients should query both the payment address (for spendable funds) and the stake address (for rewards), then combine the results. -This means the API provides a consolidated view of both spendable funds (from payment addresses) and claimable rewards when a stake address is used in the query. +:::info Note on Stake Addresses +A stake address never holds UTXOs and cannot have a spendable balance. The `/account/balance` response for a stake address always reflects only the withdrawable rewards. ::: +Internally, the Rosetta service gathers these two figures from different subsystems: + +- **Spendable funds** (ADA and native tokens) are obtained by summing all unspent UTXOs that belong to the payment address(es). These UTXOs are stored in the PostgreSQL database maintained by the **Yaci Indexer**. +- **Rewards balance** is fetched directly from the **Yaci Store** through a lightweight internal HTTP call, which queries the current withdrawable rewards for the stake address. + +As a consequence, the spendable portion updates whenever new blocks modify the UTXO set for the payment address, whereas the rewards portion changes only after the protocol distributes staking rewards (typically once per epoch). + ### `/account/coins` :::warning diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 9821ccd1b5..f88ebac8c5 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -23,12 +23,12 @@ For a more detailed architecture overview, see the [Architecture](core-concepts/ Running Cardano Rosetta Java requires the following minimum resources: -| Component | Requirement | Notes | -| :---------- | :---------- | :---------------------------------- | -| **CPU** | 4 Cores | | -| **RAM** | 32 GB | | -| **Storage** | 1 TB | When spent UTXO pruning is disabled | -| | 400 GB | When spent UTXO pruning is enabled | +| Component | Requirement | Notes | +| :---------- | :------------------------------------------------ | :-------------------------- | +| **CPU** | 4 Cores | | +| **RAM** | 32 GB | | +| **Storage** | ~1.3 TB total (node ~250 GB + Rosetta DB ~1 TB) | Spent UTXO pruning disabled | +| | ~750 GB total (node ~250 GB + Rosetta DB ~500 GB) | Spent UTXO pruning enabled | :::tip Performance Note Better hardware resources (more CPU cores, RAM) will improve indexer and node performance, resulting in faster chain synchronization and better API response times.