From ab74b5ad1de0c7ee54a50fbf2ed20de95fca4c3f Mon Sep 17 00:00:00 2001 From: "martin.zemanek" Date: Fri, 19 Apr 2024 14:18:12 +0200 Subject: [PATCH 1/2] preparing cosmos rpc docs --- v1.0/RPC Nodes/rpc-others/rpc-cosmos.md | 9 + .../rpc-cosmos-constructionmetadata.md | 90 ++++++++++ .../rpc-cosmos-constructionpayloads.md | 168 ++++++++++++++++++ .../rpc-cosmos-constructionpreprocess.md | 160 +++++++++++++++++ .../rpc-cosmos-createnetworktransaction.md | 125 +++++++++++++ .../rpc-cosmos/rpc-cosmos-deriveaccount.md | 89 ++++++++++ .../rpc-cosmos-getaccountbalance.md | 99 +++++++++++ .../rpc-cosmos/rpc-cosmos-getaccountcoins.md | 102 +++++++++++ .../rpc-cosmos/rpc-cosmos-getblock.md | 81 +++++++++ .../rpc-cosmos-getblocktransaction.md | 86 +++++++++ .../rpc-cosmos-gethashoftransaction.md | 80 +++++++++ .../rpc-cosmos/rpc-cosmos-getnetworklist.md | 64 +++++++ .../rpc-cosmos/rpc-cosmos-getnetworkstatus.md | 82 +++++++++ .../rpc-cosmos/rpc-cosmos-parsetransaction.md | 82 +++++++++ .../rpc-cosmos-searchtransactions.md | 127 +++++++++++++ .../rpc-cosmos-submittransaction.md | 80 +++++++++ 16 files changed, 1524 insertions(+) create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionmetadata.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpayloads.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpreprocess.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-createnetworktransaction.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-deriveaccount.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountbalance.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountcoins.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblock.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblocktransaction.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-gethashoftransaction.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworklist.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworkstatus.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-parsetransaction.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-searchtransactions.md create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-submittransaction.md diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos.md new file mode 100644 index 00000000..42181440 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos.md @@ -0,0 +1,9 @@ +--- +title: "Cosmos" +slug: "rpc-cosmos" +excerpt: "" +hidden: false +createdAt: "Wed Mar 06 2024 10:35:18 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 12:59:41 GMT+0000 (Coordinated Universal Time)" +--- + diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionmetadata.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionmetadata.md new file mode 100644 index 00000000..e3f462cf --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionmetadata.md @@ -0,0 +1,90 @@ +--- +title: "constructionMetadata" +slug: "rpc-cardano-constructionmetadata" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 12:59:40 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const params = { + networkIdentifier: { + blockchain: 'CARDANO', // string, required + network: 'NETWORK_NAME', // string, required + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', // string (optional) + metadata: { + [key: string]: any, // object (optional) + }, + }, + }, + options: { + // Optional object + }, + publicKeys: [ + { + hexBytes: 'PUBLIC_KEY_HEX_BYTES', // Required: Specifies the hexadecimal representation of the staking credential . + curveType: 'SECP256K1', // Required: Specifies the curve type for the staking credential .] + }, + ] +}; + +// Retrieve metadata for transaction construction on the Cardano network +const metadata = await tatum.rpc.constructionMetadata(params); + +// Log the metadata +console.log('Cardano Transaction Construction Metadata:', metadata); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `constructionMetadata` method allows you to retrieve metadata required to construct a transaction for a specific network. + +### Example Use Cases + +1. **Metadata Retrieval**: Developers can use this method along with the `constructionPreprocess` endpoint to retrieve metadata required for transaction construction in an offline environment. + +### Request Parameters + +The `constructionMetadata` method requires the following parameters: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `options` (object, optional): Some blockchains require different metadata for different types of transaction construction (ex: delegation versus a transfer). Instead of requiring a blockchain node to return all possible types of metadata for construction (which may require multiple node fetches), the client can populate an options object to limit the metadata returned to only the subset required. +- `publicKey` (object, required): 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. + - `hexBytes` (string, required): The hexadecimal representation of the public key. + - `curveType` (string, enum, required): The type of cryptographic curve associated with the public key (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). + +### Return Object + +The method returns an object representing the metadata required to construct a transaction for a specific network. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpayloads.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpayloads.md new file mode 100644 index 00000000..bf5c7977 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpayloads.md @@ -0,0 +1,168 @@ +--- +title: "constructionPayloads" +slug: "rpc-cardano-constructionpayloads" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const params = { + networkIdentifier: { + blockchain: 'CARDANO', // Required: Specifies the blockchain . + network: 'MAINNET', // Required: Specifies the network name . + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', // Optional: Specifies the sub-network name . + metadata: { + KEY: 'VALUE', // Optional: Specify metadata . + }, + }, + }, + operations: [ + { + operation_identifier: { + index: 1, // Required: Specifies the operation index (number). + network_index: 0, // Optional: Specifies the network index (number). + }, + related_operations: [ + { + index: 2, // Optional: Specifies the related operation index (number). + network_index: 1, // Optional: Specifies the related network index (number). + }, + ], + type: 'OPERATION_TYPE', // Required: Specifies the operation type. + status: 'OPERATION_STATUS', // Optional: Specifies the operation status . + account: { + address: 'ACCOUNT_ADDRESS', // Required: Specifies the account address . + sub_account: { + address: 'SUB_ACCOUNT_ADDRESS', // Optional: Specifies the sub-account address . + metadata: { + // Optional metadata object for the sub-account + }, + }, + metadata: { + // Optional metadata object for the account + }, + }, + amount: { + value: 'AMOUNT_VALUE', // Required: Specifies the amount value (string). + currency: { + symbol: 'CURRENCY_SYMBOL', // Required: Specifies the currency symbol . + decimals: 6, // Required: Specifies the currency decimals (number). + metadata: { + // Optional metadata for amount object + }, + }, + metadata: { + // Optional: Specify metadata here only if applicable. + }, + }, + coin_change: { + coin_identifier: { + identifier: 'COIN_IDENTIFIER', // Required: uniquely identifies a Coin. + }, + coin_action: 'coin_created', // Required + }, + metadata: { + // Optional: Specify operations metadata only if applicable. + } + }, + ], + metadata: { + // Optional metadata for constructionPayloads + }, + publicKeys: [ + { + hexBytes: 'PUBLIC_KEY_HEX_BYTES', // Required: Specifies the hexadecimal representation of the staking credential . + curveType: 'SECP256K1', // Required: Specifies the curve type for the staking credential .] + }, + ] +}; + +// Generate an unsigned transaction and signing payloads +const constructionPayloads = await tatum.constructionPayloads(params); + +// Log the construction payloads +console.log('Construction Payloads:', constructionPayloads); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `constructionPayloads` contains the network, a slice of operations, and arbitrary metadata that was returned by the call to `constructionMetadata`. Optionally, the request can also include an array of publicKeys associated with the AccountIdentifiers returned in `constructionPreprocess` response. + +### Example Use Cases + +1. **Transaction Construction**: Developers can use this method to construct an unsigned transaction that specifies the intent of the transaction but not all possible effects. The generated payloads can be signed by the specified account identifiers to complete the transaction. + +### Request Parameters + +The `constructionPayloads` method requires the following parameters: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `operations` (array of objects, required): An array of operation objects, where each object represents a transaction to be included in the Cardano transaction. + - `operation_identifier` (object, required): An object containing an index that uniquely identifies the operation. + - `index` (number, required): The index of the operation. + - `network_index` (number, optional): The network-specific index of the operation. + - `related_operations` (array of objects, optional): An array of related operation identifiers if applicable. + - `index` (number, optional): The index of the related operation. + - `network_index` (number, optional): The network-specific index of the related operation. + - `type` (string, required): The type of the operation (e.g., "TRANSFER"). + - `status` (string, optional): The status of the operation (e.g., "SUCCESS"). + - `account` (object, required): An object containing information about the account. + - `address` (string, required): The Cardano account address associated with the operation. + - `sub_account` (object, optional): An optional sub-account object. + - `address` (string, optional): The sub-account address. + - `metadata` (object, optional): An optional metadata object for the sub-account. If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. + - `metadata` (object, optional): An optional metadata object for the account. Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata. + - `amount` (object, required): An object containing information about the transaction amount. + - `value` (string, required): The value of the transaction amount. + - `currency` (object, required): An object specifying the currency details. + - `symbol` (string, required): The symbol or code of the currency. + - `decimals` (number, required): The number of decimal places for the currency. + - `metadata` (object, optional): Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token. + - `metadata` (object, optional): metadata object for the amount. + - `coin_change` (object, required): An object containing information about coin changes in the operation. + - `coin_identifier` (object, required): An object containing a coin identifier. + - `identifier` (string, required): Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction_hash:index.. + - `coin_action` (string, required): 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. (e.g., 'coin_created' | 'coin_spent'). + - `metadata` (object, optional): An optional metadata object for the operation, including withdrawal, deposit, refund, staking credential, pool key hash, epoch, token bundle, pool registration certificate, pool registration parameters, and vote registration metadata details. +- `metadata` (object, optional): Specify the metadata for transaction construction. +- `publicKey` (object, required): 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. + - `hexBytes` (string, required): The hexadecimal representation of the public key. + - `curveType` (string, enum, required): The type of cryptographic curve associated with the public key (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). + +### Return Object + +The `constructionPayloads` method returns an object representing the unsigned transaction blob and a collection of payloads that must be signed by particular AccountIdentifiers using a certain SignatureType. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpreprocess.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpreprocess.md new file mode 100644 index 00000000..9284d78a --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpreprocess.md @@ -0,0 +1,160 @@ +--- +title: "constructionPreprocess" +slug: "rpc-cardano-constructionpreprocess" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const params = { + networkIdentifier: { + blockchain: 'CARDANO', // Required: Specifies the blockchain . + network: 'MAINNET', // Required: Specifies the network name . + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', // Optional: Specifies the sub-network name . + metadata: { + KEY: 'VALUE', // Optional: Specify metadata . + }, + }, + }, + operations: [ + { + operation_identifier: { + index: 1, // Required: Specifies the operation index (number). + network_index: 0, // Optional: Specifies the network index (number). + }, + related_operations: [ + { + index: 2, // Optional: Specifies the related operation index (number). + network_index: 1, // Optional: Specifies the related network index (number). + }, + ], + type: 'OPERATION_TYPE', // Required: Specifies the operation type. + status: 'OPERATION_STATUS', // Optional: Specifies the operation status . + account: { + address: 'ACCOUNT_ADDRESS', // Required: Specifies the account address . + sub_account: { + address: 'SUB_ACCOUNT_ADDRESS', // Optional: Specifies the sub-account address . + metadata: { + // Optional metadata object for the sub-account + }, + }, + metadata: { + // Optional metadata object for the account + }, + }, + amount: { + value: 'AMOUNT_VALUE', // Required: Specifies the amount value (string). + currency: { + symbol: 'CURRENCY_SYMBOL', // Required: Specifies the currency symbol . + decimals: 6, // Required: Specifies the currency decimals (number). + metadata: { + // Optional metadata for amount object + }, + }, + metadata: { + // Optional: Specify metadata here only if applicable. + }, + }, + coin_change: { + coin_identifier: { + identifier: 'COIN_IDENTIFIER', // Required: uniquely identifies a Coin. + }, + coin_action: 'coin_created', // Required + }, + metadata: { + // Optional: Specify operations metadata only if applicable. + } + }, + ], + metadata: { + //Optional: Specify constructionPreprocess metadata only if applicable. + } +}; + +// Create a request to fetch metadata for transaction construction +const preprocessRequest = await tatum.rpc.constructionPreprocess(params); + +// Log the preprocess request +console.log('Construction Preprocess Request:', preprocessRequest); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `constructionPreprocess` method is called prior to `constructionPayloads` to construct a request for any metadata that is needed for transaction construction. This method is used to fetch information such as account nonce. The `options` object returned from this method will be sent to the `constructionMetadata` endpoint **UNMODIFIED** by the caller in an offline execution environment. If your Construction API implementation has configuration options, they MUST be specified in the `constructionPreprocess` request in the `metadata` field. + +### Example Use Cases + +1. **Transaction Construction**: Developers can use this method to fetch metadata required for transaction construction, such as the account nonce. +2. **Validation**: Validators can use this method to validate transaction data before the actual transaction construction. + +### Request Parameters + +The `constructionPreprocess` method requires the following parameters: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `operations` (array of objects, required): An array of operation objects, where each object represents a transaction to be included in the Cardano transaction. + - `operation_identifier` (object, required): An object containing an index that uniquely identifies the operation. + - `index` (number, required): The index of the operation. + - `network_index` (number, optional): The network-specific index of the operation. + - `related_operations` (array of objects, optional): An array of related operation identifiers if applicable. + - `index` (number, optional): The index of the related operation. + - `network_index` (number, optional): The network-specific index of the related operation. + - `type` (string, required): The type of the operation (e.g., "TRANSFER"). + - `status` (string, optional): The status of the operation (e.g., "SUCCESS"). + - `account` (object, required): An object containing information about the account. + - `address` (string, required): The Cardano account address associated with the operation. + - `sub_account` (object, optional): An optional sub-account object. + - `address` (string, optional): The sub-account address. + - `metadata` (object, optional): An optional metadata object for the sub-account. If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. + - `metadata` (object, optional): An optional metadata object for the account. Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata. + - `amount` (object, required): An object containing information about the transaction amount. + - `value` (string, required): The value of the transaction amount. + - `currency` (object, required): An object specifying the currency details. + - `symbol` (string, required): The symbol or code of the currency. + - `decimals` (number, required): The number of decimal places for the currency. + - `metadata` (object, optional): Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token. + - `metadata` (object, optional): metadata object for the amount. + - `coin_change` (object, required): An object containing information about coin changes in the operation. + - `coin_identifier` (object, required): An object containing a coin identifier. + - `identifier` (string, required): Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction_hash:index.. + - `coin_action` (string, required): 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. (e.g., 'coin_created' | 'coin_spent'). + - `metadata` (object, optional): An optional metadata object for the operation, including withdrawal, deposit, refund, staking credential, pool key hash, epoch, token bundle, pool registration certificate, pool registration parameters, and vote registration metadata details. +- `metadata` (object, optional): Metadata for `constructionPreprocess` + +### Return Object + +The method returns an object representing the preprocess request for transaction construction. This object includes the metadata required for constructing the transaction. The `options` object in this request will be sent to the `constructionMetadata` endpoint **UNMODIFIED** by the caller in an offline execution environment. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-createnetworktransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-createnetworktransaction.md new file mode 100644 index 00000000..e30258bb --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-createnetworktransaction.md @@ -0,0 +1,125 @@ +--- +title: "createNetworkTransaction" +slug: "rpc-cardano-createnetworktransaction" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const params = { + networkIdentifier: { + blockchain: 'CARDANO', // Specify the blockchain identifier ('CARDANO' for Cardano). + network: 'NETWORK_NAME', // Specify the network name. + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', // Specify the sub-network name (optional). + metadata: { + // Optional metadata key-value pairs. + }, + }, + }, + unsignedTransaction: 'UNSIGNED_TRANSACTION', // Specify the unsigned transaction blob. + signatures: [ + { + signing_payload: { + address: 'ADDRESS', // [DEPRECATED] Network-specific address (optional). + accountIdentifier: { + address: 'ADDRESS', // Account address. + subAccount: { + address: 'ADDRESS', // Sub-account address (optional). + metadata: { + // Sub-account metadata (optional). + }, + }, + metadata: { + // Account metadata (optional). + }, + }, + hexBytes: 'PAYLOAD_HEX', // Hex-encoded payload bytes. + signatureType: 'ecdsa', // Signature type (ecdsa, ecdsa_recovery, ed25519, schnorr_1, schnorr_bip340, schnorr_poseidon). + }, + publicKeys: [ + { + hexBytes: 'PUBLIC_KEY_HEX', // Hexadecimal representation of the public key. + curveType: 'secp256k1', // Curve type (secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). + }, + ], + signatureType: 'ecdsa', // Signature type (ecdsa, ecdsa_recovery, ed25519, schnorr_1, schnorr_bip340, schnorr_poseidon). + hexBytes: 'SIGNATURE_HEX', // Hex-encoded signature. + }, + ], +}; + +// Create network transaction from signatures +const networkTransaction = await tatum.rpc.createNetworkTransaction(params); + +// Log the network transaction +console.log('Network Transaction:', networkTransaction); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `createNetworkTransaction` method allows you to create 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. + +### Example Use Cases + +1. **Transaction Construction**: Developers can use this method to combine an unsigned Cardano transaction with the corresponding signatures, resulting in a fully signed network transaction ready to be submitted to the Cardano network. + +### Request Parameters + +The `createNetworkTransaction` method requires the following parameters in the request body: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `unsignedTransaction` (string, required): Contains the unsigned transaction blob returned by the `constructionPayloads` endpoint. The unsigned transaction represents the basic structure and details of the transaction before it is signed. +- `signatures` (array of objects, required): This parameter is an array of signatures. Each signature is represented by a Signature object. Signatures are required to create a network transaction by combining them with the unsigned transaction. + - `signing_payload` (object, required): The payload that was signed. + - `address` (string, optional): [DEPRECATED] The network-specific address of the account that should sign the payload. + - `accountIdentifier` (object, optional): An object containing information about the account. + - `address` (string, required): The Cardano account address associated with the operation. + - `sub_account` (object, optional): An optional sub-account object. + - `address` (string, optional): The sub-account address. + - `metadata` (object, optional): An optional metadata object for the sub-account. If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. + - `metadata` (object, optional): An optional metadata object for the account. Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata. + - `hex_bytes` (string, required): Hex-encoded string of the payload bytes. + - `signatureType` (string, enum, optional): Signature type (Choose from: ecdsa, ecdsa_recovery, ed25519, schnorr_1, schnorr_bip340, schnorr_poseidon). + - `publicKey` (object, required): 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. + - `hexBytes` (string, required): The hexadecimal representation of the public key. + - `curveType` (string, enum, required): The type of cryptographic curve associated with the public key (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). + - `signatureType` (string, enum, required): Signature type (Choose from: ecdsa, ecdsa_recovery, ed25519, schnorr_1, schnorr_bip340, schnorr_poseidon). + - `hexBytes` (string, required): Hex-encoded string representing the signature. + +### Return Object + +The method returns an object representing the network transaction created from the unsigned transaction and provided signatures. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-deriveaccount.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-deriveaccount.md new file mode 100644 index 00000000..2a254766 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-deriveaccount.md @@ -0,0 +1,89 @@ +--- +title: "deriveAccount" +slug: "rpc-cardano-deriveaccount" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const params = { + networkIdentifier: { + blockchain: 'CARDANO', // string, required + network: 'NETWORK_NAME', // string, required + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', // string (optional) + metadata: { + [key: string]: any, // object (optional) + }, + }, + }, + publicKeys: { + hexBytes: 'PUBLIC_KEY_HEX_BYTES', // string, required + curveType: 'secp256k1', // CurveType, required (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas) + }, + metadata: { + // metadata is optional object + }, +}; + +// Derive the account identifier from the public key +const accountIdentifier = await tatum.rpc.deriveAccount(params); + +// Log the account identifier +console.log('Account Identifier:', accountIdentifier); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `deriveAccount` method allows you to derive an account identifier (AccountIdentifier) from a public key. + +### Example Use Cases + +1. **Account Identification**: Developers can use this method to derive the account identifier associated with a public key. + +### Request Parameters + +The `deriveAccount` method requires the following parameter: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `publicKey` (object, required): 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. + - `hexBytes` (string, required): The hexadecimal representation of the public key. + - `curveType` (string, enum, required): The type of cryptographic curve associated with the public key (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). +- `metadata` (object, optional): An optional metadata object. + +### Return Object + +The method returns an object representing the derived account identifier (AccountIdentifier) associated with the specified public key. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountbalance.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountbalance.md new file mode 100644 index 00000000..fe7fc456 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountbalance.md @@ -0,0 +1,99 @@ + +--- +title: "accountBalance" +slug: "accountBalance" +category: "6620f7e31ea673003624a8cc" +excerpt: "Rosetta API for Cosmos" +hidden: false +metadata: + image: [] + keywords: "Cosmos, account balance, Rosetta API" + robots: "index" +createdAt: "Wed Apr 11 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Wed Apr 11 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" +--- + +## Overview + +The `/account/balance` method retrieves the balance of an account on the Cosmos network using the Rosetta API. It provides detailed information about the available and current spending balance of an account, including sub-accounts if specified. + +## Parameters + +| Name | Type | Required | Description | +| ------------------- | ------------- | -------- | ------------------------------------------------------------- | +| network_identifier | object | Yes | Identifies the blockchain and network. | +| account_identifier | object | Yes | Identifies the account for which the balance is requested. | + +## Returns + +The method returns the current balance of the specified account and sub-account (if provided): + +| Field | Description | +| --------------- | ----------------------------------------------------------------------- | +| account_balance | The total balance of the account in the smallest unit of the currency. | +| sub_account_balance | (Optional) The balance of the sub-account, if applicable. | + +## Example Result + +```json +{ + "block_identifier": { + "index": 123456, + "hash": "b10a8db164e0754105b7a99be72e3fe5" + }, + "balances": [ + { + "value": "100000000", + "currency": { + "symbol": "ATOM", + "decimals": 6 + } + } + ], + "metadata": {} +} +``` + +## Request Example + +```json cURL +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "network_identifier": { + "blockchain": "cosmos", + "network": "mainnet" + }, + "account_identifier": { + "address": "cosmos1l0znsvddllw9knha3yx2svnlxny676d8ns7uys", + "sub_account": { + "address": "cosmos1dq72ndqvcfnfgptud5puvys46y0zma5pvt37gz" + } + } +}' +``` +```typescript +// yarn add @tatumio/tatum + +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; + +const cosmos = await TatumSDK.init({ network: Network.COSMOS_MAINNET }); + +const accountBalance = await tatum.rpc.getAccountBalance({ + network_identifier: { + blockchain: "cosmos", + network: "mainnet" + }, + account_identifier: { + address: "cosmos1l0znsvddllw9knha3yx2svnlxny676d8ns7uys", + sub_account: { + address: "cosmos1dq72ndqvcfnfgptud5puvys46y0zma5pvt37gz" + } + } +}); + +console.log(accountBalance); + +await cosmos.destroy(); // Destroy Tatum SDK - needed for stopping background jobs +``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountcoins.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountcoins.md new file mode 100644 index 00000000..8aca0ec3 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountcoins.md @@ -0,0 +1,102 @@ +--- +title: "accountCoins" +slug: "accountCoins" +category: "6620f7e31ea673003624a8cc" +excerpt: "Rosetta API for {{blockchain}}" +hidden: false +metadata: + image: [] + keywords: "{{blockchain}}, account coins, Rosetta API" + robots: "index" +createdAt: "Wed Apr 11 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Wed Apr 11 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" +--- + +## Overview + +The `/account/coins` method retrieves information about the coins stored at a specific account address on the {{blockchain}} network, using the Rosetta API. This includes detailed data on each coin or token associated with the account, which is crucial for tracking asset distributions and understanding the account's composition on the blockchain. + +## Parameters + +| Name | Type | Required | Description | +| ------------------- | ------------- | -------- | ------------------------------------------------------------- | +| network_identifier | object | Yes | Identifies the blockchain and network. | +| account_identifier | object | Yes | Identifies the account for which the coin details are requested. Includes primary and sub-account details. | + +## Returns + +The response includes details about each coin held in the specified account and sub-account (if provided): + +| Field | Description | +| --------------- | ----------------------------------------------------------------------- | +| coins | A list of coin objects representing each asset held by the account. | +| block_identifier| The block identifier where the latest balance snapshot was taken. | + +## Example Result + +```json +{ + "block_identifier": { + "index": 1234567, + "hash": "a1b2c3d4..." + }, + "coins": [ + { + "coin_identifier": { + "identifier": "coin1" + }, + "amount": { + "value": "100000000", + "currency": { + "symbol": "ATOM", + "decimals": 6 + } + } + } + ] +} +``` + +## Request Example + +```json cURL +curl --location 'https://api.tatum.io/v3/blockchain/node/{{blockchain}}-{{network}}/' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "network_identifier": { + "blockchain": "{{blockchain}}", + "network": "{{network}}" + }, + "account_identifier": { + "address": "{{address}}", + "sub_account": { + "address": "{{addressto}}" + } + } +}' +``` +```typescript +// yarn add @tatumio/tatum + +import { TatumSDK, {{BlockchainModule}}, Network } from "@tatumio/tatum"; + +const {{blockchain}} = await TatumSDK.init<{{BlockchainModule}}>({ network: Network.{{BLOCKCHAIN_NETWORK}} }); + +const accountCoins = await tatum.rpc.getAccountCoins({ + network_identifier: { + blockchain: "{{blockchain}}", + network: "{{network}}" + }, + account_identifier: { + address: "{{address}}", + sub_account: { + address: "{{addressto}}" + } + } +}); + +console.log(accountCoins); + +await {{blockchain}}.destroy(); // Destroy Tatum SDK - needed for stopping background jobs +``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblock.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblock.md new file mode 100644 index 00000000..f923bec1 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblock.md @@ -0,0 +1,81 @@ +--- +title: "getBlock" +slug: "rpc-cardano-getblock" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const params = { + networkIdentifier: { + blockchain: 'CARDANO', // string, required + network: 'NETWORK_NAME', // string, required + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', // string (optional) + metadata: { + [key: string]: any, // object (optional) + }, + }, + }, + blockIdentifier: { + index: 1123941, // number (int64), required + hash: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85', // string (optional) + }, +}; + +// Call the getBlock +const block = await tatum.rpc.getBlock(params); + +// Log the block details +console.log('Block:', block); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getBlock` method allows you to retrieve information about a specific Cardano block based on the provided parameters. + +### Request Body + +The request body should contain the following parameters: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `blockIdentifier` (object): An object containing information about the block to retrieve. + - `index` (number, required): The index of the block (Type: number, Format: int64). + - `hash` (string): The hash of the block (optional). + +### Response + +The response will contain details about the specified Cardano block. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblocktransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblocktransaction.md new file mode 100644 index 00000000..529ed574 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblocktransaction.md @@ -0,0 +1,86 @@ +--- +title: "getBlockTransaction" +slug: "rpc-cardano-getblocktransaction" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const params = { + networkIdentifier: { + blockchain: 'CARDANO', // string, required + network: 'NETWORK_NAME', // string, required + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', + metadata: { + [key: string]: any + } // string (optional) + }, + }, + blockIdentifier: { + index: 1123941, // number (int64), required + hash: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85', // string, required + }, + transactionIdentifier: { + hash: 'TRANSACTION_HASH', // string, required + }, +}; + +// Call the getBlockTransaction +const transaction = await tatum.rpc.getBlockTransaction(params); + +// Log the transaction details +console.log('Transaction:', transaction); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getBlockTransaction` method allows you to retrieve information about a specific transaction within a Cardano block based on the provided parameters. + +### Request Body + +The request body should contain the following parameters: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `blockIdentifier` (object, required): An object containing information about the block to which the transaction belongs. + - `index` (number, required): The index of the block (Type: number, Format: int64). + - `hash` (string, required): The hash of the block. +- `transactionIdentifier` (object, required): An object containing information about the transaction. + - `hash` (string, required): The hash of the transaction. + +### Response + +The response will contain details about the specified Cardano transaction. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-gethashoftransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-gethashoftransaction.md new file mode 100644 index 00000000..6b5f8902 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-gethashoftransaction.md @@ -0,0 +1,80 @@ +--- +title: "getHashOfTransaction" +slug: "rpc-cardano-gethashoftransaction" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const hashRequest = { + networkIdentifier: { + blockchain: 'CARDANO', // Specify the blockchain identifier ('CARDANO' for Cardano). + network: 'NETWORK_NAME', // Specify the network name. + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', // Specify the sub-network name (optional). + metadata: { + // Optional metadata key-value pairs. + }, + }, + }, + signedTransaction: 'SIGNED_TRANSACTION', // Specify the signed transaction blob. +}; + +// Calculate the hash of the transaction +const transactionHash = await tatum.rpc.getHashOfTransaction(hashRequest); + +// Log the transaction hash +console.log('Transaction Hash:', transactionHash); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getHashOfTransaction` method allows you to calculate the unique transaction hash (ID) for a signed transaction. The transaction hash represents the unique identifier for a transaction on the Cardano blockchain. + +### Example Use Cases + +1. **Transaction Hash Calculation**: Developers can use this method to calculate the transaction hash for a signed transaction, which can be useful for tracking and verifying transactions on the Cardano network. + +### Request Parameters + +The `getHashOfTransaction` method requires the following parameters in the request body: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `signedTransaction` (string, required): The signed transaction blob for which you want to calculate the transaction hash. + +### Return Object + +The method returns a string representing the transaction hash (ID) of the provided signed transaction. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworklist.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworklist.md new file mode 100644 index 00000000..48dff855 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworklist.md @@ -0,0 +1,64 @@ +--- +title: "getNetworkList" +slug: "rpc-cardano-getnetworklist" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 12:59:42 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Optional metadata parameter +const params = metadata: { + [key: string]: any, // object (optional) + }, + +// Call the `getNetworkList` method +const networkList = await tatum.rpc.getNetworkList(params); + +// Log the network list +console.log('Network List:', networkList); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getNetworkList` method allows you to retrieve a list of available networks that the Rosetta server supports. + +### Example Use Cases + +1. **Supported Networks**: Developers can use this method to retrieve the list of networks supported by the Rosetta server. + +### Request Parameters + +The `getNetworkList` method has only optional metadata object. + +- `metadata` (object, optional) + +### Return Object + +The method returns an object representing the list of available networks supported by the Rosetta server. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworkstatus.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworkstatus.md new file mode 100644 index 00000000..170a33b3 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworkstatus.md @@ -0,0 +1,82 @@ +--- +title: "getNetworkStatus" +slug: "rpc-cardano-getnetworkstatus" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const params = { + network_identifier: { + blockchain: 'CARDANO', // string, required + network: 'NETWORK_NAME', // string, required + sub_network_identifier: { + network: 'SUB_NETWORK_NAME', // string (optional) + metadata: { + [key: string]: any, // object (optional) + }, + }, + }, + metadata: { + [key: string]: any, // object (optional) + }, +}; + +// Retrieve the status of the Cardano network +const getNetworkStatus = await tatum.rpc.getNetworkStatus(params); + +// Log the network status +console.log('Cardano Network Status:', getNetworkStatus); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getNetworkStatus` method allows you to retrieve the current status of a Cardano network. + +### Example Use Cases + +1. **Network Information**: Developers can use this method to retrieve the current status and information of a Cardano network, including details about the network itself and its status. + +### Request Parameters + +The `getNetworkStatus` method requires the following parameters: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `metadata` (object, optional): Metadata associated with the network status. + +### Return Object + +The method returns an object representing the current status of the Cardano network. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-parsetransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-parsetransaction.md new file mode 100644 index 00000000..52e5919e --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-parsetransaction.md @@ -0,0 +1,82 @@ +--- +title: "parseTransaction" +slug: "rpc-cardano-parsetransaction" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const parseRequest = { + networkIdentifier: { + blockchain: 'CARDANO', // Specify the blockchain identifier ('CARDANO' for Cardano). + network: 'NETWORK_NAME', // Specify the network name. + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', // Specify the sub-network name (optional). + metadata: { + // Optional metadata key-value pairs. + }, + }, + }, + signed: true, // Specify whether the transaction is signed (boolean). + transaction: 'TRANSACTION', // Specify the transaction blob (either unsigned or signed). +}; + +// Parse the transaction +const parsedTransaction = await tatum.rpc.transactionParse(parseRequest); + +// Log the parsed transaction +console.log('Parsed Transaction:', parsedTransaction); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `transactionParse` method allows you to parse either an unsigned or signed transaction and retrieve information about the transaction. It is used to examine the details of a transaction without submitting it to the blockchain. + +### Example Use Cases + +1. **Transaction Inspection**: Developers can use this method to inspect and verify the details of a transaction before submitting it to the Cardano network. + +### Request Parameters + +The `transactionParse` method requires the following parameters in the request body: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `signed` (boolean, required): A boolean indicating whether the transaction is signed. Set to `true` for a signed transaction and `false` for an unsigned transaction. +- `transaction` (string, required): The transaction blob, which must be either the unsigned transaction blob returned by `constructionPayloads` or the signed transaction blob returned by `constructionCombine`. + +### Return Object + +The method returns an object containing parsed information about the transaction, such as transaction inputs, outputs, and other details. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-searchtransactions.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-searchtransactions.md new file mode 100644 index 00000000..6b5177e9 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-searchtransactions.md @@ -0,0 +1,127 @@ +--- +title: "searchTransactions" +slug: "rpc-cardano-searchtransactions" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 12:59:40 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const params = { + networkIdentifier: { + blockchain: 'CARDANO', + network: 'NETWORK_NAME', + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', + metadata: { + // Optional metadata key-value pairs. + }, + }, + }, + operator: { + // Specify search conditions (optional). + }, + max_block: 5, // The largest block index to consider (optional). + offset: 5, // The offset into the query result to start returning transactions (optional). + limit: 5, // The maximum number of transactions to return in one call (optional). + transactionIdentifier: { + hash: 'TRANSACTION_HASH', // string, required + }, + accountIdentifier: { + address: 'ACCOUNT_ADDRESS', // string, required + sub_account: { + // Specify sub-account information if applicable + }, + metadata: { + chain_code: 'CHAIN_CODE', // Specify chain code if applicable + }, + }, + coin_identifier: { + identifier: 'CO' // Specify search conditions (optional). + }, + currency: { + symbol: 'CURRENCY_SYMBOL', // Required: Specifies the currency symbol . + decimals: 6, // Required: Specifies the currency decimals (number). + metadata: { + // Optional metadata for amount object + }, + }, + status: 'reverted', // The network-specific operation status type (optional). + type: 'transfer', // The network-specific operation type (optional). + address: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347', // Account address (optional). + success: true, // A synthetic condition (optional). +}; + +// Search for transactions +const transactions = await tatum.rpc.searchTransactions(params); + +// Log the retrieved transactions +console.log('Transactions:', transactions); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `searchTransactions` method allows you to search for transactions matching a set of provided conditions in canonical blocks. This can be useful for querying transaction data based on various criteria. + +### Example Use Cases + +1. **Transaction Query**: Developers can use this method to search for transactions that meet specific criteria, such as a particular status or operation type. +2. **Block Analysis**: Users can analyze transactions within a specific range of blocks to identify patterns or trends. + +## Request Parameters + +The `searchTransactions` method requires the following parameters in the request body: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, optional): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `operator` (enum, optional): Additional search conditions `or` and `and`. +- `max_block` (number, optional): The largest block index to consider when searching for transactions. If not populated, the current block is considered the `max_block`. If you do not specify a `max_block`, it is possible that a newly synced block will interfere with paginated transaction queries (as the offset could become invalid with newly added rows). +- `offset` (number, optional): 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. +- `limit` (number, optional): The maximum number of transactions to return in one call. The implementation may return \<= `limit` transactions. +- `transactionIdentifier` (object, required): An object containing information about the transaction. + - `hash` (string, required): The hash of the transaction. +- `accountIdentifier` (object, optional): An object containing information about the account. + - `address` (string, required): The Cardano account address associated with the operation. + - `sub_account` (object, optional): An optional sub-account object. + - `address` (string, optional): The sub-account address. + - `metadata` (object, optional): An optional metadata object for the sub-account. If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. + - `metadata` (object, optional): An optional metadata object for the account. +- `coinIdentifier` (object, optional): Specify search conditions for coin identifier. Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction\_hash: index. + - `identifier` (string, required): Example: '0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f: 1' +- `currency` (object, required): An object specifying the currency details. - `symbol` (string, required): The symbol or code of the currency. - `decimals` (number, required): The number of decimal places for the currency. - `metadata` (object, optional): Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token. +- `status` (string, optional): The network-specific operation status type (optional). +- `type` (string, optional): The network-specific operation type (optional). +- `address` (string, optional): AccountIdentifier.Address. This is used to get all transactions related to an AccountIdentifier.Address, regardless of SubAccountIdentifier. +- `success` (boolean, optional): A synthetic condition populated by parsing network-specific operation statuses. + +### Return Object + +The method returns a list of transactions that match the specified search criteria. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-submittransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-submittransaction.md new file mode 100644 index 00000000..bcf47b02 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-submittransaction.md @@ -0,0 +1,80 @@ +--- +title: "submitTransaction" +slug: "rpc-cardano-submittransaction" +category: "6620f7e31ea673003624a8cc" +excerpt: "Cardano RPC" +hidden: false +metadata: + description: "Cardano RPC" + image: [] + keywords: "cardano, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" +--- +[block:html] +{ + "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +} +[/block] + + +### How to use it + +```typescript +// Import required libraries and modules from Tatum SDK +import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Cardano +const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); + +// Define the input parameters in a single object +const submitRequest = { + networkIdentifier: { + blockchain: 'CARDANO', // Specify the blockchain identifier ('CARDANO' for Cardano). + network: 'NETWORK_NAME', // Specify the network name. + subNetworkIdentifier: { + network: 'SUB_NETWORK_NAME', // Specify the sub-network name (optional). + metadata: { + // Optional metadata. + }, + }, + }, + signedTransaction: 'SIGNED_TRANSACTION', // Specify the signed transaction to submit. +}; + +// Submit the signed transaction to the network +const transactionResponse = await tatum.rpc.submitTransaction(submitRequest); + +// Log the transaction response +console.log('Transaction Response:', transactionResponse); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `submitTransaction` method allows you to submit a signed transaction to the Cardano network for processing. After successfully constructing and signing a transaction, you can use this method to broadcast it to the network. + +### Example Use Cases + +1. **Transaction Submission**: Developers can use this method to submit a signed Cardano transaction to the network for execution. This is the final step in the transaction lifecycle. + +### Request Parameters + +The `submitTransaction` method requires the following parameters in the request body: + +- `networkIdentifier` (object, required): An object containing information about the blockchain network. + - `blockchain` (string, required): The blockchain identifier, which should be set to 'CARDANO' for Cardano. + - `network` (string, required): The network name for Cardano. + - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. + - `network` (string, required): The name of the sub-network within Cardano. + - `metadata` (object, optional): Metadata associated with the sub-network. +- `signedTransaction` (string, required): The signed transaction blob that you want to submit to the Cardano network. + +### Return Object + +The method returns an object representing the response from the Cardano network after submitting the signed transaction. This response may include details about the transaction's acceptance by the network. + +Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. From b0c252e4b62b3ff54dd8a6cb29637990a3d83667 Mon Sep 17 00:00:00 2001 From: "martin.zemanek" Date: Thu, 25 Apr 2024 08:22:10 +0200 Subject: [PATCH 2/2] Adding Cosmos RPC docs and updating new category for Rostrum and BCH + adding missing docs for ETH get balance --- .vscode/settings.json | 1 + .../rpc-ethereum-eth-getbalance.md | 90 ++++++ v1.0/RPC Nodes/rpc-others/.DS_Store | Bin 0 -> 6148 bytes .../rpc-cardano-getaccountbalance.md | 12 +- .../rpc-cardano-getaccountcoins.md | 50 ++-- .../rpc-cardano-getnetworkstatus.md | 4 +- .../rpc-cosmos-constructionmetadata.md | 133 +++++---- .../rpc-cosmos-constructionpayloads.md | 256 ++++++++---------- .../rpc-cosmos-constructionpreprocess.md | 230 +++++++--------- .../rpc-cosmos-createnetworktransaction.md | 193 ++++++------- .../rpc-cosmos/rpc-cosmos-deriveaccount.md | 132 ++++----- .../rpc-cosmos-getaccountbalance.md | 112 ++++---- .../rpc-cosmos/rpc-cosmos-getaccountcoins.md | 61 +++-- .../rpc-cosmos/rpc-cosmos-getblock.md | 156 +++++++---- .../rpc-cosmos-getblocktransaction.md | 159 ++++++----- .../rpc-cosmos-gethashoftransaction.md | 115 ++++---- .../rpc-cosmos/rpc-cosmos-getnetworklist.md | 85 +++--- .../rpc-cosmos/rpc-cosmos-getnetworkstatus.md | 151 +++++++---- .../rpc-cosmos/rpc-cosmos-parsetransaction.md | 133 +++++---- .../rpc-cosmos-searchtransactions.md | 207 +++++++------- .../rpc-cosmos-submittransaction.md | 109 ++++---- v1.0/RPC Nodes/rpc-others/rpc-kadena.md | 1 + .../rpc-kadena/rpc-kadena-checknodehealth.md | 2 +- ...-kadena-getbatchblockpayloadwithoutputs.md | 2 +- .../rpc-kadena-getbatchofblockpayload.md | 2 +- .../rpc-kadena/rpc-kadena-getblock.md | 8 +- .../rpc-kadena/rpc-kadena-getblockbranches.md | 8 +- .../rpc-kadena-getblockhashbranches.md | 8 +- .../rpc-kadena/rpc-kadena-getblockhashes.md | 8 +- .../rpc-kadena-getblockheaderbranches.md | 74 +++++ .../rpc-kadena-getblockheaderbyhash.md | 2 +- .../rpc-kadena/rpc-kadena-getblockheaders.md | 8 +- .../rpc-kadena-getblockpayloadwithoutputs.md | 2 +- .../rpc-kadena/rpc-kadena-getcurrentcut.md | 2 +- .../rpc-kadena/rpc-kadena-getinfo.md | 2 +- .../rpc-kadena/rpc-kadena-getpayloadbyhash.md | 2 +- .../rpc-tron/rpc-tron-getaccountbalance.md | 10 +- .../rpc-tron/rpc-tron-getblockbalance.md | 6 +- v1.0/RPC Nodes/rpc-utxo/rpc-bch.md | 1 + .../rostrum/blockchainAddressGetBalance.md | 2 +- .../rostrum/blockchainAddressGetHistory.md | 2 +- .../rostrum/blockchainAddressGetMempool.md | 2 +- .../rostrum/blockchainAddressListUnspent.md | 2 +- .../rpc-bch/rostrum/blockchainBlockGet.md | 2 +- .../rpc-bch/rostrum/blockchainBlockHeader.md | 2 +- .../rpc-bch/rostrum/blockchainBlockHeaders.md | 2 +- .../rpc-bch/rostrum/blockchainEstimateFee.md | 2 +- .../rostrum/blockchainHeadersSubscribe.md | 2 +- .../rpc-bch/rostrum/blockchainHeadersTip.md | 2 +- .../rpc-bch/rostrum/blockchainRelayFee.md | 2 +- .../rostrum/blockchainTransactionBroadcast.md | 2 +- .../rostrum/blockchainTransactionGet.md | 2 +- .../rpc-utxo/rpc-bch/rostrum/serverBanner.md | 2 +- .../rpc-utxo/rpc-bch/rostrum/serverVersion.md | 2 +- .../rpc-bch/rpc-bch-createrawtransaction.md | 1 + .../rpc-bch/rpc-bch-decoderawtransaction.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-decodescript.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-estimatefee.md | 1 + .../rpc-bch/rpc-bch-estimatesmartfee.md | 1 + .../rpc-bch/rpc-bch-getbestblockhash.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-getblock.md | 1 + .../rpc-bch/rpc-bch-getblockchaininfo.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-getblockcount.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-getblockhash.md | 1 + .../rpc-bch/rpc-bch-getblockheader.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-getblockstats.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-getchaintips.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-getdifficulty.md | 1 + .../rpc-bch/rpc-bch-getmempoolancestors.md | 1 + .../rpc-bch/rpc-bch-getmempooldescendants.md | 1 + .../rpc-bch/rpc-bch-getmempoolentry.md | 1 + .../rpc-bch/rpc-bch-getmempoolinfo.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-getrawmempool.md | 1 + .../rpc-bch/rpc-bch-getrawtransaction.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-gettxout.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-gettxoutproof.md | 1 + .../rpc-bch/rpc-bch-sendrawtransaction.md | 1 + .../rpc-bch/rpc-bch-validateaddress.md | 1 + .../rpc-utxo/rpc-bch/rpc-bch-verifymessage.md | 1 + .../rpc-bch/rpc-bch-verifytxoutproof.md | 1 + .../rpc-bch/{rostrum.md => rpc-rostrum.md} | 2 +- .../rpc-utxo/{bitcoin-1.md => rpc-btc.md} | 2 +- .../rpc-btc-getbestblockhash.md | 0 .../rpc-btc-getblock.md | 0 .../rpc-btc-getblockchaininfo.md | 0 .../rpc-btc-getblockcount.md | 0 .../rpc-btc-getblockhash.md | 0 .../rpc-btc-getblockheader.md | 0 .../rpc-btc-getblockstats.md | 0 .../rpc-btc-getchaintips.md | 0 .../rpc-btc-getdifficulty.md | 0 .../rpc-btc-getmempoolancestors.md | 0 .../rpc-btc-getmempooldescendants.md | 0 .../rpc-btc-getmempoolentry.md | 0 .../rpc-btc-getmempoolinfo.md | 0 .../rpc-btc-getrawmempool.md | 0 .../rpc-btc-gettxout.md | 0 .../rpc-btc-gettxoutproof.md | 0 .../rpc-btc-validateaddress.md | 0 .../rpc-btc-verifymessage.md | 0 .../rpc-btc-verifytxoutproof.md | 0 .../{rpc-degecoin.md => rpc-dogecoin.md} | 2 +- .../rpc-dogecoin-createrawtransaction.md | 0 .../rpc-dogecoin-decoderawtransaction.md | 0 .../rpc-dogecoin-decodescript.md | 0 .../rpc-dogecoin-estimatesmartfee.md | 0 .../rpc-dogecoin-getbestblockhash.md | 0 .../rpc-dogecoin-getblock.md | 0 .../rpc-dogecoin-getblockchaininfo.md | 0 .../rpc-dogecoin-getblockcount.md | 0 .../rpc-dogecoin-getblockhash.md | 0 .../rpc-dogecoin-getblockheader.md | 0 .../rpc-dogecoin-getchaintips.md | 0 .../rpc-dogecoin-getdifficulty.md | 0 .../rpc-dogecoin-getmempoolancestors.md | 0 .../rpc-dogecoin-getmempooldescendants.md | 0 .../rpc-dogecoin-getmempoolentry.md | 0 .../rpc-dogecoin-getmempoolinfo.md | 0 .../rpc-dogecoin-getrawmempool.md | 0 .../rpc-dogecoin-getrawtransaction.md | 0 .../rpc-dogecoin-gettxout.md | 0 .../rpc-dogecoin-gettxoutproof.md | 0 .../rpc-dogecoin-sendrawtransaction.md | 0 .../rpc-dogecoin-validateaddress.md | 0 .../rpc-dogecoin-verifymessage.md | 0 .../rpc-dogecoin-verifytxoutproof.md | 0 .../rpc-utxo/{zcash.md => rpc-zcash.md} | 2 +- .../rpc-zcash-createrawtransaction.md | 0 .../rpc-zcash-decoderawtransaction.md | 0 .../rpc-zcash-decodescript.md | 0 .../rpc-zcash-estimatesmartfee.md | 0 .../rpc-zcash-getbestblockhash.md | 0 .../rpc-zcash-getblock.md | 0 .../rpc-zcash-getblockchaininfo.md | 0 .../rpc-zcash-getblockcount.md | 0 .../rpc-zcash-getblockhash.md | 0 .../rpc-zcash-getblockheader.md | 0 .../rpc-zcash-getblockstats.md | 0 .../rpc-zcash-getchaintips.md | 0 .../rpc-zcash-getdifficulty.md | 0 .../rpc-zcash-getmempoolancestors.md | 0 .../rpc-zcash-getmempooldescendants.md | 0 .../rpc-zcash-getmempoolentry.md | 0 .../rpc-zcash-getmempoolinfo.md | 0 .../rpc-zcash-getrawmempool.md | 0 .../rpc-zcash-getrawtransaction.md | 0 .../rpc-zcash-gettxout.md | 0 .../rpc-zcash-gettxoutproof.md | 0 .../rpc-zcash-sendrawtransaction.md | 0 .../rpc-zcash-validateaddress.md | 0 .../rpc-zcash-verifymessage.md | 0 .../rpc-zcash-verifytxoutproof.md | 0 152 files changed, 1453 insertions(+), 1148 deletions(-) create mode 100644 .vscode/settings.json create mode 100644 v1.0/RPC Nodes/rpc-evm/rpc-ethereum/rpc-ethereum-eth-getbalance.md create mode 100644 v1.0/RPC Nodes/rpc-others/.DS_Store create mode 100644 v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaderbranches.md rename v1.0/RPC Nodes/rpc-utxo/rpc-bch/{rostrum.md => rpc-rostrum.md} (97%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1.md => rpc-btc.md} (99%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getbestblockhash.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getblock.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getblockchaininfo.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getblockcount.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getblockhash.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getblockheader.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getblockstats.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getchaintips.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getdifficulty.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getmempoolancestors.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getmempooldescendants.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getmempoolentry.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getmempoolinfo.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-getrawmempool.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-gettxout.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-gettxoutproof.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-validateaddress.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-verifymessage.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{bitcoin-1 => rpc-btc}/rpc-btc-verifytxoutproof.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin.md => rpc-dogecoin.md} (97%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-createrawtransaction.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-decoderawtransaction.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-decodescript.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-estimatesmartfee.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getbestblockhash.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getblock.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getblockchaininfo.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getblockcount.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getblockhash.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getblockheader.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getchaintips.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getdifficulty.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getmempoolancestors.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getmempooldescendants.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getmempoolentry.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getmempoolinfo.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getrawmempool.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-getrawtransaction.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-gettxout.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-gettxoutproof.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-sendrawtransaction.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-validateaddress.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-verifymessage.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{rpc-degecoin => rpc-dogecoin}/rpc-dogecoin-verifytxoutproof.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash.md => rpc-zcash.md} (95%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-createrawtransaction.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-decoderawtransaction.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-decodescript.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-estimatesmartfee.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getbestblockhash.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getblock.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getblockchaininfo.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getblockcount.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getblockhash.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getblockheader.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getblockstats.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getchaintips.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getdifficulty.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getmempoolancestors.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getmempooldescendants.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getmempoolentry.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getmempoolinfo.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getrawmempool.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-getrawtransaction.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-gettxout.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-gettxoutproof.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-sendrawtransaction.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-validateaddress.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-verifymessage.md (100%) rename v1.0/RPC Nodes/rpc-utxo/{zcash => rpc-zcash}/rpc-zcash-verifytxoutproof.md (100%) diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..0967ef42 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1 @@ +{} diff --git a/v1.0/RPC Nodes/rpc-evm/rpc-ethereum/rpc-ethereum-eth-getbalance.md b/v1.0/RPC Nodes/rpc-evm/rpc-ethereum/rpc-ethereum-eth-getbalance.md new file mode 100644 index 00000000..c9989dd9 --- /dev/null +++ b/v1.0/RPC Nodes/rpc-evm/rpc-ethereum/rpc-ethereum-eth-getbalance.md @@ -0,0 +1,90 @@ +# eth\_getBalance + +## How to use it + +{% tabs %} +{% tab title="TypeScript/JavaScript" %} +{% code overflow="wrap" lineNumbers="true" %} +```typescript +// yarn add @tatumio/tatum + +import { TatumSDK, Ethereum, Network } from '@tatumio/tatum' + +const tatum = await TatumSDK.init({network: Network.ETHEREUM}) + +const balance = await tatum.rpc.getBalance('0x742d35Cc6634C0532925a3b844Bc454e4438f44e') + +await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs +``` +{% endcode %} +{% endtab %} +{% endtabs %} + +## Overview + +The `eth_getBalance` method is an Ethereum JSON-RPC method that allows you to retrieve the Ether balance of a specified address. This method can be used to query the balance of any Ethereum address, whether it is a contract or an externally owned account (EOA). A common use case for this method is to display the current balance of a user's account in a wallet application or a decentralised application (DApp). + +{% embed url="https://codepen.io/tatum-devrel/pen/qBQgNWd" %} +Try this feature +{% endembed %} + +## Parameters + +The method requires two parameters: + +1. **`address`** (required): The address of the account or contract whose balance you want to query. + * Example: `"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"` +2. **`blockParameter`** (optional): The block number or block identifier to specify the point in time for which you want to query the balance. + * Example: `"latest"` or `"0x1"` + +### Transaction Details + +For the purpose of this documentation, we'll also describe the `transactions` field of a full transaction object. The `eth_getBalance` method does not return transaction details, but we provide this information for completeness. + +A full transaction object includes the following fields: + +* **`hash`**: The transaction hash. +* **`nonce`**: The number of transactions made by the sender prior to this one. +* **`blockHash`**: The hash of the block in which the transaction was included. +* **`blockNumber`**: The block number in which the transaction was included. +* **`transactionIndex`**: The index of the transaction in the block. +* **`from`**: The sender's address. +* **`to`**: The recipient's address (or `null` for contract creation transactions). +* **`value`**: The value transferred, in wei. +* **`gasPrice`**: The gas price provided by the sender, in wei. +* **`gas`**: The maximum gas allowed for the transaction. +* **`input`**: The data sent with the transaction (typically for contract interaction). +* **`v`**, **`r`**, **`s`**: The raw signature values of the transaction. + +## Return Object + +The method returns a single field: + +* `result`: The Ether balance of the specified address in wei, as a hexadecimal string. + * Example: `"0x1a2e1a"`, which corresponds to `1,726,666` wei. + +## JSON-RPC Request and Response Examples + +### Request + +```json +{ + "jsonrpc": "2.0", + "id": 1, + "method": "eth_getBalance", + "params": [ + "0x742d35Cc6634C0532925a3b844Bc454e4438f44e", + "latest" + ] +} +``` + +### Response + +```json +{ + "jsonrpc": "2.0", + "id": 1, + "result": "0x1a2e1a" +} +``` \ No newline at end of file diff --git a/v1.0/RPC Nodes/rpc-others/.DS_Store b/v1.0/RPC Nodes/rpc-others/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..3f57b42566b9598304f9f97ab5ed5a2c5880bb62 GIT binary patch literal 6148 zcmeHKIc~#13?vg3Lfp7?xgSW8A1n;{1^Pe$8*r1@fr7YJ<#*+286GffNGVdJF@^v+ zyIjr+nnDysMAu)t7m=liv~WW?TbP=in@{W^GYW*`j;$Q!Q{FvJ%4ZYCeUd>wz!BizR?HaSTKTra=V;RddA9pd(+ht|pFwK^M*8L-Wa+6N>uNaewi0(Hh7| z1*pKS0*|p>TL0g`f0_SpN!(EZDsWc{Xw&uG8n2YSb@Fo7YYY4pZZ+RBu`B$e#hzg+>MbTY(>3eHDxV literal 0 HcmV?d00001 diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getaccountbalance.md b/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getaccountbalance.md index ea463586..16af2331 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getaccountbalance.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getaccountbalance.md @@ -80,18 +80,18 @@ The `getAccountBalance` method requires the following parameters: - `networkIdentifier` (object, required): An object containing information about the blockchain network. - `blockchain` (string, required): The blockchain identifier, which should be set to `'CARDANO'` for Cardano. - `network` (string, required): The network name for Cardano. -- `accountIdentifier` (object, optional): An object containing information about the account. +- `accountIdentifier` (object, required): An object containing information about the account. - `address` (string, required): The Cardano account address associated with the operation. - `sub_account` (object, optional): An optional sub-account object. - - `address` (string, optional): The sub-account address. + - `address` (string, required): The sub-account address. - `metadata` (object, optional): An optional metadata object for the sub-account. If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. - `metadata` (object, optional): An optional metadata object for the account. Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata. - `blockIdentifier` (object, optional): An object containing information about the block. - - `index` (number, optional): The index of the block (Type: number, Format: int64). - - `hash` (string, optional): The hash of the block. -- `currency` (object, required): An object specifying the currency details. + - `index` (number, required): The index of the block (Type: number, Format: int64). + - `hash` (string, required): The hash of the block. +- `currency` (object, optional): An object specifying the currency details. - `symbol` (string, required): The symbol or code of the currency. - - `decimals` (number, required): The number of decimal places for the currency. + - `decimals` (number, optional): The number of decimal places for the currency. - `metadata` (object, optional): Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token. ### Return Object diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getaccountcoins.md b/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getaccountcoins.md index f9442481..4a39b99d 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getaccountcoins.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getaccountcoins.md @@ -3,7 +3,7 @@ title: "getAccountCoins" slug: "rpc-cardano-getaccountcoins" excerpt: "Cardano RPC" hidden: false -metadata: +metadata: description: "Cardano RPC" image: [] keywords: "cardano, rpc" @@ -11,52 +11,54 @@ metadata: createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:06 GMT+0000 (Coordinated Universal Time)" --- + [block:html] { - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" +"html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" } [/block] - ### How to use it ```typescript // Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; +import { TatumSDK, CardanoRosetta, Network } from "@tatumio/tatum"; // Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +const tatum = await TatumSDK.init({ + network: Network.CARDANO_ROSETTA, +}); // Define the input parameter in a single object const params = { - networkIdentifier: { - blockchain: 'CARDANO', // string, required - network: 'NETWORK_NAME', // string, required + networkIdentifier: { + blockchain: "CARDANO", // string, required + network: "NETWORK_NAME", // string, required + }, + accountIdentifier: { + address: "ACCOUNT_ADDRESS", // string, required + sub_account: { + // Specify sub-account information if applicable }, - accountIdentifier: { - address: 'ACCOUNT_ADDRESS', // string, required - sub_account: { - // Specify sub-account information if applicable - }, - metadata: { - chain_code: 'CHAIN_CODE', // Specify chain code if applicable - }, + metadata: { + chain_code: "CHAIN_CODE", // Specify chain code if applicable }, - includeMempool: true, // boolean, optional - currency: { - symbol: 'ADA', // string, required - decimals: 6, // number, required - metadata: { - // Specify metadata only if applicable - }, + }, + includeMempool: true, // boolean, optional + currency: { + symbol: "ADA", // string, required + decimals: 6, // number, required + metadata: { + // Specify metadata only if applicable }, + }, }; // Retrieve unspent coins for an account in Cardano blockchain const unspentCoins = await tatum.rpc.getAccountCoins(params); // Log the unspent coins -console.log('Unspent Coins:', unspentCoins); +console.log("Unspent Coins:", unspentCoins); // Always destroy the Tatum SDK instance when done to stop any background processes await tatum.destroy(); diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getnetworkstatus.md b/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getnetworkstatus.md index e07e5cef..dbe40099 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getnetworkstatus.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cardano/rpc-cardano-getnetworkstatus.md @@ -29,10 +29,10 @@ const tatum = await TatumSDK.init({ network: Network.CARDANO_ROS // Define the input parameters in a single object const params = { - network_identifier: { + networkIdentifier: { blockchain: 'CARDANO', // string, required network: 'NETWORK_NAME', // string, required - sub_network_identifier: { + sub_networkIdentifier: { network: 'SUB_NETWORK_NAME', // string (optional) metadata: { [key: string]: any, // object (optional) diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionmetadata.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionmetadata.md index e3f462cf..2242f9fe 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionmetadata.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionmetadata.md @@ -1,90 +1,89 @@ --- title: "constructionMetadata" -slug: "rpc-cardano-constructionmetadata" -excerpt: "Cardano RPC" +slug: "rpc-cosmos-constructionmetadata" +category: "6620f7e31ea673003624a8cc" +excerpt: "Rosetta API for Cosmos" hidden: false -metadata: - description: "Cardano RPC" +metadata: image: [] - keywords: "cardano, rpc" + keywords: "cosmos, construction metadata, Rosetta API" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 12:59:40 GMT+0000 (Coordinated Universal Time)" --- -[block:html] -{ - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" -} -[/block] +## Overview -### How to use it +The `constructionMetadata` method retrieves metadata necessary to construct transactions for a specific network using the Rosetta API. This is particularly useful in environments where transactions need to be constructed offline or in secure environments. -```typescript -// Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; +## Parameters -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The name of the blockchain, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place (e.g., "mainnet" or "testnet"). | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `options` | object | No | Optional parameters for specifying the metadata required for different types of transactions. Can include various flags and values depending on the transaction type. | +| `publicKeys` | array | No | List of public keys involved in the transaction. Each object in the array contains `hexBytes` and `curveType`. | +| `hexBytes` | string (from publicKey) | Yes | Hexadecimal representation of the public key. | +| `curveType` | string (from publicKey) | Yes | Cryptographic curve associated with the public key (e.g., "secp256k1"). | -// Define the input parameters in a single object -const params = { - networkIdentifier: { - blockchain: 'CARDANO', // string, required - network: 'NETWORK_NAME', // string, required - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', // string (optional) - metadata: { - [key: string]: any, // object (optional) - }, - }, - }, - options: { - // Optional object - }, - publicKeys: [ - { - hexBytes: 'PUBLIC_KEY_HEX_BYTES', // Required: Specifies the hexadecimal representation of the staking credential . - curveType: 'SECP256K1', // Required: Specifies the curve type for the staking credential .] - }, - ] -}; +## Returns -// Retrieve metadata for transaction construction on the Cardano network -const metadata = await tatum.rpc.constructionMetadata(params); +| Field | Type | Description | +| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------- | +| `metadata` | object | Contains necessary metadata for transaction construction including signers, sequence number, and recent block hash. | -// Log the metadata -console.log('Cardano Transaction Construction Metadata:', metadata); +## Example Result -// Always destroy the Tatum SDK instance when done to stop any background processes -await tatum.destroy(); +```json +{ + "metadata": { + "requiredSigners": [ + { + "publicKey": "03fa...", + "signatureType": "ecdsa_recovery" + } + ], + "sequence": 45, + "recentBlockHash": "abcd1234..." + } +} ``` -### Overview - -The `constructionMetadata` method allows you to retrieve metadata required to construct a transaction for a specific network. - -### Example Use Cases - -1. **Metadata Retrieval**: Developers can use this method along with the `constructionPreprocess` endpoint to retrieve metadata required for transaction construction in an offline environment. - -### Request Parameters +## Request Example + +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos/' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "networkIdentifier": { + "blockchain": "cosmos", + "network": "mainnet" + } +}' +``` +```typescript +// yarn add @tatumio/tatum -The `constructionMetadata` method requires the following parameters: +import { TatumSDK, CosmosRosetta, Network } from "@tatumio/tatum"; -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `options` (object, optional): Some blockchains require different metadata for different types of transaction construction (ex: delegation versus a transfer). Instead of requiring a blockchain node to return all possible types of metadata for construction (which may require multiple node fetches), the client can populate an options object to limit the metadata returned to only the subset required. -- `publicKey` (object, required): 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. - - `hexBytes` (string, required): The hexadecimal representation of the public key. - - `curveType` (string, enum, required): The type of cryptographic curve associated with the public key (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). +const cosmos = await TatumSDK.init({ + network: Network.COSMOS_ROSETTA, +}); -### Return Object +const constructionMetadata = await tatum.rpc.constructionMetadata({ + networkIdentifier: { + blockchain: "cosmos", + network: "mainnet", + }, +}); -The method returns an object representing the metadata required to construct a transaction for a specific network. +console.log(constructionMetadata); -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. +await tatum.destroy(); // Destroy Tatum SDK - needed for stopping background jobs +``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpayloads.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpayloads.md index bf5c7977..f2bd50a3 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpayloads.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpayloads.md @@ -1,168 +1,138 @@ --- title: "constructionPayloads" -slug: "rpc-cardano-constructionpayloads" +slug: "rpc-cosmos-constructionpayloads" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Rosetta API for Cosmos" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "Cosmos RPC" image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" --- -[block:html] + +## Overview + +The `constructionPayloads` contains the network, a slice of operations, and arbitrary metadata that was returned by the call to `constructionMetadata`. Optionally, the request can also include an array of publicKeys associated with the AccountIdentifiers returned in `constructionPreprocess` response. + +## Parameters + +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The name of the blockchain, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `operations` | array | Yes | An array of operation objects, each representing a transaction component. | +| `operationIdentifier` | object (from operations) | Yes | Identifier for the operation. Includes `index` and optionally `network_index`. | +| `index` | number (from operationIdentifier) | Yes | The index of the operation within the transaction. | +| `network_index` | number (from operationIdentifier) | No | Network-specific index of the operation. | +| `relatedOperations` | array (from operations) | No | Operations related to the current operation. | +| `index` | number (from relatedOperations) | Yes | Index of related operations. | +| `network_index` | number (from relatedOperations) | No | Network-specific index of related operations. | +| `type` | string (from operations) | Yes | The type of operation, e.g., "TRANSFER". | +| `status` | string (from operations) | No | The status of the operation. | +| `account` | object (from operations) | No | The account involved in the operation. Includes `address`, and optionally `subAccount` and `metadata`. | +| `address` | string (from account) | Yes | The Cosmos account address associated with the operation. | +| `subAccount` | object (from account) | No | An optional sub-account object. | +| `metadata` | object (from account) | No | Metadata for the account. | +| `address` | string (from subAccount) | Yes | The sub-account address. | +| `metadata` | object (from subAccount) | No | An optional metadata object for the sub-account. | +| `amount` | object (from operations) | No | The monetary amount involved in the operation. Includes `value`, `currency`, and optionally `metadata`. | +| `value` | string (from amount) | Yes | The value of the transaction amount. | +| `currency` | object (from amount) | Yes | An object specifying the currency details. Includes `symbol`, `decimals`, and optionally `metadata`. | +| `metadata` | object (from amount) | No | Metadata object for the amount. | +| `symbol` | string (from currency) | Yes | The symbol or code of the currency. | +| `decimals` | number (from currency) | Yes | The number of decimal places for the currency. | +| `metadata` | object (from currency) | No | Any additional information related to the currency itself, such as contract addresses. | +| `coin_change` | object (from operations) | No | Information about changes to the coin state (e.g., created or spent). | +| `coinIdentifier` | object (from coin_change) | Yes | An object containing a coin identifier. | +| `identifier` | string (from coinIdentifier) | Yes | Identifier should be populated with a globally unique identifier of a Coin. | +| `coin_action` | string (from coin_change) | Yes | CoinActions are different state changes that a Coin can undergo. | +| `publicKeys` | array | No | List of public keys involved in authorizing the transaction. | +| `hexBytes` | string (from publicKeys) | Yes | Hexadecimal representation of the public key. | +| `curveType` | string (from publicKeys) | Yes | The cryptographic curve type of the public key, e.g., "secp256k1". | +| `metadata` | object (from operations) | No | Additional information about the operation. | +| `metadata` | object | No | Optional metadata for transaction construction. | + +## Returns + +| Field | Type | Description | +| ---------------------- | ------ | ------------------------------------------------------------------- | +| `unsigned_transaction` | string | A hexadecimal string representing the unsigned transaction data. | +| `payloads` | array | An array of objects containing the information that must be signed. | + +## Example Result + +```json { - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" + "unsigned_transaction": "0x...", + "payloads": [ + { + "address": "cosmos1...", + "hex_bytes": "f2ca1bb6c7...", + "signature_type": "ecdsa_recovery" + } + ] } -[/block] - +``` -### How to use it +## Request Example +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos/' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "networkIdentifier": { + "blockchain": "cosmos", + "network": "mainnet" + }, + "operations": [ + { + "operationIdentifier": { + "index": 1 + }, + "type": "TRANSFER", + } + ] +}' +``` ```typescript -// Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; +// yarn add @tatumio/tatum + +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +const cosmos = await TatumSDK.init({ network: Network.COSMOS_MAINNET }); -// Define the input parameters in a single object const params = { - networkIdentifier: { - blockchain: 'CARDANO', // Required: Specifies the blockchain . - network: 'MAINNET', // Required: Specifies the network name . - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', // Optional: Specifies the sub-network name . - metadata: { - KEY: 'VALUE', // Optional: Specify metadata . - }, + networkIdentifier: { + blockchain: "cosmos", + network: "mainnet", + }, + operations: [ + { + operationIdentifier: { + index: 1, }, + type: "TRANSFER", }, - operations: [ - { - operation_identifier: { - index: 1, // Required: Specifies the operation index (number). - network_index: 0, // Optional: Specifies the network index (number). - }, - related_operations: [ - { - index: 2, // Optional: Specifies the related operation index (number). - network_index: 1, // Optional: Specifies the related network index (number). - }, - ], - type: 'OPERATION_TYPE', // Required: Specifies the operation type. - status: 'OPERATION_STATUS', // Optional: Specifies the operation status . - account: { - address: 'ACCOUNT_ADDRESS', // Required: Specifies the account address . - sub_account: { - address: 'SUB_ACCOUNT_ADDRESS', // Optional: Specifies the sub-account address . - metadata: { - // Optional metadata object for the sub-account - }, - }, - metadata: { - // Optional metadata object for the account - }, - }, - amount: { - value: 'AMOUNT_VALUE', // Required: Specifies the amount value (string). - currency: { - symbol: 'CURRENCY_SYMBOL', // Required: Specifies the currency symbol . - decimals: 6, // Required: Specifies the currency decimals (number). - metadata: { - // Optional metadata for amount object - }, - }, - metadata: { - // Optional: Specify metadata here only if applicable. - }, - }, - coin_change: { - coin_identifier: { - identifier: 'COIN_IDENTIFIER', // Required: uniquely identifies a Coin. - }, - coin_action: 'coin_created', // Required - }, - metadata: { - // Optional: Specify operations metadata only if applicable. - } - }, - ], - metadata: { - // Optional metadata for constructionPayloads + ], + publicKeys: [ + { + hexBytes: "abc123...", + curveType: "secp256k1", }, - publicKeys: [ - { - hexBytes: 'PUBLIC_KEY_HEX_BYTES', // Required: Specifies the hexadecimal representation of the staking credential . - curveType: 'SECP256K1', // Required: Specifies the curve type for the staking credential .] - }, - ] + ], }; -// Generate an unsigned transaction and signing payloads -const constructionPayloads = await tatum.constructionPayloads(params); +const constructionPayloads = await tatum.rpc.constructionPayloads(params); -// Log the construction payloads -console.log('Construction Payloads:', constructionPayloads); +console.log("Construction Payloads:", constructionPayloads); -// Always destroy the Tatum SDK instance when done to stop any background processes -await tatum.destroy(); +await tatum.destroy(); // Destroy Tatum SDK - needed for stopping background jobs ``` - -### Overview - -The `constructionPayloads` contains the network, a slice of operations, and arbitrary metadata that was returned by the call to `constructionMetadata`. Optionally, the request can also include an array of publicKeys associated with the AccountIdentifiers returned in `constructionPreprocess` response. - -### Example Use Cases - -1. **Transaction Construction**: Developers can use this method to construct an unsigned transaction that specifies the intent of the transaction but not all possible effects. The generated payloads can be signed by the specified account identifiers to complete the transaction. - -### Request Parameters - -The `constructionPayloads` method requires the following parameters: - -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `operations` (array of objects, required): An array of operation objects, where each object represents a transaction to be included in the Cardano transaction. - - `operation_identifier` (object, required): An object containing an index that uniquely identifies the operation. - - `index` (number, required): The index of the operation. - - `network_index` (number, optional): The network-specific index of the operation. - - `related_operations` (array of objects, optional): An array of related operation identifiers if applicable. - - `index` (number, optional): The index of the related operation. - - `network_index` (number, optional): The network-specific index of the related operation. - - `type` (string, required): The type of the operation (e.g., "TRANSFER"). - - `status` (string, optional): The status of the operation (e.g., "SUCCESS"). - - `account` (object, required): An object containing information about the account. - - `address` (string, required): The Cardano account address associated with the operation. - - `sub_account` (object, optional): An optional sub-account object. - - `address` (string, optional): The sub-account address. - - `metadata` (object, optional): An optional metadata object for the sub-account. If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. - - `metadata` (object, optional): An optional metadata object for the account. Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata. - - `amount` (object, required): An object containing information about the transaction amount. - - `value` (string, required): The value of the transaction amount. - - `currency` (object, required): An object specifying the currency details. - - `symbol` (string, required): The symbol or code of the currency. - - `decimals` (number, required): The number of decimal places for the currency. - - `metadata` (object, optional): Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token. - - `metadata` (object, optional): metadata object for the amount. - - `coin_change` (object, required): An object containing information about coin changes in the operation. - - `coin_identifier` (object, required): An object containing a coin identifier. - - `identifier` (string, required): Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction_hash:index.. - - `coin_action` (string, required): 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. (e.g., 'coin_created' | 'coin_spent'). - - `metadata` (object, optional): An optional metadata object for the operation, including withdrawal, deposit, refund, staking credential, pool key hash, epoch, token bundle, pool registration certificate, pool registration parameters, and vote registration metadata details. -- `metadata` (object, optional): Specify the metadata for transaction construction. -- `publicKey` (object, required): 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. - - `hexBytes` (string, required): The hexadecimal representation of the public key. - - `curveType` (string, enum, required): The type of cryptographic curve associated with the public key (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). - -### Return Object - -The `constructionPayloads` method returns an object representing the unsigned transaction blob and a collection of payloads that must be signed by particular AccountIdentifiers using a certain SignatureType. - -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpreprocess.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpreprocess.md index 9284d78a..513e5f54 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpreprocess.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-constructionpreprocess.md @@ -1,160 +1,130 @@ --- title: "constructionPreprocess" -slug: "rpc-cardano-constructionpreprocess" +slug: "rpc-cosmos-constructionpreprocess" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "Cosmos RPC" image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" --- -[block:html] + +## Overview + +The `constructionPreprocess` method is called prior to `constructionPayloads` to construct a request for any metadata that is needed for transaction construction. This method is used to fetch information such as account nonce. The `options` object returned from this method will be sent to the `constructionMetadata` endpoint **UNMODIFIED** by the caller in an offline execution environment. If your Construction API implementation has configuration options, they MUST be specified in the `constructionPreprocess` request in the `metadata` field. + +## Parameters + +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | ------------------------------------------------------------ | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, set to `COSMOS` for Cosmos. | +| `network` | string (from networkIdentifier) | Yes | The network name for Cosmos. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `operations` | array | Yes | Describes the operations associated with the transaction. | +| `operation_identifier` | object (from operations) | Yes | Identifier for each operation. | +| `index` | number (from operation_identifier) | Yes | The index of the operation within the transaction. | +| `network_index` | number (from operation_identifier) | No | Network-specific index of the operation. | +| `related_operations` | array (from operations) | No | Operations related to the current operation. | +| `index` | number (from related_operations) | Yes | Index of related operations. | +| `network_index` | number (from related_operations) | No | Network-specific index of related operations. | +| `type` | string (from operations) | Yes | Type of operation (e.g., "TRANSFER"). | +| `status` | string (from operations) | No | Status of the operation (e.g., "SUCCESS"). | +| `account` | object (from operations) | No | Account details involved in the operation. | +| `address` | string (from account) | Yes | Cosmos account address associated with the operation. | +| `sub_account` | object (from account) | No | Details of a sub-account, if applicable. | +| `metadata` | object (from account) | No | Metadata for the account. | +| `address` | string (from sub_account) | Yes | Address of the sub-account. | +| `metadata` | object (from sub_account) | No | Metadata for the sub-account. | +| `amount` | object (from operations) | No | Details of the amount involved in the operation. | +| `value` | string (from amount) | Yes | Transaction amount. | +| `currency` | object (from amount) | Yes | Currency details of the transaction. | +| `metadata` | object (from amount) | No | Additional currency-related metadata. | +| `symbol` | string (from currency) | Yes | Symbol of the currency used. | +| `decimals` | number (from currency) | Yes | Decimal places of the currency. | +| `metadata` | object (from currency) | No | Additional currency-related metadata. | +| `coin_change` | object (from operations) | No | Information about changes to coin states. | +| `coin_identifier` | object (from coin_change) | Yes | Identifier for the coin involved in the change. | +| `identifier` | string (from coin_identifier) | Yes | Globally unique identifier of a Coin. | +| `coin_action` | string (from coin_change) | Yes | Type of action performed on the coin (e.g., 'coin_created'). | +| `metadata` | object (from operations) | No | Additional metadata for operations construction. | +| `metadata` | object | No | Additional metadata for transaction construction. | + +## Returns + +| Field | Type | Description | +| --------- | ------ | ---------------------------------------------- | +| `options` | object | Object containing options for the transaction. | + +## Example Result + +```json { - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" + "options": { + "fee": "10000", + "nonce": "3" + } } -[/block] - +``` -### How to use it +## Request Example +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/construction/preprocess' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "networkIdentifier": { + "blockchain": "cosmos", + "network": "mainnet" + }, + "operations": [ + { + "operation_identifier": { + "index": 1 + }, + "type": "TRANSFER", + } + ] +}' +``` ```typescript // Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; +import { TatumSDK, CosmosRosetta, Network } from "@tatumio/tatum"; -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +// Initialize the Tatum SDK for Cosmos +const tatum = await TatumSDK.init({ + network: Network.COSMOS_MAINNET, +}); -// Define the input parameters in a single object +// Define the input parameters with only required fields const params = { - networkIdentifier: { - blockchain: 'CARDANO', // Required: Specifies the blockchain . - network: 'MAINNET', // Required: Specifies the network name . - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', // Optional: Specifies the sub-network name . - metadata: { - KEY: 'VALUE', // Optional: Specify metadata . - }, + networkIdentifier: { + blockchain: "cosmos", // Specifies the blockchain + network: "mainnet", // Specifies the network name + }, + operations: [ + { + operation_identifier: { + index: 1, // Specifies the operation index (number) }, + type: "TRANSFER", // Specifies the operation type }, - operations: [ - { - operation_identifier: { - index: 1, // Required: Specifies the operation index (number). - network_index: 0, // Optional: Specifies the network index (number). - }, - related_operations: [ - { - index: 2, // Optional: Specifies the related operation index (number). - network_index: 1, // Optional: Specifies the related network index (number). - }, - ], - type: 'OPERATION_TYPE', // Required: Specifies the operation type. - status: 'OPERATION_STATUS', // Optional: Specifies the operation status . - account: { - address: 'ACCOUNT_ADDRESS', // Required: Specifies the account address . - sub_account: { - address: 'SUB_ACCOUNT_ADDRESS', // Optional: Specifies the sub-account address . - metadata: { - // Optional metadata object for the sub-account - }, - }, - metadata: { - // Optional metadata object for the account - }, - }, - amount: { - value: 'AMOUNT_VALUE', // Required: Specifies the amount value (string). - currency: { - symbol: 'CURRENCY_SYMBOL', // Required: Specifies the currency symbol . - decimals: 6, // Required: Specifies the currency decimals (number). - metadata: { - // Optional metadata for amount object - }, - }, - metadata: { - // Optional: Specify metadata here only if applicable. - }, - }, - coin_change: { - coin_identifier: { - identifier: 'COIN_IDENTIFIER', // Required: uniquely identifies a Coin. - }, - coin_action: 'coin_created', // Required - }, - metadata: { - // Optional: Specify operations metadata only if applicable. - } - }, - ], - metadata: { - //Optional: Specify constructionPreprocess metadata only if applicable. - } + ], }; // Create a request to fetch metadata for transaction construction const preprocessRequest = await tatum.rpc.constructionPreprocess(params); // Log the preprocess request -console.log('Construction Preprocess Request:', preprocessRequest); +console.log("Construction Preprocess Request:", preprocessRequest); // Always destroy the Tatum SDK instance when done to stop any background processes await tatum.destroy(); ``` - -### Overview - -The `constructionPreprocess` method is called prior to `constructionPayloads` to construct a request for any metadata that is needed for transaction construction. This method is used to fetch information such as account nonce. The `options` object returned from this method will be sent to the `constructionMetadata` endpoint **UNMODIFIED** by the caller in an offline execution environment. If your Construction API implementation has configuration options, they MUST be specified in the `constructionPreprocess` request in the `metadata` field. - -### Example Use Cases - -1. **Transaction Construction**: Developers can use this method to fetch metadata required for transaction construction, such as the account nonce. -2. **Validation**: Validators can use this method to validate transaction data before the actual transaction construction. - -### Request Parameters - -The `constructionPreprocess` method requires the following parameters: - -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `operations` (array of objects, required): An array of operation objects, where each object represents a transaction to be included in the Cardano transaction. - - `operation_identifier` (object, required): An object containing an index that uniquely identifies the operation. - - `index` (number, required): The index of the operation. - - `network_index` (number, optional): The network-specific index of the operation. - - `related_operations` (array of objects, optional): An array of related operation identifiers if applicable. - - `index` (number, optional): The index of the related operation. - - `network_index` (number, optional): The network-specific index of the related operation. - - `type` (string, required): The type of the operation (e.g., "TRANSFER"). - - `status` (string, optional): The status of the operation (e.g., "SUCCESS"). - - `account` (object, required): An object containing information about the account. - - `address` (string, required): The Cardano account address associated with the operation. - - `sub_account` (object, optional): An optional sub-account object. - - `address` (string, optional): The sub-account address. - - `metadata` (object, optional): An optional metadata object for the sub-account. If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. - - `metadata` (object, optional): An optional metadata object for the account. Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata. - - `amount` (object, required): An object containing information about the transaction amount. - - `value` (string, required): The value of the transaction amount. - - `currency` (object, required): An object specifying the currency details. - - `symbol` (string, required): The symbol or code of the currency. - - `decimals` (number, required): The number of decimal places for the currency. - - `metadata` (object, optional): Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token. - - `metadata` (object, optional): metadata object for the amount. - - `coin_change` (object, required): An object containing information about coin changes in the operation. - - `coin_identifier` (object, required): An object containing a coin identifier. - - `identifier` (string, required): Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction_hash:index.. - - `coin_action` (string, required): 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. (e.g., 'coin_created' | 'coin_spent'). - - `metadata` (object, optional): An optional metadata object for the operation, including withdrawal, deposit, refund, staking credential, pool key hash, epoch, token bundle, pool registration certificate, pool registration parameters, and vote registration metadata details. -- `metadata` (object, optional): Metadata for `constructionPreprocess` - -### Return Object - -The method returns an object representing the preprocess request for transaction construction. This object includes the metadata required for constructing the transaction. The `options` object in this request will be sent to the `constructionMetadata` endpoint **UNMODIFIED** by the caller in an offline execution environment. - -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-createnetworktransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-createnetworktransaction.md index e30258bb..99901f28 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-createnetworktransaction.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-createnetworktransaction.md @@ -1,125 +1,128 @@ --- title: "createNetworkTransaction" -slug: "rpc-cardano-createnetworktransaction" +slug: "rpc-cosmos-createnetworktransaction" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "Cosmos RPC" image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" --- -[block:html] + +## Overview + +The `createNetworkTransaction` method allows you to create 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 `submitTransaction` endpoint by the caller. + +## Parameters + +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | ---------------------------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `unsignedTransaction` | string | Yes | Contains the unsigned transaction blob. | +| `signatures` | array | Yes | An array of signature objects. | +| `signing_payload` | object (from signatures) | Yes | The payload that was signed. | +| `address` | string (from signing_payload) | No | [DEPRECATED] Network-specific address of the account that should sign the payload. | +| `accountIdentifier` | object (from signing_payload) | No | Contains information about the account. | +| `address` | string (from accountIdentifier) | Yes | The Cosmos account address associated with the operation. | +| `sub_account` | object (from accountIdentifier) | No | Optional sub-account object. | +| `address` | string (from sub_account) | Yes | The sub-account address. | +| `metadata` | object (from sub_account) | No | Metadata for the sub-account. | +| `metadata` | object (from accountIdentifier) | No | Metadata for the account. | +| `hex_bytes` | string (from signing_payload) | Yes | Hex-encoded string of the payload bytes. | +| `signatureType` | string (from signing_payload) | No | Signature type (e.g., "ecdsa", "ed25519"). | +| `publicKey` | object (from signatures) | Yes | Contains the public key. | +| `hexBytes` | string (from publicKey) | Yes | Hexadecimal representation of the public key. | +| `curveType` | string (from publicKey) | Yes | The cryptographic curve type of the public key (e.g., "secp256k1"). | +| `signatureType` | string (from signatures) | Yes | The type of signature (e.g., "ecdsa", "ed25519"). | +| `hexBytes` | string (from signatures) | Yes | Hex-encoded signature. | + +## Returns + +| Field | Type | Description | +| ------------------- | ------ | --------------------------------------------------------------------------- | +| `signedTransaction` | string | A string that represents the fully signed transaction ready for submission. | + +## Example Result + +```json { - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" + "signedTransaction": "0x..." } -[/block] - +``` -### How to use it +## Request Example +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/construction/combine' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "networkIdentifier": { + "blockchain": "cosmos", + "network": "mainnet" + }, + "unsignedTransaction": "YOUR_UNSIGNED_TRANSACTION", + "signatures": [ + { + "signing_payload": { + "hex_bytes": "HEX_ENCODED_PAYLOAD_BYTES" + }, + "publicKey": { + "hexBytes": "PUBLIC_KEY_HEX", + "curveType": "secp256k1" + }, + "signatureType": "ecdsa", + "hexBytes": "SIGNATURE_HEX" + } + ] +}' +``` ```typescript // Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +// Initialize the Tatum SDK for Cosmos +const cosmos = await TatumSDK.init({ network: Network.COSMOS_MAINNET }); -// Define the input parameters in a single object +// Define the input parameters with only required fields const params = { - networkIdentifier: { - blockchain: 'CARDANO', // Specify the blockchain identifier ('CARDANO' for Cardano). - network: 'NETWORK_NAME', // Specify the network name. - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', // Specify the sub-network name (optional). - metadata: { - // Optional metadata key-value pairs. - }, - }, - }, - unsignedTransaction: 'UNSIGNED_TRANSACTION', // Specify the unsigned transaction blob. - signatures: [ + networkIdentifier: { + blockchain: "cosmos", + network: "mainnet", + }, + unsignedTransaction: "YOUR_UNSIGNED_TRANSACTION", + signatures: [ + { + signing_payload: { + hexBytes: "PAYLOAD_HEX", // Hex-encoded payload bytes. + }, + publicKeys: [ { - signing_payload: { - address: 'ADDRESS', // [DEPRECATED] Network-specific address (optional). - accountIdentifier: { - address: 'ADDRESS', // Account address. - subAccount: { - address: 'ADDRESS', // Sub-account address (optional). - metadata: { - // Sub-account metadata (optional). - }, - }, - metadata: { - // Account metadata (optional). - }, - }, - hexBytes: 'PAYLOAD_HEX', // Hex-encoded payload bytes. - signatureType: 'ecdsa', // Signature type (ecdsa, ecdsa_recovery, ed25519, schnorr_1, schnorr_bip340, schnorr_poseidon). - }, - publicKeys: [ - { - hexBytes: 'PUBLIC_KEY_HEX', // Hexadecimal representation of the public key. - curveType: 'secp256k1', // Curve type (secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). - }, - ], - signatureType: 'ecdsa', // Signature type (ecdsa, ecdsa_recovery, ed25519, schnorr_1, schnorr_bip340, schnorr_poseidon). - hexBytes: 'SIGNATURE_HEX', // Hex-encoded signature. + hexBytes: "PUBLIC_KEY_HEX", // Hexadecimal representation of the public key. + curveType: "secp256k1", // Curve type (secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). }, - ], + ], + signatureType: "ecdsa", // Signature type (ecdsa, ecdsa_recovery, ed25519, schnorr_1, schnorr_bip340, schnorr_poseidon). + hexBytes: "SIGNATURE_HEX", // Hex-encoded signature. + }, + ], }; // Create network transaction from signatures const networkTransaction = await tatum.rpc.createNetworkTransaction(params); // Log the network transaction -console.log('Network Transaction:', networkTransaction); +console.log("Network Transaction:", networkTransaction); // Always destroy the Tatum SDK instance when done to stop any background processes await tatum.destroy(); ``` - -### Overview - -The `createNetworkTransaction` method allows you to create 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. - -### Example Use Cases - -1. **Transaction Construction**: Developers can use this method to combine an unsigned Cardano transaction with the corresponding signatures, resulting in a fully signed network transaction ready to be submitted to the Cardano network. - -### Request Parameters - -The `createNetworkTransaction` method requires the following parameters in the request body: - -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `unsignedTransaction` (string, required): Contains the unsigned transaction blob returned by the `constructionPayloads` endpoint. The unsigned transaction represents the basic structure and details of the transaction before it is signed. -- `signatures` (array of objects, required): This parameter is an array of signatures. Each signature is represented by a Signature object. Signatures are required to create a network transaction by combining them with the unsigned transaction. - - `signing_payload` (object, required): The payload that was signed. - - `address` (string, optional): [DEPRECATED] The network-specific address of the account that should sign the payload. - - `accountIdentifier` (object, optional): An object containing information about the account. - - `address` (string, required): The Cardano account address associated with the operation. - - `sub_account` (object, optional): An optional sub-account object. - - `address` (string, optional): The sub-account address. - - `metadata` (object, optional): An optional metadata object for the sub-account. If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. - - `metadata` (object, optional): An optional metadata object for the account. Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata. - - `hex_bytes` (string, required): Hex-encoded string of the payload bytes. - - `signatureType` (string, enum, optional): Signature type (Choose from: ecdsa, ecdsa_recovery, ed25519, schnorr_1, schnorr_bip340, schnorr_poseidon). - - `publicKey` (object, required): 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. - - `hexBytes` (string, required): The hexadecimal representation of the public key. - - `curveType` (string, enum, required): The type of cryptographic curve associated with the public key (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). - - `signatureType` (string, enum, required): Signature type (Choose from: ecdsa, ecdsa_recovery, ed25519, schnorr_1, schnorr_bip340, schnorr_poseidon). - - `hexBytes` (string, required): Hex-encoded string representing the signature. - -### Return Object - -The method returns an object representing the network transaction created from the unsigned transaction and provided signatures. - -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-deriveaccount.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-deriveaccount.md index 2a254766..90aa05f3 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-deriveaccount.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-deriveaccount.md @@ -1,89 +1,95 @@ --- title: "deriveAccount" -slug: "rpc-cardano-deriveaccount" +slug: "rpc-cosmos-deriveaccount" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "Cosmos RPC" image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" --- -[block:html] + +## Overview + +The `deriveAccount` method enables you to derive a Cosmos account identifier from a public key, facilitating the association of public keys with specific blockchain addresses. + +## Parameters + +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | -------------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `publicKey` | object | Yes | Contains the public key information necessary to derive the account. | +| `hexBytes` | string (from publicKey) | Yes | Hexadecimal representation of the public key. | +| `curveType` | string (from publicKey) | Yes | The cryptographic curve type of the public key, e.g., "secp256k1". | +| `metadata` | object | No | Optional metadata related to the derivation process. | + +## Returns + +| Field | Type | Description | +| ------------------- | ------ | ----------------------------------------------------------------------------- | +| `accountIdentifier` | object | An object representing the derived account identifier for the Cosmos account. | + +## Example Result + +```json { - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" + "accountIdentifier": "cosmos1..." } -[/block] - +``` -### How to use it +## Request Example +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/construction/derive' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "networkIdentifier": { + "blockchain": "cosmos", + "network": "cosmos-mainnet" + }, + "publicKeys": { + "hexBytes": "PUBLIC_KEY_HEX_BYTES", + "curveType": "secp256k1" + } +}' +``` ```typescript // Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +// Initialize the Tatum SDK for Cosmos +const cosmos = await TatumSDK.init({ + network: Network.COSMOS_MAINNET, +}); -// Define the input parameters in a single object +// Define the input parameters with only required fields const params = { - networkIdentifier: { - blockchain: 'CARDANO', // string, required - network: 'NETWORK_NAME', // string, required - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', // string (optional) - metadata: { - [key: string]: any, // object (optional) - }, - }, - }, - publicKeys: { - hexBytes: 'PUBLIC_KEY_HEX_BYTES', // string, required - curveType: 'secp256k1', // CurveType, required (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas) - }, - metadata: { - // metadata is optional object - }, + networkIdentifier: { + blockchain: "COSMOS", + network: "COSMOS_MAINNET", + }, + publicKeys: { + hexBytes: "PUBLIC_KEY_HEX_BYTES", // Hexadecimal representation of the public key. + curveType: "secp256k1", // Cryptographic curve type. + }, }; -// Derive the account identifier from the public key +// Derive the Cosmos account identifier from the public key const accountIdentifier = await tatum.rpc.deriveAccount(params); -// Log the account identifier -console.log('Account Identifier:', accountIdentifier); +// Log the derived account identifier +console.log("Account Identifier:", accountIdentifier); // Always destroy the Tatum SDK instance when done to stop any background processes await tatum.destroy(); ``` - -### Overview - -The `deriveAccount` method allows you to derive an account identifier (AccountIdentifier) from a public key. - -### Example Use Cases - -1. **Account Identification**: Developers can use this method to derive the account identifier associated with a public key. - -### Request Parameters - -The `deriveAccount` method requires the following parameter: - -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `publicKey` (object, required): 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. - - `hexBytes` (string, required): The hexadecimal representation of the public key. - - `curveType` (string, enum, required): The type of cryptographic curve associated with the public key (Choose from: secp256k1, secp256k1_bip340, secp256r1, edwards25519, tweedle, pallas). -- `metadata` (object, optional): An optional metadata object. - -### Return Object - -The method returns an object representing the derived account identifier (AccountIdentifier) associated with the specified public key. - -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountbalance.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountbalance.md index fe7fc456..30331451 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountbalance.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountbalance.md @@ -1,45 +1,60 @@ - --- -title: "accountBalance" -slug: "accountBalance" +title: "getAccountBalance" +slug: "rpc-cosmos-getaccountbalance" category: "6620f7e31ea673003624a8cc" -excerpt: "Rosetta API for Cosmos" +excerpt: "Cosmos RPC" hidden: false metadata: + description: "Fetches the balance of a Cosmos account at a specific block height." image: [] - keywords: "Cosmos, account balance, Rosetta API" + keywords: "cosmos, rosetta, account balance, blockchain" robots: "index" -createdAt: "Wed Apr 11 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Wed Apr 11 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" --- ## Overview -The `/account/balance` method retrieves the balance of an account on the Cosmos network using the Rosetta API. It provides detailed information about the available and current spending balance of an account, including sub-accounts if specified. +The `getAccountBalance` endpoint in the Cosmos Rosetta API allows fetching the balance for a specified account identifier at a given block. This endpoint returns the balance only for the requested account and block, without aggregating sub-account balances unless explicitly requested. ## Parameters -| Name | Type | Required | Description | -| ------------------- | ------------- | -------- | ------------------------------------------------------------- | -| network_identifier | object | Yes | Identifies the blockchain and network. | -| account_identifier | object | Yes | Identifies the account for which the balance is requested. | +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | ----------------------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `accountIdentifier` | object | Yes | Contains information about the account. | +| `address` | string (from accountIdentifier) | Yes | The account address associated with the operation. | +| `sub_account` | object (from accountIdentifier) | No | Optional sub-account information. | +| `metadata` | object (from accountIdentifier) | No | Optional metadata for the account, including public keys if relevant. | +| `address` | string (from sub_account) | Yes | The sub-account address. | +| `metadata` | object (from sub_account) | No | Metadata for the sub-account. | +| `blockIdentifier` | object | No | Information about the specific block. | +| `index` | number (from blockIdentifier) | No | The index of the block (Type: number, Format: int64). | +| `hash` | string (from blockIdentifier) | No | The hash of the block. | +| `currency` | object | Yes | Specifies the currency details. | +| `symbol` | string (from currency) | Yes | The symbol or code of the currency. | +| `decimals` | number (from currency) | Yes | The number of decimal places for the currency. | +| `metadata` | object (from currency) | No | Additional information related to the currency, such as the contract address. | ## Returns -The method returns the current balance of the specified account and sub-account (if provided): - -| Field | Description | -| --------------- | ----------------------------------------------------------------------- | -| account_balance | The total balance of the account in the smallest unit of the currency. | -| sub_account_balance | (Optional) The balance of the sub-account, if applicable. | +| Field | Type | Description | +| ----------------- | ------ | ------------------------------------------------ | +| `blockIdentifier` | object | The block at which the balance was fetched. | +| `balances` | array | A list of balances found at the specified block. | ## Example Result ```json { - "block_identifier": { - "index": 123456, - "hash": "b10a8db164e0754105b7a99be72e3fe5" + "blockIdentifier": { + "index": 1000000, + "hash": "C2F9D..." }, "balances": [ { @@ -49,51 +64,52 @@ The method returns the current balance of the specified account and sub-account "decimals": 6 } } - ], - "metadata": {} + ] } ``` ## Request Example -```json cURL -curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/' \ +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/account/balance' \ --header 'Content-Type: application/json' \ --header 'x-api-key: {API_KEY}' \ --data '{ - "network_identifier": { + "networkIdentifier": { "blockchain": "cosmos", - "network": "mainnet" + "network": "cosmos-mainnet" }, - "account_identifier": { - "address": "cosmos1l0znsvddllw9knha3yx2svnlxny676d8ns7uys", - "sub_account": { - "address": "cosmos1dq72ndqvcfnfgptud5puvys46y0zma5pvt37gz" - } + "accountIdentifier": { + "address": "{{address}}", } }' ``` ```typescript -// yarn add @tatumio/tatum - +// Import required libraries and modules from Tatum SDK import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -const cosmos = await TatumSDK.init({ network: Network.COSMOS_MAINNET }); +// Initialize the Tatum SDK for Cosmos +const cosmos = await TatumSDK.init({ + network: Network.COSMOS_MAINNET, +}); -const accountBalance = await tatum.rpc.getAccountBalance({ - network_identifier: { - blockchain: "cosmos", - network: "mainnet" +// Define the input parameters with only required fields +const params = { + networkIdentifier: { + blockchain: "COSMOS", + network: "COSMOS_MAINNET", }, - account_identifier: { - address: "cosmos1l0znsvddllw9knha3yx2svnlxny676d8ns7uys", - sub_account: { - address: "cosmos1dq72ndqvcfnfgptud5puvys46y0zma5pvt37gz" - } - } -}); + accountIdentifier: { + address: "{{address}}", + }, +}; + +// Fetch the account balance +const accountBalance = await tatum.rpc.getAccountBalance(params); -console.log(accountBalance); +// Log the account balance +console.log("Account Balance:", accountBalance); -await cosmos.destroy(); // Destroy Tatum SDK - needed for stopping background jobs +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); ``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountcoins.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountcoins.md index 8aca0ec3..1a0ec8e7 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountcoins.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getaccountcoins.md @@ -14,29 +14,44 @@ updatedAt: "Wed Apr 11 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" ## Overview -The `/account/coins` method retrieves information about the coins stored at a specific account address on the {{blockchain}} network, using the Rosetta API. This includes detailed data on each coin or token associated with the account, which is crucial for tracking asset distributions and understanding the account's composition on the blockchain. +The `accountCoins` method retrieves information about the coins stored at a specific account address on the {{blockchain}} network, using the Rosetta API. This includes detailed data on each coin or token associated with the account, which is crucial for tracking asset distributions and understanding the account's composition on the blockchain. ## Parameters -| Name | Type | Required | Description | -| ------------------- | ------------- | -------- | ------------------------------------------------------------- | -| network_identifier | object | Yes | Identifies the blockchain and network. | -| account_identifier | object | Yes | Identifies the account for which the coin details are requested. Includes primary and sub-account details. | +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `accountIdentifier` | object | Yes | Contains information about the account. | +| `address` | string (from accountIdentifier) | Yes | The account address associated with the operation. | +| `sub_account` | object (from accountIdentifier) | No | Optional sub-account information. | +| `metadata` | object (from accountIdentifier) | No | Optional metadata for the account, including public keys if relevant. | +| `address` | string (from sub_account) | Yes | The sub-account address. | +| `metadata` | object (from sub_account) | No | Metadata for the sub-account. | +| `includeMempool` | boolean | Yes | Include state from the mempool when looking up an account's unspent coins. Note, using this functionality breaks any guarantee of idempotency. | +| `currency` | object | No | Specifies the currency details. | +| `symbol` | string (from currency) | Yes | The symbol or code of the currency. | +| `decimals` | number (from currency) | Yes | The number of decimal places for the currency. | +| `metadata` | object (from currency) | No | Additional information related to the currency, such as the contract address. | ## Returns The response includes details about each coin held in the specified account and sub-account (if provided): -| Field | Description | -| --------------- | ----------------------------------------------------------------------- | -| coins | A list of coin objects representing each asset held by the account. | -| block_identifier| The block identifier where the latest balance snapshot was taken. | +| Field | Description | +| --------------- | ------------------------------------------------------------------- | +| `coins` | A list of coin objects representing each asset held by the account. | +| `blockIdentifier` | The block identifier where the latest balance snapshot was taken. | ## Example Result ```json { - "block_identifier": { + "blockIdentifier": { "index": 1234567, "hash": "a1b2c3d4..." }, @@ -60,40 +75,36 @@ The response includes details about each coin held in the specified account and ## Request Example ```json cURL -curl --location 'https://api.tatum.io/v3/blockchain/node/{{blockchain}}-{{network}}/' \ +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/account/coins' \ --header 'Content-Type: application/json' \ --header 'x-api-key: {API_KEY}' \ --data '{ - "network_identifier": { + "networkIdentifier": { "blockchain": "{{blockchain}}", "network": "{{network}}" }, - "account_identifier": { + "accountIdentifier": { "address": "{{address}}", - "sub_account": { - "address": "{{addressto}}" - } - } + }, + "include_mempool": true }' ``` ```typescript // yarn add @tatumio/tatum -import { TatumSDK, {{BlockchainModule}}, Network } from "@tatumio/tatum"; +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -const {{blockchain}} = await TatumSDK.init<{{BlockchainModule}}>({ network: Network.{{BLOCKCHAIN_NETWORK}} }); +const {{blockchain}} = await TatumSDK.init({ network: Network.COSMOS_MAINNET }); const accountCoins = await tatum.rpc.getAccountCoins({ - network_identifier: { + networkIdentifier: { blockchain: "{{blockchain}}", network: "{{network}}" }, - account_identifier: { + accountIdentifier: { address: "{{address}}", - sub_account: { - address: "{{addressto}}" - } - } + }, + include_mempool: true }); console.log(accountCoins); diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblock.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblock.md index f923bec1..30ef8ec6 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblock.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblock.md @@ -1,81 +1,119 @@ --- title: "getBlock" -slug: "rpc-cardano-getblock" +slug: "rpc-cosmos-getblock" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "Retrieve a block in the Cosmos blockchain by Block Identifier." image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rosetta, blockchain, block" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" --- -[block:html] -{ - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" -} -[/block] +## Overview -### How to use it +The `getBlock` endpoint is designed to fetch a block from the Cosmos blockchain using a specific Block Identifier. This can be done either by the block's hash or by its height. If transactions are available, they are included directly in the response; otherwise, Transaction Identifiers are provided for subsequent fetches. -```typescript -// Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; - -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); - -// Define the input parameters in a single object -const params = { - networkIdentifier: { - blockchain: 'CARDANO', // string, required - network: 'NETWORK_NAME', // string, required - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', // string (optional) - metadata: { - [key: string]: any, // object (optional) - }, - }, - }, - blockIdentifier: { - index: 1123941, // number (int64), required - hash: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85', // string (optional) - }, -}; +## Description -// Call the getBlock -const block = await tatum.rpc.getBlock(params); +Retrieve a block by its Block Identifier. If transactions are included in the response, they are part of the returned Block object. If the transactions are not included, an array of Transaction Identifiers is returned for further fetches. Requests by block hash must be idempotent, always returning the same block contents for the same hash. Requests by block height do not have this restriction due to the possibility of chain reorganizations. -// Log the block details -console.log('Block:', block); +## Request Parameters -// Always destroy the Tatum SDK instance when done to stop any background processes -await tatum.destroy(); -``` +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | --------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `blockIdentifier` | object | Yes | The identifier of the block to fetch. Can be by hash or height. | +| `index` | number (from blockIdentifier) | No | The height of the block (optional if hash is provided). | +| `hash` | string (from blockIdentifier) | No | The hash of the block (optional if index is provided). | -### Overview +## Returns -The `getBlock` method allows you to retrieve information about a specific Cardano block based on the provided parameters. +| Field | Description | +| ------------------------- | --------------------------------------------------------------- | +| `block_identifier` | Information about the current block, including index and hash. | +| `index` | The index (height) of the block. | +| `hash` | The hash of the block. | +| `parent_block_identifier` | Information about the parent block, including index and hash. | +| `index` | The index (height) of the parent block. | +| `hash` | The hash of the parent block. | +| `timestamp` | The timestamp at which the block was proposed, in milliseconds. | +| `transactions` | An array of transactions included in the block. | +| `transaction_identifier` | Identifier for each transaction within the block. | +| `hash` | The hash of the transaction. | +| `operations` | An array detailing operations within each transaction. | -### Request Body +Each transaction detail is further broken down into identifiers and operations, providing a comprehensive breakdown of the block's contents. -The request body should contain the following parameters: +## Example Result + +```json +{ + "block": { + "block_identifier": { + "index": 19865674, + "hash": "9035A963AA5A28729F0BA316801E901A4E8B1500B2E28301FA296C2D61816F53" + }, + "parent_block_identifier": { + "index": 19865673, + "hash": "200CF85D862597295BB6D6E34888F94849B729C6D7AC688749ADCA387A57E9CD" + }, + "timestamp": 1712310176442, + "transactions": [ + { + "transaction_identifier": { + "hash": "txHash123456" + }, + "operations": [ + // List of operations + ] + } + ] + } +} +``` +## Request Example + +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/block' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "network_identifier": { + "blockchain": "cosmos", + "network": "mainnet" + }, + "block_identifier": { + "hash": "9035A963AA5A28729F0BA316801E901A4E8B1500B2E28301FA296C2D61816F53" + } +} +``` +```typescript +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `blockIdentifier` (object): An object containing information about the block to retrieve. - - `index` (number, required): The index of the block (Type: number, Format: int64). - - `hash` (string): The hash of the block (optional). +const cosmos = await TatumSDK.init({ + network: Network.COSMOS_MAINNET, +}); -### Response +const blockInfo = await tatum.rpc.getBlock({ + networkIdentifier: { + blockchain: "cosmos", + network: "mainnet", + }, + block_identifier: { + hash: "abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890", // Optional if you know the block hash + }, +}); -The response will contain details about the specified Cardano block. +console.log("Block Information:", blockInfo); -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. +await tatum.destroy(); +``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblocktransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblocktransaction.md index 529ed574..73e32d98 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblocktransaction.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getblocktransaction.md @@ -1,86 +1,119 @@ --- title: "getBlockTransaction" -slug: "rpc-cardano-getblocktransaction" +slug: "rpc-cosmos-getblocktransaction" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "Cosmos RPC" image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" --- -[block:html] -{ - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" -} -[/block] +## Overview -### How to use it +The `getBlockTransaction` method is used to retrieve detailed information about a specific transaction within a Cosmos block, utilizing the transaction's unique identifier and the block's identifier. -```typescript -// Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; - -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); - -// Define the input parameters in a single object -const params = { - networkIdentifier: { - blockchain: 'CARDANO', // string, required - network: 'NETWORK_NAME', // string, required - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', - metadata: { - [key: string]: any - } // string (optional) - }, - }, - blockIdentifier: { - index: 1123941, // number (int64), required - hash: '0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85', // string, required - }, - transactionIdentifier: { - hash: 'TRANSACTION_HASH', // string, required - }, -}; +## Description -// Call the getBlockTransaction -const transaction = await tatum.rpc.getBlockTransaction(params); +Retrieve a specific transaction by its identifier from a Cosmos block. This request needs to specify the block by its hash or index and the transaction by its hash. If the transaction is found within the specified block, its details are returned. -// Log the transaction details -console.log('Transaction:', transaction); +## Request Parameters -// Always destroy the Tatum SDK instance when done to stop any background processes -await tatum.destroy(); -``` +| Name | Type | Required | Description | +| ----------------------- | ---------------------------------- | -------- | --------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `blockIdentifier` | object | Yes | The identifier of the block to fetch. Can be by hash or height. | +| `index` | number (from blockIdentifier) | No | The height of the block (optional if hash is provided). | +| `hash` | string (from blockIdentifier) | No | The hash of the block (optional if index is provided). | +| `transactionIdentifier` | object | Yes | Identifies the transaction within the specified block. | +| `hash` | string | Yes | The hash of the transaction. | -### Overview +## Returns -The `getBlockTransaction` method allows you to retrieve information about a specific transaction within a Cardano block based on the provided parameters. +| Field | Description | +| ------------------------ | ------------------------------------------------- | +| `transaction` | The details of the requested transaction. | +| `transaction_identifier` | The unique identifier of the transaction. | +| `operations` | A list of operations involved in the transaction. | -### Request Body +## Example Result -The request body should contain the following parameters: +```json +{ + "transaction": { + "transaction_identifier": { + "hash": "TRANSACTION_HASH" + }, + "operations": [ + { + "operation_identifier": { + "index": 0 + }, + "type": "TRANSFER", + "status": "SUCCESS", + "account": { + "address": "cosmos1..." + }, + "amount": { + "value": "-1000", + "currency": { + "symbol": "ATOM", + "decimals": 6 + } + } + } + ] + } +} +``` + +## Request Example + +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/block/transaction' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "network_identifier": { + "blockchain": "cosmos", + "network": "mainnet" + }, + "block_identifier": { + "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85" + }, + "transaction_identifier": { + "hash": "TRANSACTION_HASH" + } +} +``` +```typescript +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `blockIdentifier` (object, required): An object containing information about the block to which the transaction belongs. - - `index` (number, required): The index of the block (Type: number, Format: int64). - - `hash` (string, required): The hash of the block. -- `transactionIdentifier` (object, required): An object containing information about the transaction. - - `hash` (string, required): The hash of the transaction. +const cosmos = await TatumSDK.init({ network: Network.COSMOS_MAINNET }); -### Response +const transactionDetails = await tatum.rpc.getBlockTransaction({ + networkIdentifier: { + blockchain: "cosmos", + network: "mainnet", + }, + blockIdentifier: { + index: 19865674, + }, + transactionIdentifier: { + hash: "TRANSACTION_HASH", + }, +}); -The response will contain details about the specified Cardano transaction. +console.log("Transaction Details:", transactionDetails); -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. +await tatum.destroy(); +``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-gethashoftransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-gethashoftransaction.md index 6b5f8902..e493df0e 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-gethashoftransaction.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-gethashoftransaction.md @@ -1,80 +1,89 @@ --- title: "getHashOfTransaction" -slug: "rpc-cardano-gethashoftransaction" +slug: "rpc-cosmos-gethashoftransaction" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "Calculate the transaction hash for a signed transaction on the Cosmos blockchain." image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc, transaction hash" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" --- -[block:html] -{ - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" -} -[/block] +## Overview + +The `getHashOfTransaction` method computes the hash for a signed transaction, providing a unique identifier used to track and verify transactions on the Cosmos network. + +## Description + +This method is essential for obtaining a transaction hash from a signed transaction blob. This hash serves as the transaction's unique identifier within the Cosmos blockchain, aiding in transaction verification and tracking. + +## Request Parameters + +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | ------------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name, e.g., "cosmos-mainnet". | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `signedTransaction` | string | Yes | The signed transaction blob for which the hash is to be calculated. | -### How to use it +## Returns +| Field | Description | +| ----------------- | --------------------------------------------------------------------- | +| `transactionHash` | The hash of the signed transaction, serving as its unique identifier. | + +## Example Result + +```json +{ +"transaction_hash": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f" +} +``` +## Request Example + +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/construction/hash' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "network_identifier": { + "blockchain": "cosmos", + "network": "mainnet" + }, + "signedTransaction": "SIGNED_TRANSACTION_BLOB" +} +``` ```typescript // Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; +import { TatumSDK, CosmosRosetta, Network } from "@tatumio/tatum"; -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +// Initialize the Tatum SDK for Cosmos +const tatum = await TatumSDK.init({ + network: Network.COSMOS_ROSETTA, +}); // Define the input parameters in a single object const hashRequest = { - networkIdentifier: { - blockchain: 'CARDANO', // Specify the blockchain identifier ('CARDANO' for Cardano). - network: 'NETWORK_NAME', // Specify the network name. - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', // Specify the sub-network name (optional). - metadata: { - // Optional metadata key-value pairs. - }, - }, - }, - signedTransaction: 'SIGNED_TRANSACTION', // Specify the signed transaction blob. + networkIdentifier: { + blockchain: "COSMOS", // Specify the blockchain identifier ('COSMOS' for Cosmos). + network: "NETWORK_NAME", // Specify the network name. + }, + signedTransaction: "SIGNED_TRANSACTION", // Specify the signed transaction blob. }; // Calculate the hash of the transaction const transactionHash = await tatum.rpc.getHashOfTransaction(hashRequest); // Log the transaction hash -console.log('Transaction Hash:', transactionHash); +console.log("Transaction Hash:", transactionHash); // Always destroy the Tatum SDK instance when done to stop any background processes await tatum.destroy(); -``` - -### Overview - -The `getHashOfTransaction` method allows you to calculate the unique transaction hash (ID) for a signed transaction. The transaction hash represents the unique identifier for a transaction on the Cardano blockchain. - -### Example Use Cases - -1. **Transaction Hash Calculation**: Developers can use this method to calculate the transaction hash for a signed transaction, which can be useful for tracking and verifying transactions on the Cardano network. - -### Request Parameters - -The `getHashOfTransaction` method requires the following parameters in the request body: - -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `signedTransaction` (string, required): The signed transaction blob for which you want to calculate the transaction hash. - -### Return Object - -The method returns a string representing the transaction hash (ID) of the provided signed transaction. - -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. +``` \ No newline at end of file diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworklist.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworklist.md index 48dff855..4b7f68db 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworklist.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworklist.md @@ -1,64 +1,69 @@ --- title: "getNetworkList" -slug: "rpc-cardano-getnetworklist" +slug: "rpc-cosmos-getnetworklist" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "List all networks supported by the Cosmos Rosetta interface." image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc, network list" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 12:59:42 GMT+0000 (Coordinated Universal Time)" --- -[block:html] -{ - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" -} -[/block] - - -### How to use it -```typescript -// Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; - -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +## Overview -// Optional metadata parameter -const params = metadata: { - [key: string]: any, // object (optional) - }, +The `getNetworkList` method fetches a list of all networks available through the Cosmos Rosetta API, allowing clients to discover the various blockchain networks they can interact with. -// Call the `getNetworkList` method -const networkList = await tatum.rpc.getNetworkList(params); +## Parameters -// Log the network list -console.log('Network List:', networkList); +| Name | Type | Required | Description | +| ---------- | ------ | -------- | ------------------------------- | +| `metadata` | object | No | Optional metadata if applicable | -// Always destroy the Tatum SDK instance when done to stop any background processes -await tatum.destroy(); -``` +## Returns -### Overview +The method returns a comprehensive list of all supported networks, including essential network-specific information. -The `getNetworkList` method allows you to retrieve a list of available networks that the Rosetta server supports. +| Field | Description | +| -------------------- | -------------------------------------------------------------------- | +| `network_identifier` | Identifier for each network, including blockchain and network names. | +| `blockchain` | The blockchain name for the network, e.g., "cosmos". | +| `network` | The specific network name, e.g., "mainnet". | -### Example Use Cases +## Example Result -1. **Supported Networks**: Developers can use this method to retrieve the list of networks supported by the Rosetta server. +```json +{ + "network_identifiers": [ + { + "blockchain": "cosmos", + "network": "mainnet" + } + ] +} +``` -### Request Parameters +## Request Example -The `getNetworkList` method has only optional metadata object. +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/network/list' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{} +``` +```typescript +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -- `metadata` (object, optional) +const cosmos = await TatumSDK.init({ + network: Network.COSMOS_ROSETTA, +}); -### Return Object +const networkList = await tatum.rpc.getNetworkList(); -The method returns an object representing the list of available networks supported by the Rosetta server. +console.log("Network List:", networkList); -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. +await tatum.destroy(); +``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworkstatus.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworkstatus.md index 170a33b3..43399be2 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworkstatus.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-getnetworkstatus.md @@ -1,82 +1,117 @@ --- title: "getNetworkStatus" -slug: "rpc-cardano-getnetworkstatus" +slug: "rpc-cosmos-getnetworkstatus" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "Retrieve current operational status and other relevant details about the Cosmos network." image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc, network status" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" --- -[block:html] -{ - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" -} -[/block] +## Overview -### How to use it - -```typescript -// Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; - -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); - -// Define the input parameters in a single object -const params = { - network_identifier: { - blockchain: 'CARDANO', // string, required - network: 'NETWORK_NAME', // string, required - sub_network_identifier: { - network: 'SUB_NETWORK_NAME', // string (optional) - metadata: { - [key: string]: any, // object (optional) - }, - }, - }, - metadata: { - [key: string]: any, // object (optional) - }, -}; +The `getNetworkStatus` method provides real-time information about the operational status of the Cosmos network. This includes the current network conditions, recent blocks, and any network events. -// Retrieve the status of the Cardano network -const getNetworkStatus = await tatum.rpc.getNetworkStatus(params); +## Request Parameters -// Log the network status -console.log('Cardano Network Status:', getNetworkStatus); +| Name | Type | Required | Description | +| ---------------------- | ---------------------------------- | -------- | --------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name, e.g., "cosmos-mainnet". | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `metadata` | object | No | Optional metadata providing additional context for the request. | -// Always destroy the Tatum SDK instance when done to stop any background processes -await tatum.destroy(); -``` +## Returns -### Overview +The response provides comprehensive details about the network's current state, essential for developers monitoring network health or preparing for network-wide events. -The `getNetworkStatus` method allows you to retrieve the current status of a Cardano network. +| Field | Description | +| -------------------------- | ------------------------------------------------------ | +| `current_block_identifier` | The identifier of the most recently confirmed block. | +| `current_block_timestamp` | Timestamp of the latest block in Unix milliseconds. | +| `genesis_block_identifier` | The identifier of the network's genesis block. | +| `peers` | List of active peers with which the node is connected. | -### Example Use Cases +## Example Result -1. **Network Information**: Developers can use this method to retrieve the current status and information of a Cardano network, including details about the network itself and its status. +The response returns detailed information about the current state of the network including the most recent block, the genesis block, the oldest block available due to pruning, synchronization status, and the active peers connected to the node. -### Request Parameters +```json +{ + "current_block_identifier": { + "index": 5200568, + "hash": "9035A963AA5A28729F0BA316801E901A4E8B1500B2E28301FA296C2D61816F53" + }, + "current_block_timestamp": 1618355642000, + "genesis_block_identifier": { + "index": 1, + "hash": "34EC9C1A9AB4092CF4B14B4C8107410E70FDDC09AB7B10877B167872E6F24ECC" + }, + "oldest_block_identifier": { + "index": 500, + "hash": "4F2A8B7B5E6233851C8756AE12F4759881F2B5DE9F9B44F6A6F5EA5ABD3FCD82" + }, + "sync_status": { + "synced": true, + "synced_through": { + "index": 5200000, + "hash": "C2D61816F538B1500B2E28301FA296C2D61816F53A963AA5A28729F0BA316801" + } + }, + "peers": [ + { + "peer_id": "cosmos1fl48vsnmsdzcv85q5d2q4z5ajdha8yu34mf0eh", + "metadata": { + "client_version": "v0.34.7" + } + }, + { + "peer_id": "cosmos1ql48hskj328lsv8zp6u6lqwdr8083gg9xlvnrz", + "metadata": { + "client_version": "v0.34.9" + } + } + ] +} +``` -The `getNetworkStatus` method requires the following parameters: +This structured response ensures that clients can accurately assess the node’s view of the blockchain, whether the node is up-to-date with the blockchain, the oldest data available for querying due to state pruning, and the current peers connected to the network for data propagation and consensus. + +## Request Example +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/network/status' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "network_identifier": { + "blockchain": "cosmos", + "network": "mainnet" + } +}' +``` +```typescript +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `metadata` (object, optional): Metadata associated with the network status. +const cosmos = await TatumSDK.init({ + network: Network.COSMOS_MAINNET, +}); -### Return Object +const networkStatus = await tatum.rpc.getNetworkStatus({ + networkIdentifier: { + blockchain: "cosmos", + network: "cosmos-mainnet", + }, +}); -The method returns an object representing the current status of the Cardano network. +console.log("Cosmos Network Status:", networkStatus); -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. +await tatum.destroy(); +``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-parsetransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-parsetransaction.md index 52e5919e..65ffccde 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-parsetransaction.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-parsetransaction.md @@ -1,82 +1,99 @@ --- title: "parseTransaction" -slug: "rpc-cardano-parsetransaction" +slug: "rpc-cosmos-parsetransaction" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false metadata: - description: "Cardano RPC" + description: "Cosmos RPC" image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)" --- -[block:html] -{ - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" -} -[/block] +## Overview -### How to use it +The `parseTransaction` method allows you to parse either an unsigned or signed transaction and retrieve detailed information about its contents. This function is crucial for validating transaction details before submitting them to the Cosmos network. -```typescript -// Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; +## Request Parameters -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +| Name | Type | Required | Description | +| ----------------------- | ---------------------------------- | -------- | --------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `signed` | boolean | Yes | Indicates whether the transaction is signed. | +| `transaction` | string | Yes | The transaction blob (either unsigned or signed). | -// Define the input parameters in a single object -const parseRequest = { - networkIdentifier: { - blockchain: 'CARDANO', // Specify the blockchain identifier ('CARDANO' for Cardano). - network: 'NETWORK_NAME', // Specify the network name. - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', // Specify the sub-network name (optional). - metadata: { - // Optional metadata key-value pairs. - }, - }, - }, - signed: true, // Specify whether the transaction is signed (boolean). - transaction: 'TRANSACTION', // Specify the transaction blob (either unsigned or signed). -}; +## Returns -// Parse the transaction -const parsedTransaction = await tatum.rpc.transactionParse(parseRequest); +| Field | Description | +| ------------------------ | ------------------------------------------------- | +| `parsedTransaction` | The details of the parsed transaction. | -// Log the parsed transaction -console.log('Parsed Transaction:', parsedTransaction); +## Example Result -// Always destroy the Tatum SDK instance when done to stop any background processes -await tatum.destroy(); +```json +{ + "parsedTransaction": { + "operations": [ + { + "operation_identifier": { + "index": 0 + }, + "type": "TRANSFER", + "status": "SUCCESS", + "account": { + "address": "cosmos1..." + }, + "amount": { + "value": "-1000", + "currency": { + "symbol": "ATOM", + "decimals": 6 + } + } + } + ] + } +} ``` -### Overview - -The `transactionParse` method allows you to parse either an unsigned or signed transaction and retrieve information about the transaction. It is used to examine the details of a transaction without submitting it to the blockchain. - -### Example Use Cases - -1. **Transaction Inspection**: Developers can use this method to inspect and verify the details of a transaction before submitting it to the Cardano network. - -### Request Parameters - -The `transactionParse` method requires the following parameters in the request body: +## Request Example + +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/construction/parse' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "network_identifier": { + "blockchain": "cosmos", + "network": "cosmos-mainnet" + }, + "signed": true, + "transaction": "TRANSACTION_BLOB" +}' +``` +```typescript +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `signed` (boolean, required): A boolean indicating whether the transaction is signed. Set to `true` for a signed transaction and `false` for an unsigned transaction. -- `transaction` (string, required): The transaction blob, which must be either the unsigned transaction blob returned by `constructionPayloads` or the signed transaction blob returned by `constructionCombine`. +const cosmos = await TatumSDK.init({ network: Network.COSMOS_MAINNET }); -### Return Object +const transactionDetails = await cosmos.rpc.parseTransaction({ + networkIdentifier: { + blockchain: "cosmos", + network: "mainnet" + }, + signed: true, + transaction: "TRANSACTION_BLOB" +}); -The method returns an object containing parsed information about the transaction, such as transaction inputs, outputs, and other details. +console.log("Parsed Transaction Details:", transactionDetails); -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. +await cosmos.destroy(); +``` \ No newline at end of file diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-searchtransactions.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-searchtransactions.md index 6b5177e9..a74fcca4 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-searchtransactions.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-searchtransactions.md @@ -1,127 +1,124 @@ --- title: "searchTransactions" -slug: "rpc-cardano-searchtransactions" +slug: "rpc-cosmos-searchtransactions" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false -metadata: - description: "Cardano RPC" +metadata: + description: "Search for transactions in the Cosmos blockchain based on various criteria." image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc, search, transactions" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 12:59:40 GMT+0000 (Coordinated Universal Time)" --- -[block:html] + +## Overview + +The `searchTransactions` method allows you to search for transactions matching a set of provided conditions in canonical blocks. This can be useful for querying transaction data based on various criteria. + +## Parameters + +| Name | Type | Required | Description | +| ----------------------- | ----------------------------------- | -------- | --------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `operator` | enum | No | Conditions `or` and `and` for complex queries. | +| `max_block` | number | No | The largest block index to consider. | +| `offset` | number | No | The offset into the result set to start returning transactions. | +| `limit` | number | No | The maximum number of transactions to return. | +| `transactionIdentifier` | object | No | Identifies the transaction by hash. | +| `hash` | string (from transactionIdentifier) | Yes | The hash of the transaction. | +| `accountIdentifier` | object | No | Information about the account involved. | +| `address` | string (from accountIdentifier) | Yes | The Cosmos account address associated with the operation. | +| `sub_account` | object (from accountIdentifier) | No | Optional sub-account object. | +| `metadata` | object (from accountIdentifier) | No | Metadata for the account. | +| `coinIdentifier` | object | No | Conditions for coin identifier. | +| `identifier` | string (from coinIdentifier) | Yes | A globally unique identifier of a Coin. | +| `currency` | object | No | Specifies the currency details. | +| `symbol` | string (from currency) | Yes | The symbol or code of the currency. | +| `decimals` | number (from currency) | Yes | The number of decimal places for the currency. | +| `status` | string | No | The network-specific operation status type. | +| `type` | string | No | The network-specific operation type. | +| `address` | string | No | Account address for transaction search. | +| `success` | boolean | No | A synthetic condition indicating success. | + +## Returns + +| Field | Description | +| -------------- | ------------------------------------------------------ | +| `transactions` | A list of transactions that match the search criteria. | + +## Example Result + +```json { - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" + "transactions": [ + { + "transaction_identifier": { + "hash": "TRANSACTION_HASH" + }, + "operations": [ + { + "operation_identifier": { + "index": 0 + }, + "type": "TRANSFER", + "status": "SUCCESS", + "account": { + "address": "cosmos1..." + }, + "amount": { + "value": "-1000", + "currency": { + "symbol": "ATOM", + "decimals": 6 + } + } + } + ] + } + ], + "total_count": 5, + "next_offset": 5 } -[/block] - +``` -### How to use it +## Request Example + +```json +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/search/transactions' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data '{ + "network_identifier": { + "blockchain": "cosmos", + "network": "mainnet" + } +}' +``` ```typescript -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); +const cosmos = await TatumSDK.init({ + network: Network.COSMOS_MAINNET, +}); -// Define the input parameters in a single object -const params = { - networkIdentifier: { - blockchain: 'CARDANO', - network: 'NETWORK_NAME', - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', - metadata: { - // Optional metadata key-value pairs. - }, - }, - }, - operator: { - // Specify search conditions (optional). - }, - max_block: 5, // The largest block index to consider (optional). - offset: 5, // The offset into the query result to start returning transactions (optional). - limit: 5, // The maximum number of transactions to return in one call (optional). - transactionIdentifier: { - hash: 'TRANSACTION_HASH', // string, required - }, - accountIdentifier: { - address: 'ACCOUNT_ADDRESS', // string, required - sub_account: { - // Specify sub-account information if applicable - }, - metadata: { - chain_code: 'CHAIN_CODE', // Specify chain code if applicable - }, - }, - coin_identifier: { - identifier: 'CO' // Specify search conditions (optional). - }, - currency: { - symbol: 'CURRENCY_SYMBOL', // Required: Specifies the currency symbol . - decimals: 6, // Required: Specifies the currency decimals (number). - metadata: { - // Optional metadata for amount object - }, - }, - status: 'reverted', // The network-specific operation status type (optional). - type: 'transfer', // The network-specific operation type (optional). - address: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347', // Account address (optional). - success: true, // A synthetic condition (optional). -}; - -// Search for transactions -const transactions = await tatum.rpc.searchTransactions(params); +const transactions = await cosmos.rpc.searchTransactions({ + networkIdentifier: { + blockchain: "cosmos", + network: "mainnet", + }, +}); // Log the retrieved transactions -console.log('Transactions:', transactions); +console.log("Transactions:", transactions); // Always destroy the Tatum SDK instance when done to stop any background processes await tatum.destroy(); ``` - -### Overview - -The `searchTransactions` method allows you to search for transactions matching a set of provided conditions in canonical blocks. This can be useful for querying transaction data based on various criteria. - -### Example Use Cases - -1. **Transaction Query**: Developers can use this method to search for transactions that meet specific criteria, such as a particular status or operation type. -2. **Block Analysis**: Users can analyze transactions within a specific range of blocks to identify patterns or trends. - -## Request Parameters - -The `searchTransactions` method requires the following parameters in the request body: - -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to `CARDANO` for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, optional): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `operator` (enum, optional): Additional search conditions `or` and `and`. -- `max_block` (number, optional): The largest block index to consider when searching for transactions. If not populated, the current block is considered the `max_block`. If you do not specify a `max_block`, it is possible that a newly synced block will interfere with paginated transaction queries (as the offset could become invalid with newly added rows). -- `offset` (number, optional): 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. -- `limit` (number, optional): The maximum number of transactions to return in one call. The implementation may return \<= `limit` transactions. -- `transactionIdentifier` (object, required): An object containing information about the transaction. - - `hash` (string, required): The hash of the transaction. -- `accountIdentifier` (object, optional): An object containing information about the account. - - `address` (string, required): The Cardano account address associated with the operation. - - `sub_account` (object, optional): An optional sub-account object. - - `address` (string, optional): The sub-account address. - - `metadata` (object, optional): An optional metadata object for the sub-account. If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients. - - `metadata` (object, optional): An optional metadata object for the account. -- `coinIdentifier` (object, optional): Specify search conditions for coin identifier. Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction\_hash: index. - - `identifier` (string, required): Example: '0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f: 1' -- `currency` (object, required): An object specifying the currency details. - `symbol` (string, required): The symbol or code of the currency. - `decimals` (number, required): The number of decimal places for the currency. - `metadata` (object, optional): Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token. -- `status` (string, optional): The network-specific operation status type (optional). -- `type` (string, optional): The network-specific operation type (optional). -- `address` (string, optional): AccountIdentifier.Address. This is used to get all transactions related to an AccountIdentifier.Address, regardless of SubAccountIdentifier. -- `success` (boolean, optional): A synthetic condition populated by parsing network-specific operation statuses. - -### Return Object - -The method returns a list of transactions that match the specified search criteria. diff --git a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-submittransaction.md b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-submittransaction.md index bcf47b02..73505651 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-submittransaction.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-cosmos/rpc-cosmos-submittransaction.md @@ -1,80 +1,81 @@ --- title: "submitTransaction" -slug: "rpc-cardano-submittransaction" +slug: "rpc-cosmos-submittransaction" category: "6620f7e31ea673003624a8cc" -excerpt: "Cardano RPC" +excerpt: "Cosmos RPC" hidden: false metadata: - description: "Cardano RPC" + description: "Submit transactions to the Cosmos network." image: [] - keywords: "cardano, rpc" + keywords: "cosmos, rpc, submit transaction" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" updatedAt: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)" --- -[block:html] -{ - "html": "
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
" -} -[/block] +## Overview -### How to use it +The `submitTransaction` method allows you to submit a signed transaction to the Cosmos network for processing. This is essential for pushing transactions to the blockchain, enabling transfers, smart contract interactions, and other blockchain activities. -```typescript -// Import required libraries and modules from Tatum SDK -import { TatumSDK, CardanoRosetta, Network } from '@tatumio/tatum'; - -// Initialize the Tatum SDK for Cardano -const tatum = await TatumSDK.init({ network: Network.CARDANO_ROSETTA }); - -// Define the input parameters in a single object -const submitRequest = { - networkIdentifier: { - blockchain: 'CARDANO', // Specify the blockchain identifier ('CARDANO' for Cardano). - network: 'NETWORK_NAME', // Specify the network name. - subNetworkIdentifier: { - network: 'SUB_NETWORK_NAME', // Specify the sub-network name (optional). - metadata: { - // Optional metadata. - }, - }, - }, - signedTransaction: 'SIGNED_TRANSACTION', // Specify the signed transaction to submit. -}; +## Parameters -// Submit the signed transaction to the network -const transactionResponse = await tatum.rpc.submitTransaction(submitRequest); +| Name | Type | Required | Description | +| --------------------- | ------ | -------- | ---------------------------------------------------------------- | +| `networkIdentifier` | object | Yes | Identifies the Cosmos blockchain and network details. | +| `blockchain` | string (from networkIdentifier) | Yes | The blockchain identifier, typically "Cosmos". | +| `network` | string (from networkIdentifier) | Yes | The network name on which the transaction is taking place. | +| `subNetworkIdentifier` | object (from networkIdentifier) | No | Optional sub-network identifier object. | +| `network` | string (from subNetworkIdentifier) | Yes | The name of the sub-network within Cosmos. | +| `metadata` | object (from subNetworkIdentifier) | No | Metadata associated with the sub-network. | +| `signedTransaction` | string | Yes | The signed transaction data in hexadecimal format. | -// Log the transaction response -console.log('Transaction Response:', transactionResponse); +## Returns -// Always destroy the Tatum SDK instance when done to stop any background processes -await tatum.destroy(); -``` +The method returns a response from the Cosmos network that typically includes the transaction hash, indicating successful submission. -### Overview +| Field | Description | +| -------------------- | --------------------------------------------------- | +| `transactionHash` | The hash of the transaction as accepted by the network. | -The `submitTransaction` method allows you to submit a signed transaction to the Cardano network for processing. After successfully constructing and signing a transaction, you can use this method to broadcast it to the network. +## Example Result -### Example Use Cases +```json +{ + "transactionHash": "CBA1234ABCD5678EFGH91011IJ" +} +``` + +## Request Example -1. **Transaction Submission**: Developers can use this method to submit a signed Cardano transaction to the network for execution. This is the final step in the transaction lifecycle. +```curl +curl --location 'https://api.tatum.io/v3/blockchain/node/cosmos-mainnet/construction/submit' \ +--header 'Content-Type: application/json' \ +--header 'x-api-key: {API_KEY}' \ +--data-raw '{ + "networkIdentifier": { + "blockchain": "cosmos", + "network": "mainnet" + }, + "signedTransaction": "7f2b...f123" +}' +``` -### Request Parameters +```typescript +// yarn add @tatumio/tatum -The `submitTransaction` method requires the following parameters in the request body: +import { TatumSDK, Cosmos, Network } from "@tatumio/tatum"; -- `networkIdentifier` (object, required): An object containing information about the blockchain network. - - `blockchain` (string, required): The blockchain identifier, which should be set to 'CARDANO' for Cardano. - - `network` (string, required): The network name for Cardano. - - `subNetworkIdentifier` (object, optional): An optional sub-network identifier object. - - `network` (string, required): The name of the sub-network within Cardano. - - `metadata` (object, optional): Metadata associated with the sub-network. -- `signedTransaction` (string, required): The signed transaction blob that you want to submit to the Cardano network. +const cosmos = await TatumSDK.init({ network: Network.COSMOS_MAINNET }); -### Return Object +const submitResponse = await tatum.rpc.submitTransaction({ + networkIdentifier: { + blockchain: "cosmos", + network: "mainnet", + }, + signedTransaction: "7f2b...f123" +}); -The method returns an object representing the response from the Cardano network after submitting the signed transaction. This response may include details about the transaction's acceptance by the network. +console.log('Transaction Response:', submitResponse); -Structure and behavior of this method may vary with different versions of the Cardano service. Always refer to the documentation specific to the version you are using for the most accurate information. +await tatum.destroy(); // Destroy Tatum SDK - needed for stopping background jobs +``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena.md index 9d9f06b3..02c28be4 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena.md @@ -7,3 +7,4 @@ hidden: false createdAt: "Wed Mar 10 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" updatedAt: "Wed Mar 10 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" --- +Kadena RPC (Remote Procedure Call) is a critical component of the Kadena blockchain platform, which is known for its pioneering work in providing a scalable and secure blockchain solution. RPC in the context of Kadena allows developers and users to interact with the Kadena network through a set of standardized commands and functions. This interaction is essential for executing smart contracts, querying blockchain data, and performing transactions on the Kadena network. Utilizing JSON-RPC protocols, Kadena RPC facilitates seamless communication between clients (such as wallets or other applications) and the blockchain nodes, enabling efficient and effective network operations. This introduction aims to provide a clear overview of how Kadena RPC operates and its significance in enhancing the functionality and user experience on the Kadena blockchain. \ No newline at end of file diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-checknodehealth.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-checknodehealth.md index 852f4768..0c103b9d 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-checknodehealth.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-checknodehealth.md @@ -2,7 +2,7 @@ title: "checkNodeHealth" excerpt: "Kadena RPC" slug: "rpc-kadena-checknodehealth" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: image: [] diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getbatchblockpayloadwithoutputs.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getbatchblockpayloadwithoutputs.md index fb326586..7cb9d947 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getbatchblockpayloadwithoutputs.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getbatchblockpayloadwithoutputs.md @@ -2,7 +2,7 @@ title: "getBatchBlockPayloadWithOutputs" excerpt: "Kadena RPC" slug: "rpc-kadena-getbatchblockpayloadwithoutputs" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Retrieve a batch of block payloads with outputs for specified payload hashes in the Kadena blockchain." diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getbatchofblockpayload.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getbatchofblockpayload.md index 24bcaf0a..9abfc046 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getbatchofblockpayload.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getbatchofblockpayload.md @@ -2,7 +2,7 @@ title: "getBatchOfBlockPayload" excerpt: "Kadena RPC" slug: "rpc-kadena-getbatchofblockpayload" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Retrieve a batch of block payloads by hash in the Kadena blockchain." diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblock.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblock.md index de383fc2..0403b6ca 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblock.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblock.md @@ -2,7 +2,7 @@ title: "getBlock" excerpt: "Kadena RPC" slug: "rpc-kadena-getblock" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: image: [] @@ -23,10 +23,10 @@ The `/chain/{chain}/block` endpoint allows for retrieving a collection of blocks | apiVersion | string | Yes | Version of Kadena API "0.0" | | nodeVersion | enum | Yes | "test-singleton" "development" "mainnet01" "testnet04" | | chain | string | Yes | The specific chain ID from which to retrieve blocks. | -| limit | integer | No | The maximum number of blocks to return. | +| limit | number | No | The maximum number of blocks to return. | | next | string | No | A cursor for pagination to fetch subsequent blocks. | -| minheight | integer | No | The minimum block height to include in the results. | -| maxheight | integer | No | The maximum block height to include in the results. | +| minheight | number | No | The minimum block height to include in the results. | +| maxheight | number | No | The maximum block height to include in the results. | ## Returns diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockbranches.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockbranches.md index d9c561d0..0f2433eb 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockbranches.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockbranches.md @@ -2,7 +2,7 @@ title: "getBlockBranches" excerpt: "Kadena RPC" slug: "rpc-kadena-getblockbranches" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Retrieve blocks from branches in the Kadena blockchain." @@ -24,10 +24,10 @@ The `/chain/{chain}/block/branch` endpoint retrieves a page of blocks from branc | apiVersion | string | Yes | Version of Kadena API "0.0" | | nodeVersion | enum | Yes | "test-singleton" "development" "mainnet01" "testnet04" | | chain | string | Yes | The specific chain ID for which to retrieve block branches. | -| limit | integer | No | The maximum number of blocks to return. | +| limit | number | No | The maximum number of blocks to return. | | next | string | No | A cursor for pagination to fetch subsequent blocks. | -| minheight | integer | No | The minimum block height to include in the results. | -| maxheight | integer | No | The maximum block height to include in the results. | +| minheight | number | No | The minimum block height to include in the results. | +| maxheight | number | No | The maximum block height to include in the results. | ## Request Body diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockhashbranches.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockhashbranches.md index 17f8a33b..516442a9 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockhashbranches.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockhashbranches.md @@ -2,7 +2,7 @@ title: "getBlockHashBranches" excerpt: "Kadena RPC" slug: "rpc-kadena-getblockhashbranches" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Retrieve block hash branches in Kadena blockchain." @@ -24,10 +24,10 @@ The `/chain/{chain}/hash/branch` endpoint retrieves a page of block hashes from | apiVersion | string | Yes | Version of Kadena API "0.0" | | nodeVersion | enum | Yes | "test-singleton" "development" "mainnet01" "testnet04" | | chain | string | Yes | The specific chain ID for which to retrieve block hash branches. | -| limit | integer | No | The maximum number of block hashes to return. | +| limit | number | No | The maximum number of block hashes to return. | | next | string | No | A cursor for pagination to fetch subsequent block hashes. | -| minheight | integer | No | The minimum block height to include in the results. | -| maxheight | integer | No | The maximum block height to include in the results. | +| minheight | number | No | The minimum block height to include in the results. | +| maxheight | number | No | The maximum block height to include in the results. | ## Request Body diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockhashes.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockhashes.md index 9e0ea11b..6832ee28 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockhashes.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockhashes.md @@ -2,7 +2,7 @@ title: "getBlockHashes" excerpt: "Kadena RPC" slug: "rpc-kadena-getblockhashes" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Kadena RPC" @@ -24,10 +24,10 @@ The `/chain/{chain}/hash` endpoint retrieves a collection of block hashes from a | apiVersion | string | Yes | Version of Kadena API "0.0" | | nodeVersion | enum | Yes | "test-singleton" "development" "mainnet01" "testnet04" | | chain | string | Yes | The specific chain ID from which to retrieve block hashes. | -| limit | integer | No | The maximum number of block hashes to return. | +| limit | number | No | The maximum number of block hashes to return. | | next | string | No | A cursor for pagination to fetch subsequent block hashes. | -| minheight | integer | No | The minimum block height to include in the results. | -| maxheight | integer | No | The maximum block height to include in the results. | +| minheight | number | No | The minimum block height to include in the results. | +| maxheight | number | No | The maximum block height to include in the results. | ## Returns diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaderbranches.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaderbranches.md new file mode 100644 index 00000000..c5bb79ec --- /dev/null +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaderbranches.md @@ -0,0 +1,74 @@ +--- +title: "getBlockHeaderBranches" +slug: "rpc-kadena-getblockheaderbranches" +category: "6620f7e31ea673003624a8cc" +excerpt: "Retrieve Block Header Branches for a Specific Blockchain Chain" +hidden: false +metadata: + image: [] + keywords: "blockchain, block header, branches, header branches" + robots: "index" +createdAt: "Wed Apr 11 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Wed Apr 11 2024 10:00:00 GMT+0000 (Coordinated Universal Time)" +--- + +## Overview + +The `/chain/{chain}/header/branch` endpoint allows retrieval of a page of block headers from branches of the blockchain in descending order. It provides headers that are ancestors of any block in the set of upper bounds and are not ancestors of any block in the set of lower bounds. + +## Parameters + +| Name | Type | Required | Description | +| ----------- | ------- | -------- | ---------------------------------------------------------------- | +| apiVersion | string | Yes | Version of Kadena API "0.0" | +| nodeVersion | enum | Yes | "test-singleton" "development" "mainnet01" "testnet04" | +| chain | string | Yes | The specific chain ID from which to retrieve block hashes. | +| limit | number | No | The maximum number of block headers to return. | +| next | string | No | A cursor for pagination to fetch subsequent block headers. | +| minheight | number | No | The minimum block height to include in the results. | +| maxheight | number | No | The maximum block height to include in the results. | + +## Request Body + +| Field | Type | Description | +| ----- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| lower | array | An array of block hashes. No blocks are returned that are predecessors of any block with a hash from this array. | +| upper | array | An array of block hashes. Returned block headers are predecessors of a block with a hash from this array. This includes blocks with hashes from this array. | + +## Returns + +A successful call to this endpoint returns a JSON object containing the following fields: + +| Field | Description | +| ----- | ------------------------------------------------------------------- | +| next | The cursor for the next page of block headers. | +| items | An array of block headers, detailing the branches in the blockchain. | +| limit | The maximum number of block headers returned in this response. | + +## Request Example + +```curl +curl --location 'https://api.tatum.io/v3/blockchain/node/kadena-mainnet/{api_key}/chainweb/{apiVersion}/{nodeVersion}/chain/{chain}/header/branch' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "lower": ["example_lower_hash"], + "upper": ["example_upper_hash"] +}' +``` +```typescript +// yarn add @tatumio/tatum + +import { TatumSDK, Blockchain } from "@tatumio/tatum"; + +const sdk = await TatumSDK.init({ network: Network.BLOCKCHAIN_MAINNET }); + +const headerBranches = await sdk.rpc.getBlockHeaderBranches({ + chain: 0, + lower: ["example_lower_hash"], + upper: ["example_upper_hash"] +}); + +console.log(headerBranches); + +await sdk.destroy(); // Destroy Tatum SDK - needed for stopping background jobs +``` diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaderbyhash.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaderbyhash.md index 1b7ccc7f..bf0e4d58 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaderbyhash.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaderbyhash.md @@ -2,7 +2,7 @@ title: "getBlockHeaderByHash" excerpt: "Kadena RPC" slug: "rpc-kadena-getblockheaderbyhash" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Retrieve a block header by hash in Kadena blockchain." diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaders.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaders.md index 2910976c..3dc82346 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaders.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockheaders.md @@ -2,7 +2,7 @@ title: "getBlockHeaders" excerpt: "Kadena RPC" slug: "rpc-kadena-getblockheaders" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Retrieve a collection of block headers from the Kadena blockchain." @@ -24,10 +24,10 @@ The `/chain/{chain}/header` endpoint retrieves a page of block headers in ascend | apiVersion | string | Yes | Version of Kadena API "0.0" | | nodeVersion | enum | Yes | "test-singleton" "development" "mainnet01" "testnet04" | | chain | string | Yes | The specific chain ID from which to retrieve headers. | -| limit | integer | No | The maximum number of headers to return. | +| limit | number | No | The maximum number of headers to return. | | next | string | No | A cursor for pagination to fetch subsequent headers. | -| minheight | integer | No | The minimum block height to include in the results. | -| maxheight | integer | No | The maximum block height to include in the results. | +| minheight | number | No | The minimum block height to include in the results. | +| maxheight | number | No | The maximum block height to include in the results. | ## Returns diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockpayloadwithoutputs.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockpayloadwithoutputs.md index 3e5071d8..8dfc0811 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockpayloadwithoutputs.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getblockpayloadwithoutputs.md @@ -2,7 +2,7 @@ title: "getPayloadWithOutputs" excerpt: "Kadena RPC" slug: "rpc-kadena-getblockpayloadwithoutputs" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Retrieve the block payload with outputs for a given payload hash in the Kadena blockchain." diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getcurrentcut.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getcurrentcut.md index 3842ca68..d823deb7 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getcurrentcut.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getcurrentcut.md @@ -2,7 +2,7 @@ title: "getCurrentCut" excerpt: "Kadena RPC" slug: "rpc-kadena-getcurrentcut" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Kadena RPC" diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getinfo.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getinfo.md index c54c6c1f..fa8438ea 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getinfo.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getinfo.md @@ -2,7 +2,7 @@ title: "getinfo" excerpt: "Kadena RPC" slug: "rpc-kadena-getinfo" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Kadena RPC" diff --git a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getpayloadbyhash.md b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getpayloadbyhash.md index 74c59531..8dfb2003 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getpayloadbyhash.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-kadena/rpc-kadena-getpayloadbyhash.md @@ -2,7 +2,7 @@ title: "getPayloadByHash" excerpt: "getCurrentCut" slug: "rpc-kadena-getpayloadbyhash" -category: "65c5e93c623cad004b45d505" +category: "6620f7e31ea673003624a8cc" hidden: false metadata: description: "Retrieve payload data for a specific block in the Kadena blockchain by payload hash." diff --git a/v1.0/RPC Nodes/rpc-others/rpc-tron/rpc-tron-getaccountbalance.md b/v1.0/RPC Nodes/rpc-others/rpc-tron/rpc-tron-getaccountbalance.md index eb417633..e24e3312 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-tron/rpc-tron-getaccountbalance.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-tron/rpc-tron-getaccountbalance.md @@ -67,17 +67,17 @@ The `getAccountBalance` method is used to retrieve an account's balance at a spe The method returns a JSON object that contains the following properties: - `balance` (integer): The balance of the account. -- `block_identifier.hash` (string): The block hash. -- `block_identifier.number` (integer): The block number. +- `blockIdentifier.hash` (string): The block hash. +- `blockIdentifier.number` (integer): The block number. ### HTTP Request Example ```json { - "account_identifier": { + "accountIdentifier": { "address": "TLLM21wteSPs4hKjbxgmH1L6poyMjeTbHm" }, - "block_identifier": { + "blockIdentifier": { "hash": "0000000000010c4a732d1e215e87466271e425c86945783c3d3f122bfa5affd9", "number": 68682 }, @@ -90,7 +90,7 @@ The method returns a JSON object that contains the following properties: ```json { "balance": 100000, - "block_identifier": { + "blockIdentifier": { "hash": "0000000000010c4a732d1e215e87466271e425c86945783c3d3f122bfa5affd9", "number": 68682 } diff --git a/v1.0/RPC Nodes/rpc-others/rpc-tron/rpc-tron-getblockbalance.md b/v1.0/RPC Nodes/rpc-others/rpc-tron/rpc-tron-getblockbalance.md index 42daa422..393f10ff 100644 --- a/v1.0/RPC Nodes/rpc-others/rpc-tron/rpc-tron-getblockbalance.md +++ b/v1.0/RPC Nodes/rpc-others/rpc-tron/rpc-tron-getblockbalance.md @@ -52,8 +52,8 @@ The `getBlockBalance` RPC method retrieves all balance change operations in a sp The method returns an object with the following properties: - `timestamp` (integer): The timestamp of the block. -- `block_identifier.hash` (string): The hash of the block. -- `block_identifier.number` (integer): The number of the block. +- `blockIdentifier.hash` (string): The hash of the block. +- `blockIdentifier.number` (integer): The number of the block. - `transaction_balance_trace` (TransactionBalanceTrace\[]): An array of transaction information with balance changes. Each TransactionBalanceTrace object contains: - `transaction_identifier` (string): The hash of the transaction. - `operation` (Operation\[]): An array of operations involved in the transaction. Each operation contains: @@ -78,7 +78,7 @@ The method returns an object with the following properties: ```json { "timestamp": 1630847456000, - "block_identifier": { + "blockIdentifier": { "hash": "0000000001f5b9ca67c722d9263879696c92e8e383d4f0b31c15a91b8a249029", "number": 32881098 }, diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch.md index 4b0784a0..a61b0ece 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch.md @@ -1,5 +1,6 @@ --- title: "BCH" +category: "6620f7e31ea673003624a8cc" slug: "rpc-bch" excerpt: "" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetBalance.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetBalance.md index e1be38ee..e1b30e0a 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetBalance.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetBalance.md @@ -1,6 +1,6 @@ --- title: "blockchainAddressGetBalance" -slug: "BlockchainAddressGetBalance" +slug: "rpc-rostrum-blockchainAddressGetBalance" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetHistory.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetHistory.md index 9fcdfed7..8c2ebd38 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetHistory.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetHistory.md @@ -1,6 +1,6 @@ --- title: "blockchainAddressGetHistory" -slug: "blockchainAddressGetHistory" +slug: "rpc-rostrum-blockchainAddressGetHistory" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetMempool.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetMempool.md index 5adcccf3..bdd642eb 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetMempool.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressGetMempool.md @@ -1,6 +1,6 @@ --- title: "blockchainAddressGetMempool" -slug: "blockchainAddressGetMempool" +slug: "rpc-rostrum-blockchainAddressGetMempool" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressListUnspent.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressListUnspent.md index 8e9cf5d9..f4b2b416 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressListUnspent.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainAddressListUnspent.md @@ -1,6 +1,6 @@ --- title: "blockchainAddressListUnspent" -slug: "blockchainAddressListUnspent" +slug: "rpc-rostrum-blockchainAddressListUnspent" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockGet.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockGet.md index e14f606e..a17da2b1 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockGet.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockGet.md @@ -1,6 +1,6 @@ --- title: "blockchainBlockGet" -slug: "BlockchainBlockGet" +slug: "rpc-rostrum-blockchainBlockGet" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockHeader.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockHeader.md index bec25eaf..0d9ca267 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockHeader.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockHeader.md @@ -1,6 +1,6 @@ --- title: "blockchainBlockHeader" -slug: "blockchainBlockHeader" +slug: "rpc-rostrum-blockchainBlockHeader" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockHeaders.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockHeaders.md index 78ed8a88..4c031abd 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockHeaders.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainBlockHeaders.md @@ -1,6 +1,6 @@ --- title: "blockchainBlockHeaders" -slug: "blockchainBlockHeaders" +slug: "rpc-rostrum-blockchainBlockHeaders" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainEstimateFee.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainEstimateFee.md index 5917c640..2e4d176e 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainEstimateFee.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainEstimateFee.md @@ -1,6 +1,6 @@ --- title: "blockchainEstimateFee" -slug: "blockchainEstimateFee" +slug: "rpc-rostrum-blockchainEstimateFee" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainHeadersSubscribe.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainHeadersSubscribe.md index 4835934a..df07458f 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainHeadersSubscribe.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainHeadersSubscribe.md @@ -1,6 +1,6 @@ --- title: "blockchainHeadersSubscribe" -slug: "blockchainHeadersSubscribe" +slug: "rpc-rostrum-blockchainHeadersSubscribe" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainHeadersTip.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainHeadersTip.md index 9e506774..ea90c3a2 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainHeadersTip.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainHeadersTip.md @@ -1,6 +1,6 @@ --- title: "blockchainHeadersTip" -slug: "blockchainHeadersTip" +slug: "rpc-rostrum-blockchainHeadersTip" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainRelayFee.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainRelayFee.md index 7363a1c6..b071da94 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainRelayFee.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainRelayFee.md @@ -1,6 +1,6 @@ --- title: "blockchainRelayFee" -slug: "blockchainRelayFee" +slug: "rpc-rostrum-blockchainRelayFee" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainTransactionBroadcast.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainTransactionBroadcast.md index 847fc89f..6268cb13 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainTransactionBroadcast.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainTransactionBroadcast.md @@ -1,6 +1,6 @@ --- title: "blockchainTransactionBroadcast" -slug: "blockchainTransactionBroadcast" +slug: "rpc-rostrum-blockchainTransactionBroadcast" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainTransactionGet.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainTransactionGet.md index e5ce9bf4..49ba775b 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainTransactionGet.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/blockchainTransactionGet.md @@ -1,6 +1,6 @@ --- title: "blockchainTransactionGet" -slug: "blockchainTransactionGet" +slug: "rpc-rostrum-blockchainTransactionGet" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash and Nexa" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/serverBanner.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/serverBanner.md index e17b49ce..e803cf76 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/serverBanner.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/serverBanner.md @@ -1,6 +1,6 @@ --- title: "serverBanner" -slug: "serverBanner" +slug: "rpc-rostrum-serverBanner" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/serverVersion.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/serverVersion.md index e5312d6e..cc05e2fc 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/serverVersion.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum/serverVersion.md @@ -1,6 +1,6 @@ --- title: "serverVersion" -slug: "serverVersion" +slug: "rpc-rostrum-serverVersion" category: "6620f7e31ea673003624a8cc" excerpt: "Rostrum Electrum for Bitcoin Cash" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-createrawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-createrawtransaction.md index 13cc02fd..b3605576 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-createrawtransaction.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-createrawtransaction.md @@ -1,6 +1,7 @@ --- title: "createrawtransaction" slug: "rpc-bch-createrawtransaction" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-decoderawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-decoderawtransaction.md index db71dbb6..b3949e97 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-decoderawtransaction.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-decoderawtransaction.md @@ -1,6 +1,7 @@ --- title: "decoderawtransaction" slug: "rpc-bch-decoderawtransaction" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-decodescript.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-decodescript.md index 73f87d03..6e83709f 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-decodescript.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-decodescript.md @@ -1,6 +1,7 @@ --- title: "decodescript" slug: "rpc-bch-decodescript" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-estimatefee.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-estimatefee.md index 8bc1d22b..32bda0c2 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-estimatefee.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-estimatefee.md @@ -1,6 +1,7 @@ --- title: "estimatefee" slug: "rpc-bch-estimatefee" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-estimatesmartfee.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-estimatesmartfee.md index 5fedf6fe..fc9514dc 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-estimatesmartfee.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-estimatesmartfee.md @@ -1,6 +1,7 @@ --- title: "estimatesmartfee" slug: "rpc-bch-estimatesmartfee" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getbestblockhash.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getbestblockhash.md index 1535d9c3..1e965893 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getbestblockhash.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getbestblockhash.md @@ -1,6 +1,7 @@ --- title: "getbestblockhash" slug: "rpc-bch-getbestblockhash" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblock.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblock.md index 5c3a8162..c9ead271 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblock.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblock.md @@ -1,6 +1,7 @@ --- title: "getblock" slug: "rpc-bch-getblock" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockchaininfo.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockchaininfo.md index 87cbab5c..a2a6049d 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockchaininfo.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockchaininfo.md @@ -1,6 +1,7 @@ --- title: "getblockchaininfo" slug: "rpc-bch-getblockchaininfo" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockcount.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockcount.md index d3901466..36e894e0 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockcount.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockcount.md @@ -1,6 +1,7 @@ --- title: "getblockcount" slug: "rpc-bch-getblockcount" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockhash.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockhash.md index b911e595..42879274 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockhash.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockhash.md @@ -1,6 +1,7 @@ --- title: "getblockhash" slug: "rpc-bch-getblockhash" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockheader.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockheader.md index 5bfbded4..6685fb42 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockheader.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockheader.md @@ -1,6 +1,7 @@ --- title: "getblockheader" slug: "rpc-bch-getblockheader" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockstats.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockstats.md index 3283ded6..6515310a 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockstats.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getblockstats.md @@ -1,6 +1,7 @@ --- title: "getblockstats" slug: "rpc-bch-getblockstats" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getchaintips.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getchaintips.md index ecb65be8..c9bf5db8 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getchaintips.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getchaintips.md @@ -1,6 +1,7 @@ --- title: "getchaintips" slug: "rpc-bch-getchaintips" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getdifficulty.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getdifficulty.md index 9f9fec8f..7fc77c74 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getdifficulty.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getdifficulty.md @@ -1,6 +1,7 @@ --- title: "getdifficulty" slug: "rpc-bch-getdifficulty" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolancestors.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolancestors.md index a679896a..f4a6a5cb 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolancestors.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolancestors.md @@ -1,6 +1,7 @@ --- title: "getmempoolancestors" slug: "rpc-bch-getmempoolancestors" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempooldescendants.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempooldescendants.md index 43c4dc92..e3de2f9b 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempooldescendants.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempooldescendants.md @@ -1,6 +1,7 @@ --- title: "getmempooldescendants" slug: "rpc-bch-getmempooldescendants" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolentry.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolentry.md index e0996b76..660ed2cf 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolentry.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolentry.md @@ -1,6 +1,7 @@ --- title: "getmempoolentry" slug: "rpc-bch-getmempoolentry" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolinfo.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolinfo.md index 8eadabc5..f016e79d 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolinfo.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getmempoolinfo.md @@ -1,6 +1,7 @@ --- title: "getmempoolinfo" slug: "rpc-bch-getmempoolinfo" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getrawmempool.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getrawmempool.md index 944ddd4a..a360bded 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getrawmempool.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getrawmempool.md @@ -1,6 +1,7 @@ --- title: "getrawmempool" slug: "rpc-bch-getrawmempool" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getrawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getrawtransaction.md index 2fdad88f..1132d827 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getrawtransaction.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-getrawtransaction.md @@ -1,6 +1,7 @@ --- title: "getrawtransaction" slug: "rpc-bch-getrawtransaction" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-gettxout.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-gettxout.md index 796a9cfe..600cc1b0 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-gettxout.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-gettxout.md @@ -1,6 +1,7 @@ --- title: "gettxout" slug: "rpc-bch-gettxout" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-gettxoutproof.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-gettxoutproof.md index 5cc64fbe..7011c314 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-gettxoutproof.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-gettxoutproof.md @@ -1,6 +1,7 @@ --- title: "gettxoutproof" slug: "rpc-bch-gettxoutproof" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-sendrawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-sendrawtransaction.md index 1dc904a9..a28b6437 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-sendrawtransaction.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-sendrawtransaction.md @@ -1,6 +1,7 @@ --- title: "sendrawtransaction" slug: "rpc-bch-sendrawtransaction" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-validateaddress.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-validateaddress.md index 4f50e4f5..f5febdf5 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-validateaddress.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-validateaddress.md @@ -1,6 +1,7 @@ --- title: "validateaddress" slug: "rpc-bch-validateaddress" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-verifymessage.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-verifymessage.md index f9c22b14..27d622ec 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-verifymessage.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-verifymessage.md @@ -1,6 +1,7 @@ --- title: "verifymessage" slug: "rpc-bch-verifymessage" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-verifytxoutproof.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-verifytxoutproof.md index 368df355..a2eea6b8 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-verifytxoutproof.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-bch-verifytxoutproof.md @@ -1,6 +1,7 @@ --- title: "verifytxoutproof" slug: "rpc-bch-verifytxoutproof" +category: "6620f7e31ea673003624a8cc" excerpt: "BCH RPC" hidden: false metadata: diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum.md b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-rostrum.md similarity index 97% rename from v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-rostrum.md index d69f5c5e..52f1a40f 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rostrum.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-bch/rpc-rostrum.md @@ -1,6 +1,6 @@ --- title: "Rostrum" -slug: "rostrum" +slug: "rpc-rostrum" category: "6620f7e31ea673003624a8cc" excerpt: "" hidden: false diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc.md similarity index 99% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc.md index a49f8d15..1f4d0d9c 100644 --- a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-btc.md @@ -1,6 +1,6 @@ --- title: "Bitcoin" -slug: "bitcoin-1" +slug: "rpc-btc" excerpt: "" hidden: false createdAt: "Wed Mar 06 2024 10:39:28 GMT+0000 (Coordinated Universal Time)" diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getbestblockhash.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getbestblockhash.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getbestblockhash.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getbestblockhash.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblock.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblock.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblock.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblock.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockchaininfo.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockchaininfo.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockchaininfo.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockchaininfo.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockcount.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockcount.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockcount.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockcount.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockhash.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockhash.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockhash.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockhash.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockheader.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockheader.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockheader.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockheader.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockstats.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockstats.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getblockstats.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getblockstats.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getchaintips.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getchaintips.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getchaintips.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getchaintips.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getdifficulty.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getdifficulty.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getdifficulty.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getdifficulty.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getmempoolancestors.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getmempoolancestors.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getmempoolancestors.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getmempoolancestors.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getmempooldescendants.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getmempooldescendants.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getmempooldescendants.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getmempooldescendants.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getmempoolentry.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getmempoolentry.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getmempoolentry.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getmempoolentry.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getmempoolinfo.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getmempoolinfo.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getmempoolinfo.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getmempoolinfo.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getrawmempool.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getrawmempool.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-getrawmempool.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-getrawmempool.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-gettxout.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-gettxout.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-gettxout.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-gettxout.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-gettxoutproof.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-gettxoutproof.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-gettxoutproof.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-gettxoutproof.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-validateaddress.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-validateaddress.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-validateaddress.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-validateaddress.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-verifymessage.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-verifymessage.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-verifymessage.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-verifymessage.md diff --git a/v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-verifytxoutproof.md b/v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-verifytxoutproof.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/bitcoin-1/rpc-btc-verifytxoutproof.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-btc/rpc-btc-verifytxoutproof.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin.md similarity index 97% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin.md index 5f7a6da7..60d24998 100644 --- a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin.md @@ -1,6 +1,6 @@ --- title: "Dogecoin" -slug: "rpc-degecoin" +slug: "rpc-dogecoin" excerpt: "" hidden: false createdAt: "Wed Mar 06 2024 10:39:28 GMT+0000 (Coordinated Universal Time)" diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-createrawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-createrawtransaction.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-createrawtransaction.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-createrawtransaction.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-decoderawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-decoderawtransaction.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-decoderawtransaction.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-decoderawtransaction.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-decodescript.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-decodescript.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-decodescript.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-decodescript.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-estimatesmartfee.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-estimatesmartfee.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-estimatesmartfee.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-estimatesmartfee.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getbestblockhash.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getbestblockhash.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getbestblockhash.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getbestblockhash.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblock.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblock.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblock.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblock.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblockchaininfo.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblockchaininfo.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblockchaininfo.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblockchaininfo.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblockcount.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblockcount.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblockcount.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblockcount.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblockhash.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblockhash.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblockhash.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblockhash.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblockheader.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblockheader.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getblockheader.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getblockheader.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getchaintips.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getchaintips.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getchaintips.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getchaintips.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getdifficulty.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getdifficulty.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getdifficulty.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getdifficulty.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getmempoolancestors.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getmempoolancestors.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getmempoolancestors.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getmempoolancestors.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getmempooldescendants.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getmempooldescendants.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getmempooldescendants.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getmempooldescendants.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getmempoolentry.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getmempoolentry.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getmempoolentry.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getmempoolentry.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getmempoolinfo.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getmempoolinfo.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getmempoolinfo.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getmempoolinfo.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getrawmempool.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getrawmempool.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getrawmempool.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getrawmempool.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getrawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getrawtransaction.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-getrawtransaction.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-getrawtransaction.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-gettxout.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-gettxout.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-gettxout.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-gettxout.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-gettxoutproof.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-gettxoutproof.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-gettxoutproof.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-gettxoutproof.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-sendrawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-sendrawtransaction.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-sendrawtransaction.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-sendrawtransaction.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-validateaddress.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-validateaddress.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-validateaddress.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-validateaddress.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-verifymessage.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-verifymessage.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-verifymessage.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-verifymessage.md diff --git a/v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-verifytxoutproof.md b/v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-verifytxoutproof.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/rpc-degecoin/rpc-dogecoin-verifytxoutproof.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-dogecoin/rpc-dogecoin-verifytxoutproof.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash.md similarity index 95% rename from v1.0/RPC Nodes/rpc-utxo/zcash.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash.md index f15bfce0..e195cfa0 100644 --- a/v1.0/RPC Nodes/rpc-utxo/zcash.md +++ b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash.md @@ -1,6 +1,6 @@ --- title: "Zcash" -slug: "zcash" +slug: "rpc-zcash" excerpt: "" hidden: false createdAt: "Sat Apr 06 2024 07:33:40 GMT+0000 (Coordinated Universal Time)" diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-createrawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-createrawtransaction.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-createrawtransaction.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-createrawtransaction.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-decoderawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-decoderawtransaction.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-decoderawtransaction.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-decoderawtransaction.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-decodescript.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-decodescript.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-decodescript.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-decodescript.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-estimatesmartfee.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-estimatesmartfee.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-estimatesmartfee.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-estimatesmartfee.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getbestblockhash.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getbestblockhash.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getbestblockhash.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getbestblockhash.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblock.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblock.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblock.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblock.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockchaininfo.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockchaininfo.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockchaininfo.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockchaininfo.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockcount.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockcount.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockcount.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockcount.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockhash.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockhash.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockhash.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockhash.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockheader.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockheader.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockheader.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockheader.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockstats.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockstats.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getblockstats.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getblockstats.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getchaintips.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getchaintips.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getchaintips.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getchaintips.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getdifficulty.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getdifficulty.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getdifficulty.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getdifficulty.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getmempoolancestors.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getmempoolancestors.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getmempoolancestors.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getmempoolancestors.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getmempooldescendants.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getmempooldescendants.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getmempooldescendants.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getmempooldescendants.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getmempoolentry.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getmempoolentry.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getmempoolentry.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getmempoolentry.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getmempoolinfo.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getmempoolinfo.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getmempoolinfo.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getmempoolinfo.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getrawmempool.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getrawmempool.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getrawmempool.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getrawmempool.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getrawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getrawtransaction.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-getrawtransaction.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-getrawtransaction.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-gettxout.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-gettxout.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-gettxout.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-gettxout.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-gettxoutproof.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-gettxoutproof.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-gettxoutproof.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-gettxoutproof.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-sendrawtransaction.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-sendrawtransaction.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-sendrawtransaction.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-sendrawtransaction.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-validateaddress.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-validateaddress.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-validateaddress.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-validateaddress.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-verifymessage.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-verifymessage.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-verifymessage.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-verifymessage.md diff --git a/v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-verifytxoutproof.md b/v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-verifytxoutproof.md similarity index 100% rename from v1.0/RPC Nodes/rpc-utxo/zcash/rpc-zcash-verifytxoutproof.md rename to v1.0/RPC Nodes/rpc-utxo/rpc-zcash/rpc-zcash-verifytxoutproof.md