diff --git a/v1.0/RPC Nodes/others/rpc-solana/getaccountinfo.md b/v1.0/RPC Nodes/others/rpc-solana/getaccountinfo.md deleted file mode 100644 index 4f210f59..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getaccountinfo.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "getaccountinfo" -slug: "rpc-solana-getaccountinfo" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getAccountInfo('ChkH4bTk7c5NSGbxvXx89yY2oU7rFJsr3Cq1gPNCCPVe') - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getAccountInfo` RPC method is used to fetch and retrieve specific and detailed information about a particular account on the Solana blockchain. This information includes the current state of the account, its associated data, and the account's current balance. - -This method could be used in scenarios where detailed account data is required, for example, to verify transactions, check account balances, or to review the account's history. - -{% embed url="https://codepen.io/tatum-devrel/pen/gOQErrY" %} - -### Parameters - -The `getAccountInfo` method accepts two parameters: - -* `accountPubkey`(string, required): The public key of the account for which information is to be fetched. - * Example: `"ChkH4bTk7c5NSGbxvXx89yY2oU7rFJsr3Cq1gPNCCPVe"` -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - * `encoding` (string, optional): Encoding format for Account data - * Values: `base58` `base64` `base64+zstd` `jsonParsed` - -### Return object - -The `getAccountInfo` method returns an object containing the following fields: - -* `context`: An object containing details about the context in which the account information was fetched. - * `slot`: The slot at which the data was fetched. -* `value`: An object containing the account's information. - * `owner`: The public key of the account's owner. - * `lamports`: The account's current balance. - * `data`: data associated with the account, either as encoded binary data or JSON format `{: }` - depending on encoding parameter - * `executable`: Whether the account is marked as executable. - * `rentEpoch`: The rent epoch value of the account. - * `size`: The data size of the account - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getAccountInfo", - "params": [ - "ChkH4bTk7c5NSGbxvXx89yY2oU7rFJsr3Cq1gPNCCPVe", - { - "commitment": "finalized", - "encoding": "base64" - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "result": { - "context": { - "slot": 123456 - }, - "value": { - "owner": "Base58('11111111111111111111111111111111')", - "lamports": 1000000, - "data": "Base64('...')", - "executable": false, - "rentEpoch": 20, - "size": 120 - } - } -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getbalance.md b/v1.0/RPC Nodes/others/rpc-solana/getbalance.md deleted file mode 100644 index f1d90a1e..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getbalance.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: "getbalance" -slug: "rpc-solana-getbalance" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getBalance('8Ew6iQXcTRHAUNNu3X9VBn1g1bJkXEZJ9gFD2AGKtdPB') - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getBalance` RPC method is used to retrieve the current balance of a specified account on the Solana blockchain. It's a straightforward and efficient way to monitor and keep track of account balances. - -This method is typically used in scenarios where you need to check the available balance before initiating a transaction or for accounting purposes in a wallet application. - -### Parameters - -The `getBalance` method requires one parameter: - -* (string, required) Pubkey of account to query, as base-58 encoded string - * Example: `"8Ew6iQXcTRHAUNNu3X9VBn1g1bJkXEZJ9gFD2AGKtdPB"` - -### Return object - -The `getBalance` method returns an object containing the following fields: - -* `context`: An object containing details about the context in which the balance was fetched. - * `slot`: The slot at which the data was fetched. -* `value`: The current balance of the account, in lamports. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getBalance", - "params": [ - "8Ew6iQXcTRHAUNNu3X9VBn1g1bJkXEZJ9gFD2AGKtdPB", - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "result": { - "context": { - "slot": 194573649 - }, - "value": 2484257209 - } -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getblock.md b/v1.0/RPC Nodes/others/rpc-solana/getblock.md deleted file mode 100644 index 348ffaf8..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getblock.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: "getblock" -slug: "rpc-solana-getblock" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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] - - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const slotNumber = 430 - -const config = { - encoding: "jsonParsed", - transactionDetails: "full", - rewards: false, - maxSupportedTransactionVersion: 0, -} - -const res = await tatum.rpc.getBlock(slotNumber, config) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getBlock` method returns identity and transaction information about a confirmed block in the ledger. It provides detailed data about each transaction within the block, including pre and post transaction balances, transaction status, fees charged, and more. - -This method is essential for blockchain explorers or any application that needs to track and represent blockchain transaction data. For instance, it could be used by a wallet application to show transaction details or by a network analytics tool for data gathering and analysis. - -{% embed url="https://codepen.io/tatum-devrel/pen/wvQOzGR" %} - -### Parameters - -This method takes the following parameters: - -* `slot` (number, required): Slot number -* `options` (object, optional): This object can contain the following fields: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `encoding` (string, optional): Encoding format for each returned transaction. The default is `json`. Other possible values include: `jsonParsed`, `base58`, `base64`. - * `transactionDetails` (string, optional): Level of transaction detail to return. The default is `full`. Other possible values include: `accounts`, `signatures`, `none`. - * `maxSupportedTransactionVersion` (number, optional): The max transaction version to return in responses. - * `rewards` (bool, optional): Whether to populate the `rewards` array. The default includes rewards. - -### Return Object - -The method returns a JSON object that includes detailed information about the block and the transactions it contains. If the specified block is not confirmed, the result will be `null`. - -The returned JSON object includes the following fields: - -* `blockhash`: The blockhash of this block, as base-58 encoded string. -* `previousBlockhash`: The blockhash of this block's parent, as base-58 encoded string. If the parent block is not available due to ledger cleanup, this field will return "11111111111111111111111111111111". -* `parentSlot`: The slot index of this block's parent. -* `transactions`: An array of JSON objects containing detailed transaction information. This field is present if "full" transaction details are requested. - * `transaction:` Transaction object, either in JSON format or encoded binary data, depending on encoding parameter - * `meta:` Transaction status metadata object, containing `null` or: - * `err:` Error if transaction failed, null if transaction succeeded. TransactionError definitions - * `fee:` Fee this transaction was charged, as u64 integer - * `preBalances:` Array of numbers representing account balances from before the transaction was processed - * `postBalances:` Array of numbers representing account balances after the transaction was processed - * `innerInstructions:` List of inner instructions or `null` if inner instruction recording was not enabled during this transaction - * `preTokenBalances:` List of token balances from before the transaction was processed or omitted if token balance recording was not yet enabled during this transaction - * `postTokenBalances:` List of token balances from after the transaction was processed or omitted if token balance recording was not yet enabled during this transaction - * `logMessages:` Array of string log messages or `null` if log message recording was not enabled during this transaction - * `rewards:` Transaction-level rewards, populated if rewards are requested; an array of JSON objects containing: - * `pubkey:` The public key, as base-58 encoded string, of the account that received the reward - * `lamports:` Number of reward lamports credited or debited by the account - * `postBalance:` Account balance in lamports after the reward was applied - * `rewardType:` Type of reward: "fee", "rent", "voting", "staking" - * `commission:` Vote account commission when the reward was credited, only present for voting and staking rewards - * DEPRECATED: `status:` Transaction status - * `"Ok":` Transaction was successful - * `"Err":` Transaction failed with TransactionError - * `loadedAddresses:` Transaction addresses loaded from address lookup tables. Undefined if `maxSupportedTransactionVersion` is not set in request params. - * `writable:` Ordered list of base-58 encoded addresses for writable loaded accounts - * `readonly:`Ordered list of base-58 encoded addresses for readonly loaded accounts - * `returnData:` The most-recent return data generated by an instruction in the transaction, with the following fields: - * `programId:` The program that generated the return data, as base-58 encoded Pubkey - * `data:` The return data itself, as base-64 encoded binary data - * `computeUnitsConsumed:` Number of compute units consumed by the transaction - * `version:` Transaction version. Undefined if `maxSupportedTransactionVersion` is not set in request params. -* `signatures`: An array of signatures strings, corresponding to the transaction order in the block. This field is present if "signatures" are requested for transaction details. -* `rewards`: Block-level rewards, present if rewards are requested. -* `blockTime`: Estimated production time, as Unix timestamp (seconds since the Unix epoch). -* `blockHeight`: The number of blocks beneath this block. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getBlock", - "params": [ - 430, - { - "encoding": "json", - "maxSupportedTransactionVersion": 0, - "transactionDetails": "full", - "rewards": false - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "blockHeight": 428, - "blockTime": null, - "blockhash": "3Eq21vXNB5s86c62bVuUfTeaMif1N2kUqRPBmGRJhyTA", - "parentSlot": 429, - "previousBlockhash": "mfcyqEXB3DnHXki6KjjmZck6YjmZLvpAByy2fj4nh6B", - "transactions": [ - { - "meta": { - "err": null, - "fee": 5000, - "innerInstructions": [], - "logMessages": [], - "postBalances": [499998932500, 26858640, 1, 1, 1], - "postTokenBalances": [], - "preBalances": [499998937500, 26858640, 1, 1, 1], - "preTokenBalances": [], - "rewards": null, - "status": { - "Ok": null - } - }, - "transaction": { - "message": { - "accountKeys": [ - "3UVYmECPPMZSCqWKfENfuoTv51fTDTWicX9xmBD2euKe", - "AjozzgE83A3x1sHNUR64hfH7zaEBWeMaFuAN9kQgujrc", - "SysvarS1otHashes111111111111111111111111111", - "SysvarC1ock11111111111111111111111111111111", - "Vote111111111111111111111111111111111111111" - ], - "header": { - "numReadonlySignedAccounts": 0, - "numReadonlyUnsignedAccounts": 3, - "numRequiredSignatures": 1 - }, - "instructions": [ - { - "accounts": [1, 2, 3, 0], - "data": "37u9WtQpcm6ULa3WRQHmj49EPs4if7o9f1jSRVZpm2dvihR9C8jY4NqEwXUbLwx15HBSNcP1", - "programIdIndex": 4 - } - ], - "recentBlockhash": "mfcyqEXB3DnHXki6KjjmZck6YjmZLvpAByy2fj4nh6B" - }, - "signatures": [ - "2nBhEBYYvfaAe16UMNqRHre4YNSskvuYgx3M6E4JP1oDYvZEJHvoPzyUidNgNX5r9sTyN1J9UxtbCXy2rqYcuyuv" - ] - } - } - ] - }, - "id": 1 -}js -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getblockcommitment.md b/v1.0/RPC Nodes/others/rpc-solana/getblockcommitment.md deleted file mode 100644 index f0c2314e..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getblockcommitment.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "getblockcommitment" -slug: "rpc-solana-getblockcommitment" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getBlockCommitment(5) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getBlockCommitment` method returns the commitment for a particular block. Commitment in Solana refers to the amount of cluster stake in lamports that has voted on the block at each depth from 0 to `MAX_LOCKOUT_HISTORY` + 1. - -This method is crucial for understanding the level of consensus or agreement about a block in the network, as it indicates how much of the network's total stake has confirmed the block. It can be used by blockchain explorers to show the confirmation status of transactions and by network monitors to track the progress of the blockchain. - -{% embed url="https://codepen.io/tatum-devrel/pen/QWJoKEX" %} - -### Parameters - -This method takes the following parameter: - -* `number` (required): The block number, identified by Slot. - -### Return Object - -The method returns a JSON object that includes detailed information about the block's commitment and the total active stake in the current epoch. If the specified block is not known, the `commitment` field will be `null`. - -The returned JSON object includes the following fields: - -* `commitment`: Commitment, comprising either: - * `` - Unknown block. - * `` - Commitment, an array of integers logging the amount of cluster stake in lamports that has voted on the block at each depth from 0 to `MAX_LOCKOUT_HISTORY` + 1. -* `totalStake`: The total active stake, in lamports, of the current epoch. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getBlockCommitment", - "params": [5] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "commitment": [ - 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, - 0, 0, 0, 0, 0, 10, 32 - ], - "totalStake": 42 - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getblockheight.md b/v1.0/RPC Nodes/others/rpc-solana/getblockheight.md deleted file mode 100644 index 05ee3de6..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getblockheight.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "getblockheight" -slug: "rpc-solana-getblockheight" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getBlockHeight() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getBlockHeight` method returns the current block height of the node. Block height refers to the number of blocks preceding the current one in the blockchain. - -This method is beneficial for understanding the current status of the blockchain, as it provides the most recent block number processed by the node. It can be used for monitoring the progress of the blockchain, troubleshooting node synchronisation issues, and determining the confirmation status of a transaction by comparing its block number with the current block height. - -{% embed url="https://codepen.io/tatum-devrel/pen/ZEmPppb?editors=1111" %} - -### Parameters - -`options` (object, optional): This object can contain the following fields: - -* `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` -* `minContextSlot` (number, optional): This field can be used to specify the minimum slot that the request can be evaluated at. - -### Return Object - -The method returns a single number, representing the current block height. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "method":"getBlockHeight" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": 1233, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getblockproduction.md b/v1.0/RPC Nodes/others/rpc-solana/getblockproduction.md deleted file mode 100644 index 693440ad..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getblockproduction.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "getblockproduction" -slug: "rpc-solana-getblockproduction" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getBlockProduction() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getBlockProduction` method provides information about the recent block production from the current or previous epoch. This can be used to monitor the performance and activity of validators on the Solana network. - -{% embed url="https://codepen.io/tatum-devrel/pen/QWJoKde?editors=1011" %} - -### Parameters - -* `options` (object, optional): This object can contain the following fields: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `identity` (string, optional): Only return results for this validator identity (base-58 encoded). - * `range` (object, optional): Slot range to return block production for. - * `firstSlot` (number): First slot to return block production information for (inclusive). - * `lastSlot` (number, optional): Last slot to return block production information for (inclusive). - -### Return Object - -The result will be a JSON object with value equal to object with the following fields: - -* `byIdentity` (object): A dictionary of validator identities, as base-58 encoded strings. The value is a two-element array containing the number of leader slots and the number of blocks produced. -* `range` (object): Block production slot range with fields `firstSlot` and `lastSlot` indicating the first and last slot of block production information respectively. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getBlockProduction" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 9887 - }, - "value": { - "byIdentity": { - "85iYT5RuzRTDgjyRa3cP8SYhM2j21fj7NhfJ3peu1DPr": [9888, 9886] - }, - "range": { - "firstSlot": 0, - "lastSlot": 9887 - } - } - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getblocks.md b/v1.0/RPC Nodes/others/rpc-solana/getblocks.md deleted file mode 100644 index 39a46f18..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getblocks.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "getblocks" -slug: "rpc-solana-getblocks" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getBlocks(5,10) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getBlocks` method returns a list of confirmed blocks between two specified slots. This can be useful when needing to examine a specific range of blocks for transaction analysis, data verification, or other blockchain analysis tasks. - -### Parameters - -* `endSlot` (number, required): This is the upper limit of the slot range from which blocks are to be returned. -* `startSlot` (number, optional): This is the lower limit of the slot range. If not provided, the method will return blocks from the start of the blockchain to the `endSlot`. Note that `startSlot` must be no more than 500,000 blocks lower than the `end_slot`. -* `options` (object, optional): This object can contain the following fields: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` Note that `processed` is not supported. - -### Return Object - -The method returns an array of integers, each representing a confirmed block between `startSlot` and either `endSlot` (if provided) or the latest confirmed block, inclusive. The maximum range allowed is 500,000 slots. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getBlocks", - "params": [5, 10] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": [5, 6, 7, 8, 9, 10], - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getblockswithlimit.md b/v1.0/RPC Nodes/others/rpc-solana/getblockswithlimit.md deleted file mode 100644 index c7663508..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getblockswithlimit.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "getblockswithlimit" -slug: "rpc-solana-getblockswithlimit" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getBlocksWithLimit(5, 3) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getBlocksWithLimit` method returns a list of confirmed blocks starting at a given slot and up to a specified limit. This can be helpful when you need to retrieve a specific number of recent blocks for transaction analysis or blockchain data verification purposes. - -### Parameters - -This method requires and optionally accepts the following parameters: - -* `startSlot` (number, required): This is the slot from which the method will start returning blocks. -* `limit` (number, optional): This is the number of blocks to be returned starting from the `startSlot`. If not provided, the method will return all blocks from the `startSlot` to the end of the blockchain. Note that `limit` must be no more than 500,000 blocks higher than the `startSlot`. -* `options` (object, optional): This object can contain the following fields: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` Note that `processed` is not supported. - -### Return Object - -The method returns an array of integers, each representing a confirmed block starting from the `startSlot` and up to the `limit` blocks, inclusive. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id":1, - "method":"getBlocksWithLimit", - "params":[5, 3] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": [5, 6, 7], - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getblocktime.md b/v1.0/RPC Nodes/others/rpc-solana/getblocktime.md deleted file mode 100644 index 7a0ac61d..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getblocktime.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "getblocktime" -slug: "rpc-solana-getblocktime" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getBlockTime(5) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getBlockTime` method returns the estimated production time of a block. Each validator in the Solana network reports their UTC time to the ledger at regular intervals by intermittently adding a timestamp to a vote for a specific block. A requested block's time is then calculated from the stake-weighted mean of these vote timestamps recorded on the ledger in a set of recent blocks. - -This method is useful in understanding when a particular block was produced, which is essential for various analysis and audit purposes. - -{% embed url="https://codepen.io/tatum-devrel/pen/bGQZwRy?editors=1111" %} - -### Parameters - -* `blockNumber` (number, required): This is the number of the block for which you want to retrieve the production time. The block number is identified by its slot. - -### Return Object - -The method returns an integer or null: - -* If the production time of the block is available, the method returns the estimated production time as a Unix timestamp (seconds since the Unix epoch). -* If the production time of the block is not available, the method returns null. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", "id":1, - "method": "getBlockTime", - "params":[5] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": 1574721591, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getclusternodes.md b/v1.0/RPC Nodes/others/rpc-solana/getclusternodes.md deleted file mode 100644 index 6c96aabc..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getclusternodes.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "getclusternodes" -slug: "rpc-solana-getclusternodes" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getClusterNodes() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getClusterNodes` method returns information about all the nodes participating in the cluster. This method can be used for network analysis, monitoring, and audit purposes. For example, you can use it to track the versions of software running on various nodes, identify the public keys of nodes, or determine the network addresses for various services. - -{% embed url="https://codepen.io/tatum-devrel/pen/YzRgGjO" %} - -### Parameters - -This method does not require any parameters. - -### Return Object - -The method returns an array of JSON objects, each containing the following fields: - -* `pubkey`: Node's public key, as base-58 encoded string. -* `gossip`: Gossip network address for the node. -* `tpu`: TPU network address for the node. -* `rpc`: JSON RPC network address for the node, or `null` if the JSON RPC service is not enabled. -* `version`: The software version of the node, or `null` if the version information is not available. -* `featureSet`: The unique identifier of the node's feature set. -* `shredVersion`: The shred version the node has been configured to use. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getClusterNodes" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": [ - { - "gossip": "10.239.6.48:8001", - "pubkey": "9QzsJf7LPLj8GkXbYT3LFDKqsj2hHG7TA3xinJHu8epQ", - "rpc": "10.239.6.48:8899", - "tpu": "10.239.6.48:8856", - "version": "1.0.0 c375ce1f" - } - ], - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getepochinfo.md b/v1.0/RPC Nodes/others/rpc-solana/getepochinfo.md deleted file mode 100644 index 206a76f3..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getepochinfo.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "getepochinfo" -slug: "rpc-solana-getepochinfo" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getEpochInfo() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getEpochInfo` method returns information about the current epoch on the Solana network. This includes the current slot, block height, epoch number, slot index, the number of slots in this epoch, and the total number of transactions processed without error since genesis. This data can be essential for developers and operators of Solana nodes to understand the current state of the network and to track its progress over time. - -{% embed url="https://codepen.io/tatum-devrel/pen/JjezRzL" %} - -### Parameters - -* `options` (object, optional): A configuration object containing: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at. - -### Return Object - -The result field will be an object with the following fields: - -* `absoluteSlot`: The current slot. -* `blockHeight`: The current block height. -* `epoch`: The current epoch. -* `slotIndex`: The current slot relative to the start of the current epoch. -* `slotsInEpoch`: The number of slots in this epoch. -* `transactionCount`: Total number of transactions processed without error since genesis. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "method":"getEpochInfo" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "absoluteSlot": 166598, - "blockHeight": 166500, - "epoch": 27, - "slotIndex": 2790, - "slotsInEpoch": 8192, - "transactionCount": 22661093 - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getepochschedule.md b/v1.0/RPC Nodes/others/rpc-solana/getepochschedule.md deleted file mode 100644 index f1a34d2f..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getepochschedule.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "getepochschedule" -slug: "rpc-solana-getepochschedule" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getEpochSchedule() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getEpochSchedule` method returns the epoch schedule information from this cluster's genesis config. This includes the maximum number of slots in each epoch, the number of slots before the beginning of an epoch to calculate a leader schedule for that epoch, whether epochs start short and grow, the first normal-length epoch, and the first normal slot. This data can be useful for planning and understanding the progression of epochs in the Solana network. - -{% embed url="https://codepen.io/Night-Shift-Dev/pen/XWyKMyP" %} -Try this Feature -{% endembed %} - -### Parameters - -None - -### Return Object - -The result field will be an object with the following fields: - -* `slotsPerEpoch`: The maximum number of slots in each epoch. -* `leaderScheduleSlotOffset`: The number of slots before beginning of an epoch to calculate a leader schedule for that epoch. -* `warmup`: Whether epochs start short and grow. -* `firstNormalEpoch`: The first normal-length epoch, log2(slotsPerEpoch) - log2(MINIMUM\_SLOTS\_PER\_EPOCH). -* `firstNormalSlot`: MINIMUM\_SLOTS\_PER\_EPOCH \* (2.pow(firstNormalEpoch) - 1). - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "method":"getEpochSchedule" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "firstNormalEpoch": 8, - "firstNormalSlot": 8160, - "leaderScheduleSlotOffset": 8192, - "slotsPerEpoch": 8192, - "warmup": true - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getfeeformessage.md b/v1.0/RPC Nodes/others/rpc-solana/getfeeformessage.md deleted file mode 100644 index b102aa8e..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getfeeformessage.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "getfeeformessage" -slug: "rpc-solana-getfeeformessage" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const message = { - // Message content goes here... -} -const res = await tatum.rpc.getFeeForMessage(message) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getFeeForMessage` method is used to estimate the transaction fee for a given message. This is very useful when you are preparing to send a transaction and you want to estimate the transaction cost. This can be used in situations where you need to validate whether a user has enough funds to cover the transaction fee or to provide an estimate of the cost to the user. - -### Parameters - -* `message`(string, required): Base-64 encoded Message for which the fee should be estimated. - * Example: "`AQABAgIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQAA`" -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at - * Example: `1000` - -### Return Object - -The result will be a JSON object with `value` equal to Fee corresponding to the message at the specified blockhash - -### JSON-RPC Request Example - -```json -{ - "id":1, - "jsonrpc":"2.0", - "method":"getFeeForMessage", - "params":[ - "AQABAgIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQAA", - { - "commitment":"processed" - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { "context": { "slot": 5068 }, "value": 5000 }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getfirstavailableblock.md b/v1.0/RPC Nodes/others/rpc-solana/getfirstavailableblock.md deleted file mode 100644 index 9f843330..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getfirstavailableblock.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "getfirstavailableblock" -slug: "rpc-solana-getfirstavailableblock" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getFirstAvailableBlock() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getFirstAvailableBlock` method returns the slot of the lowest confirmed block that has not been purged from the ledger. This method is useful when you want to start parsing the ledger from the oldest available data, or when you want to check how far back the data in your node goes. This can be critical in scenarios where historical block data is required for backtracking transactions or auditing purposes. - -{% embed url="https://codepen.io/tatum-devrel/pen/MWzxjvK" %} - -### Parameters - -This method does not require any parameters. - -### Return Object - -The method returns an integer representing the slot of the oldest confirmed block that has not been purged from the ledger. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "method":"getFirstAvailableBlock" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": 250000, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getgenesishash.md b/v1.0/RPC Nodes/others/rpc-solana/getgenesishash.md deleted file mode 100644 index 45e6b870..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getgenesishash.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "getgenesishash" -slug: "rpc-solana-getgenesishash" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getGenesisHash() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getGenesisHash` method returns the genesis hash of the Solana network. The genesis hash is an important piece of information in the blockchain world. It is the initial block or the very first block in a blockchain. The genesis hash can be used for various use cases such as to verify the integrity of data, as a reference point in the blockchain, and for debugging purposes. - -{% embed url="https://codepen.io/tatum-devrel/pen/qBQvaVV" %} - -### Parameters - -None - -### Return Object - -* Returns a string, which is a Hash as base-58 encoded string. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "method":"getGenesisHash" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": "GH7ome3EiwEr7tu9JuTh2dpYWBJK3z69Xm1ZE3MEE6JC", - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/gethealth.md b/v1.0/RPC Nodes/others/rpc-solana/gethealth.md deleted file mode 100644 index 93b4db79..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/gethealth.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "gethealth" -slug: "rpc-solana-gethealth" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getHealth() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getHealth` method is used to monitor the current health of the node. This method can be beneficial for maintenance and troubleshooting purposes. For instance, you may use this method to check the health status of your node periodically or to validate if a newly set up node is functioning correctly. - -Please note that if one or more `--known-validator` arguments are provided to `solana-validator`, "ok" is returned when the node is within `HEALTH_CHECK_SLOT_DISTANCE` slots of the highest known validator; otherwise, an error is returned. If no known validators are provided, "ok" is always returned. - -{% embed url="https://codepen.io/tatum-devrel/pen/QWJoKVb" %} - -### Parameters - -This method does not require any parameters. - -### Return Object - -If the node is healthy, it returns "ok". If the node is unhealthy, a JSON RPC error response is returned. The specifics of the error response are unstable and may change in the future. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getHealth" -} -``` - -### JSON-RPC Response Examples - -* Healthy node response: - - ```json - { "jsonrpc": "2.0", "result": "ok", "id": 1 } - ``` -* Unhealthy node response (generic): - - ```json - { - "jsonrpc": "2.0", - "error": { - "code": -32005, - "message": "Node is unhealthy", - "data": {} - }, - "id": 1 - } - ``` -* Unhealthy node response (if additional information is available): - - ```json - { - "jsonrpc": "2.0", - "error": { - "code": -32005, - "message": "Node is behind by 42 slots", - "data": { - "numSlotsBehind": 42 - } - }, - "id": 1 - } - ``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/gethighestsnapshotslot.md b/v1.0/RPC Nodes/others/rpc-solana/gethighestsnapshotslot.md deleted file mode 100644 index 01688837..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/gethighestsnapshotslot.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "gethighestsnapshotslot" -slug: "rpc-solana-gethighestsnapshotslot" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getHighestSnapshotSlot() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getHighestSnapshotSlot` method provides the highest slot information for which the node has snapshots. It determines the highest full snapshot slot and, if available, the highest incremental snapshot slot based on the full snapshot slot. - -This method can be used in a variety of scenarios, including managing data storage and synchronisation of blockchain data. By knowing the highest snapshot slot, developers can estimate the amount of data that needs to be downloaded to sync a new node, or to ensure the node is up to date with the current state of the blockchain. - -{% embed url="https://codepen.io/tatum-devrel/pen/MWzxjEK" %} - -### Parameters - -None - -### Return Object - -When the node has a snapshot, this method returns a JSON object with the following fields: - -* `full`: The highest full snapshot slot. -* `incremental`: The highest incremental snapshot slot based on the full snapshot slot, if available. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "method":"getHighestSnapshotSlot" -} -``` - -### JSON-RPC Response Example - -Here is an example response when the node has a snapshot: - -```json -{ - "jsonrpc": "2.0", - "result": { - "full": 100, - "incremental": 110 - }, - "id": 1 -} -``` - -In case the node does not have a snapshot, the response would be: - -```json -{ - "jsonrpc": "2.0", - "error": { "code": -32008, "message": "No snapshot" }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getidentity.md b/v1.0/RPC Nodes/others/rpc-solana/getidentity.md deleted file mode 100644 index e4e85495..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getidentity.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "getidentity" -slug: "rpc-solana-getidentity" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getIdentity() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getIdentity` method is used to retrieve the identity pubkey for the current node. This pubkey represents a unique identifier for the node in the Solana network. - -Use cases for this method might include retrieving the identity of a node for tracking or monitoring purposes, or validating the identity of a node in scenarios where only certain nodes are trusted for certain operations. - -{% embed url="https://codepen.io/tatum-devrel/pen/PoxLGdg" %} - -### Parameters - -This method does not require any parameters. - -### Return Object - -The result field will be a JSON object with the following fields: - -* `identity`: The identity pubkey of the current node as a base-58 encoded string. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getIdentity" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "identity": "2r1F4iWqVcb8M1DbAjQuFpebkQHY9hcVU4WuW2DJBppN" - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getinflationgovernor.md b/v1.0/RPC Nodes/others/rpc-solana/getinflationgovernor.md deleted file mode 100644 index a2da7bbc..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getinflationgovernor.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "getinflationgovernor" -slug: "rpc-solana-getinflationgovernor" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getInflationGovernor() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getInflationGovernor` method is used to retrieve the current inflation governor in the Solana blockchain. - -{% embed url="https://codepen.io/tatum-devrel/pen/rNQRMVO?editors=1011" %} - -### Parameters - -* `options` (object, optional): Configuration object containing the following fields: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - -### Return Object - -The method returns a JSON object with the following fields: - -* `initial`: The initial inflation percentage from time 0. -* `terminal`: Terminal inflation percentage. -* `taper`: Rate per year at which inflation is lowered. The rate reduction is derived using the target slot time in the genesis config. -* `foundation`: Percentage of total inflation allocated to the foundation. -* `foundationTerm`: Duration of foundation pool inflation in years. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getInflationGovernor" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "foundation": 0.05, - "foundationTerm": 7, - "initial": 0.15, - "taper": 0.15, - "terminal": 0.015 - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getinflationrate.md b/v1.0/RPC Nodes/others/rpc-solana/getinflationrate.md deleted file mode 100644 index 8885bc51..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getinflationrate.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "getinflationrate" -slug: "rpc-solana-getinflationrate" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getInflationRate() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getInflationRate` method is used to retrieve the specific inflation values for the current epoch in the Solana blockchain. - -{% embed url="https://codepen.io/tatum-devrel/pen/vYQPXOp" %} - -### Parameters - -No parameters are required for this method. - -### Return Object - -The method returns a JSON object with the following fields: - -* `total`: Total inflation rate. -* `validator`: Inflation allocated to validators. -* `foundation`: Inflation allocated to the foundation. -* `epoch`: The epoch for which these values are valid. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getInflationRate" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "epoch": 100, - "foundation": 0.001, - "total": 0.149, - "validator": 0.148 - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getinflationreward.md b/v1.0/RPC Nodes/others/rpc-solana/getinflationreward.md deleted file mode 100644 index 7c26cdcb..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getinflationreward.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "getinflationreward" -slug: "rpc-solana-getinflationreward" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const addresses = ["Address1", "Address2", "Address3"] -const config = { - epoch: 2 -} - -const res = await tatum.rpc.getInflationReward(addresses, config) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getInflationReward` method returns the inflation or staking reward for a list of addresses for a particular epoch on the Solana blockchain. - -### Parameters - -* An array of addresses (array of strings, optional): These are the addresses to query, as base-58 encoded strings. -* A configuration object (optional): This object can contain the following fields: - * `commitment` (string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `epoch` (number, optional): An epoch for which the reward occurs. If omitted, the previous epoch will be used. - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at. - -### Return Object - -The method returns a JSON array where each object represents the reward details for the corresponding address in the input array. Each object has the following fields: - -* `epoch`: The epoch for which the reward occurred. -* `effectiveSlot`: The slot in which the rewards are effective. -* `amount`: The reward amount in lamports. -* `postBalance`: The post-balance of the account in lamports. -* `commission` : The vote account commission when the reward was credited. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getInflationReward", - "params": [ - [ - "6dmNQ5jwLeLk5REvio1JcMshcbvkYMwy26sJ8pbkvStu", - "BGsqMegLpV6n6Ve146sSX2dTjUMj3M92HnU8BbNRMhF2" - ], - {"epoch": 2} - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": [ - { - "amount": 2500, - "effectiveSlot": 224, - "epoch": 2, - "postBalance": 499999442500 - }, - null - ], - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getlargestaccounts.md b/v1.0/RPC Nodes/others/rpc-solana/getlargestaccounts.md deleted file mode 100644 index 8750ce08..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getlargestaccounts.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "getlargestaccounts" -slug: "rpc-solana-getlargestaccounts" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getLargestAccounts() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getLargestAccounts` method returns the 20 largest accounts by lamport balance. This method may cache results for up to two hours. - -### Parameters - -* `options` (object, optional): A configuration object containing: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `filter` (string, optional): Filters the results by account type. Possible values are `circulating` or `nonCirculating`. - -### Return Object - -The result field will be an `RpcResponse` JSON object with a `value` field equal to an array of objects, each containing: - -* `address`: Base-58 encoded address of the account. -* `lamports`: Number of lamports in the account. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getLargestAccounts" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 54 - }, - "value": [ - { - "lamports": 999974, - "address": "99P8ZgtJYe1buSK8JXkvpLh8xPsCFuLYhz9hQFNw93WJ" - }, - { - "lamports": 42, - "address": "uPwWLo16MVehpyWqsLkK3Ka8nLowWvAHbBChqv2FZeL" - }, - // ...additional accounts... - ] - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getlatestblockhash.md b/v1.0/RPC Nodes/others/rpc-solana/getlatestblockhash.md deleted file mode 100644 index 46bd4b69..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getlatestblockhash.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "getlatestblockhash" -slug: "rpc-solana-getlatestblockhash" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getLatestBlockhash({commitment: 'processed'}) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getLatestBlockhash` method returns the latest blockhash of the ledger. The blockhash is essential for transaction processing to ensure transaction uniqueness and to provide cryptographic security for the ledger. This method is critical in scenarios where the latest blockhash is needed for transaction signing or to confirm the most recent state of the blockchain. - -{% embed url="https://codepen.io/tatum-devrel/pen/eYQXdVd?editors=1111" %} - -### Parameters - -* `options` (object, optional): This object can contain the following fields: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at. - -### Return Object - -The method returns a `RpcResponse` JSON object with `value` field set to a JSON object including: - -* `blockhash`: The latest blockhash as a base-58 encoded string. -* `lastValidBlockHeight` : The last block height at which the blockhash will be valid. - -### JSON-RPC Request Example - -```json -{ - "id":1, - "jsonrpc":"2.0", - "method":"getLatestBlockhash", - "params":[ - { - "commitment":"processed" - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 2792 - }, - "value": { - "blockhash": "EkSnNWid2cvwEVnVx9aBqawnmiCNiDgp3gUdkDPTKN1N", - "lastValidBlockHeight": 3090 - } - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getleaderschedule.md b/v1.0/RPC Nodes/others/rpc-solana/getleaderschedule.md deleted file mode 100644 index 424ae111..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getleaderschedule.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "getleaderschedule" -slug: "rpc-solana-getleaderschedule" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getLeaderSchedule({ - identity: '4Qkev8aNZcqFNSRhQzwyLMFSsi94jHqE8WNVTJzTP99F' -}) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getLeaderSchedule` method returns the leader schedule for an epoch. This method is useful for understanding the rotation of leadership among the validators, which is key in maintaining a decentralized and secure network. The schedule can be fetched for a specific epoch, or for the current epoch if no parameter is specified. - -### Parameters - -* `slot` (number, optional): Fetch the leader schedule for the epoch that corresponds to the provided slot. If unspecified, the leader schedule for the current epoch is fetched. -* `options` (object, optional): A configuration object containing: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `identity` (string, optional): Only return results for this validator identity (base-58 encoded). - -### Return Object - -The method returns one of the two following values: - -* `null` - If requested epoch is not found. -* `object` - The result field will be a dictionary of validator identities, as base-58 encoded strings, and their corresponding leader slot indices as values (indices are relative to the first slot in the requested epoch). - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getLeaderSchedule", - "params": [ - null, - { - "identity": "4Qkev8aNZcqFNSRhQzwyLMFSsi94jHqE8WNVTJzTP99F" - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "4Qkev8aNZcqFNSRhQzwyLMFSsi94jHqE8WNVTJzTP99F": [ - 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, - 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, - 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, - 57, 58, 59, 60, 61, 62, 63 - ] - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getmaxretransmitslot.md b/v1.0/RPC Nodes/others/rpc-solana/getmaxretransmitslot.md deleted file mode 100644 index e1a84b66..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getmaxretransmitslot.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "getmaxretransmitslot" -slug: "rpc-solana-getmaxretransmitslot" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getMaxRetransmitSlot() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getMaxRetransmitSlot` method returns the highest slot number seen from the retransmit stage. This can be useful for monitoring the progress of the network or for determining the highest slot number that has been processed by a specific node. - -{% embed url="https://codepen.io/Night-Shift-Dev/pen/abQZJGR" %} - -### Parameters - -None - -### Return Object - -The method returns a value representing the highest slot number observed in the retransmit stage. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getMaxRetransmitSlot" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": 1234, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getmaxshredinsertslot.md b/v1.0/RPC Nodes/others/rpc-solana/getmaxshredinsertslot.md deleted file mode 100644 index d851e395..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getmaxshredinsertslot.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "getmaxshredinsertslot" -slug: "rpc-solana-getmaxshredinsertslot" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getMaxShredInsertSlot() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getMaxShredInsertSlot` method returns the highest slot number observed after a shred insert. This can be useful for monitoring the highest slot number that a specific node has processed after the shred insert stage, providing insights into the node's synchronisation status. - -{% embed url="https://codepen.io/tatum-devrel/pen/gOQEwQy" %} - -### Parameters - -None - -### Return Object - -The method returns a value representing the highest slot number observed after a shred insert. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getMaxShredInsertSlot" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": 1234, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getminimumbalanceforrentexemption.md b/v1.0/RPC Nodes/others/rpc-solana/getminimumbalanceforrentexemption.md deleted file mode 100644 index a0d1628d..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getminimumbalanceforrentexemption.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "getminimumbalanceforrentexemption" -slug: "rpc-solana-getminimumbalanceforrentexemption" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getMinimumBalanceForRentExemption(50) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getMinimumBalanceForRentExemption` method returns the minimum balance required to make an account rent exempt. This is useful when setting up a new account or assessing the cost of maintaining an account in a rent-free state. - -{% embed url="https://codepen.io/tatum-devrel/pen/xxQBEMp" %} - -### Parameters - -* `dataSize` (number, optional): The account's data length. -* `options` (object, optional): A configuration object containing: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - -### Return Object - -The result field will be a number indicating the minimum lamports required in the account to remain rent free. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getMinimumBalanceForRentExemption", - "params": [50] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": 500, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getmultipleaccounts.md b/v1.0/RPC Nodes/others/rpc-solana/getmultipleaccounts.md deleted file mode 100644 index 57f4db10..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getmultipleaccounts.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "getmultipleaccounts" -slug: "rpc-solana-getmultipleaccounts" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const accounts = [ - "GPHrLJNBeFDkHEChoN6CyHFLroen7jVU3HBmJQXvqGQa", - "4DBehwe4U1gHaE575LZVnjN1MfyPSyWjidadRJoQcyAR", - ]; - -const res = await tatum.rpc.getMultipleAccounts(accounts) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getMultipleAccounts` RPC method fetches information about multiple accounts. This is handy when you need to retrieve data about multiple accounts simultaneously, such as for a portfolio management application or a multi-account wallet. - -{% embed url="https://codepen.io/tatum-devrel/pen/xxQBVOJ?editors=1011" %} - -### Parameters - -The `getMultipleAccounts` method accepts an array of public keys and an optional `GetMultipleAccountsOptions` object: - -* `publicKeys`(array of strings, required): An array of public keys of the accounts to be fetched. - * Example: `["accountPubkey1", "accountPubkey2"]` -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot to include in the response. - * Example: `1000` - * `dataSlice` (object, optional): The range of data to include in the response. - * `offset` (number, optional): The starting index of the data slice. - * Example: `0` - * `length` (number, optional): The length of the data slice. - * Example: `100` - * `encoding` (string, optional): The encoding for the account data. - * Values: `base58` `base64` `base64+zstd` `jsonParsed` - -### Return object - -The result will be a JSON object with `value` equal to an array of: - -* `null` - if the account at that Pubkey doesn't exist, or -* `object` - a JSON object containing: - * `data`: `[string, encoding]|object` - data associated with the account, either as encoded binary data or JSON format `{program: state}` - depending on encoding parameter - * `executable`: A boolean indicating whether the account is executable. - * `lamports`: The current balance of the account, in lamports. - * `owner`: The public key of the account's owner. - * `rentEpoch:`The epoch at which this account will next owe rent, as u64 - * `size:`The data size of the account - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getMultipleAccounts", - "params": [ - ["accountPubkey1", "accountPubkey2"], - { - "commitment": "finalized", - "minContextSlot": 1000, - "dataSlice": { "offset": 0, "length": 100 }, - "encoding": "base64" - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "result":{ - "context":{ - "slot":123456 - }, - "value":[ - { - "owner": "Base58('11111111111111111111111111111111')", - "lamports": 1000000, - "data": "Base64('...')", - "executable": false, - "rentEpoch": 20, - "size": 120 - }, - { - "owner": "Base58('11111111111111111111111111111111')", - "lamports": 1000000, - "data": "Base64('...')", - "executable": false, - "rentEpoch": 20, - "size": 120 - } - ] - } -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getprogramaccounts.md b/v1.0/RPC Nodes/others/rpc-solana/getprogramaccounts.md deleted file mode 100644 index 17afc7c2..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getprogramaccounts.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "getprogramaccounts" -slug: "rpc-solana-getprogramaccounts" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getProgramAccounts('BPFLoaderUpgradeab1e11111111111111111111111') - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getProgramAccounts` RPC method retrieves all accounts owned by a specific program on the Solana blockchain. This method can be useful when monitoring the state of a program or tracking the accounts associated with a particular smart contract. - -Currently pagination is not supported. Requests to `getProgramAccounts` should include the `dataSlice` and/or `filters` parameters to improve response time and return only intended results. - -### Parameters - -The `getProgramAccounts` method accepts a program ID and an optional object: - -* `programId`(string, required): Pubkey of program, as base-58 encoded string - * Example: `"BPFLoaderUpgradeab1e11111111111111111111111"` -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at - * Example: `123456` - * `withContext` (boolean, optional): Whether to wrap the result in an RpcResponse JSON object - * Example: `true` - * `encoding` (string, optional): The encoding format for the returned Account data - * Example: `base58` `base64` `base64+zstd` `jsonParsed` - * `dataSlice` (object, optional): Limit the returned account data using the provided \`offset: number\` and \`length: number\` fields; - * only available for "base58", "base64" or "base64+zstd" encodings. - * Example: `{ offset: 0, length: 100 }` - * `filters` (array, optional): An array of filter objects to filter the accounts based on certain conditions. - * Example: `[{ memcmp: { offset: 0, bytes: "base64" } }` - -### Return object - -The `getProgramAccounts` method returns an array of objects, each containing the following fields: - -* `pubkey`: The public key of the account. -* `account`: An object containing: - * `data`: The account's data, encoded according to the requested format. - * `executable`: Whether the account is executable. - * `lamports`: The account's current balance. - * `owner`: The account's owner public key. - * `rentEpoch`: The epoch at which the account will owe rent again. - * `size`: The data size of the account - -If `withContext` is set to true, the response will also include a `context` object: - -* `context`: An object containing details about the context in which the data was fetched. - * `slot`: The slot at which the data was fetched. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getProgramAccounts", - "params": [ - "BPFLoaderUpgradeab1e11111111111111111111111", - { - "commitment": "finalized", - "minContextSlot": 123456, - "withContext": true, - "encoding": "base64", - "dataSlice": { "offset": 0, "length": 100 }, - "filters": [{ "memcmp": { "offset": 0, "bytes": "base64" } }] - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "result": { - "context": { - "slot": 123456 - }, - "value": [ - { - "pubkey": "9ehXDD5bnhSpFVRf99veikjgq8VajtRH7e3D9aVPLqYd", - "account": { - "data": "base64 encoded data", - "executable": false, - "lamports": 10000, - "owner": "BPFLoaderUpgradeab1e11111111111111111111111", - "rentEpoch": 10 - "size": 120 - } - } - //... more accounts - ] - } -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getrecentperformancesamples.md b/v1.0/RPC Nodes/others/rpc-solana/getrecentperformancesamples.md deleted file mode 100644 index 273687a9..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getrecentperformancesamples.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: "getrecentperformancesamples" -slug: "rpc-solana-getrecentperformancesamples" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getRecentPerformanceSamples(limit) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getRecentPerformanceSamples` method returns a list of recent performance samples, in reverse slot order. Performance samples are taken every 60 seconds and include the number of transactions and slots that occur in a given time window. This data can be used to monitor network performance and understand the activity within the Solana network. - -{% embed url="https://codepen.io/Night-Shift-Dev/pen/poQbeqp" %} - -### Parameters - -* `limit` (usize, optional): The number of samples to return (maximum 720). - -### Return Object - -The result will be an array of objects with the following fields: - -* `slot`: Slot in which sample was taken at. -* `numTransactions`: Number of transactions in sample. -* `numSlots`: Number of slots in sample. -* `samplePeriodSecs`: Number of seconds in a sample window. -* `numNonVoteTransaction`: Number of non-vote transactions in sample. - -Note: `numNonVoteTransaction` is present starting with v1.15. To get the number of voting transactions, compute: numTransactions - numNonVoteTransaction. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "method":"getRecentPerformanceSamples", - "params": [4] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": [ - { - "numSlots": 126, - "numTransactions": 126, - "numNonVoteTransaction": 1, - "samplePeriodSecs": 60, - "slot": 348125 - }, - { - "numSlots": 126, - "numTransactions": 126, - "numNonVoteTransaction": 1, - "samplePeriodSecs": 60, - "slot": 347999 - }, - { - "numSlots": 125, - "numTransactions": 125, - "numNonVoteTransaction": 0, - "samplePeriodSecs": 60, - "slot": 347873 - }, - { - "numSlots": 125, - "numTransactions": 125, - "numNonVoteTransaction": 0, - "samplePeriodSecs": 60, - "slot": 347748 - } - ], - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getrecentprioritizationfees.md b/v1.0/RPC Nodes/others/rpc-solana/getrecentprioritizationfees.md deleted file mode 100644 index 424bf132..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getrecentprioritizationfees.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "getrecentprioritizationfees" -slug: "rpc-solana-getrecentprioritizationfees" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const accounts = ['CxELquR1gPP8wHe33gZ4QxqGB3sZ9RSwsJ2KshVewkFY'] - -const res = await tatum.rpc.getRecentPrioritizationFees(accounts) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getRecentPrioritizationFees` method returns a list of prioritization fees from recent blocks. This method can be used to determine the fees required to prioritize transactions for faster processing. - -{% embed url="https://codepen.io/Night-Shift-Dev/pen/oNQLZJr" %} - -### Parameters - -* `accountAddresses` (array, optional): An array of account addresses (up to a maximum of 128 addresses), as base-58 encoded strings. - - **Note**: If this parameter is provided, the response will reflect a fee to land a transaction locking all of the provided accounts as writable. - -### Return Object - -The result is an array of objects with the following fields: - -* `slot`: The slot in which the fee was observed. -* `prioritizationFee`: The per-compute-unit fee paid by at least one successfully landed transaction, specified in increments of 0.000001 lamports. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getRecentPrioritizationFees", - "params": [ - ["CxELquR1gPP8wHe33gZ4QxqGB3sZ9RSwsJ2KshVewkFY"] - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": [ - { - "slot": 348125, - "prioritizationFee": 0 - }, - { - "slot": 348126, - "prioritizationFee": 1000 - }, - { - "slot": 348127, - "prioritizationFee": 500 - }, - { - "slot": 348128, - "prioritizationFee": 0 - }, - { - "slot": 348129, - "prioritizationFee": 1234 - } - ], - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getsignaturesforaddress.md b/v1.0/RPC Nodes/others/rpc-solana/getsignaturesforaddress.md deleted file mode 100644 index 20c256af..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getsignaturesforaddress.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "getsignaturesforaddress" -slug: "rpc-solana-getsignaturesforaddress" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const address = 'H8UvHwUaXKmHyr1UzEy1y5F5KjU6kGXMDFddxEjqJ2Sn' -const options = {limit: 10} // optional - -const res = await tatum.rpc.getSignaturesForAddress(address, options) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getSignaturesForAddress` method fetches the signatures for confirmed transactions that include the given address in their `accountKeys` list. Returns signatures backwards in time from the provided signature or most recent confirmed block. This is especially useful for tracking the transaction history of an address, auditing transactions, or for debugging purposes. - -### Parameters - -* `address`(string, required): The address for which to fetch the transaction signatures. - * Example: `"H8UvHwUaXKmHyr1UzEy1y5F5KjU6kGXMDFddxEjqJ2Sn"` -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at - * Example: `1000` - * `limit`(number, optional): The maximum number of signatures to return (between 1 and 1,000). - * Example: `10` - * `before`(string, optional): Start searching backwards from this transaction signature. If not provided the search starts from the top of the highest max confirmed block. - * Example: `"5Z7dVQaRBAjBjJZVhdJygdAEyRm3N8D1BQot9aJuthFU"` - * `until`(string, optional): Search until this transaction signature, if found before limit reached - * Example: `"5Z7dVQaRBAjBjJZVhdJygdAEyRm3N8D1BQot9aJuthFU"` - -### Return Object - -An array of ``, ordered from **newest** to **oldest** transaction, containing transaction signature information with the following fields: - -* `signature`: The transaction's signature as base-58 encoded string. -* `slot`: The slot in which the transaction was processed. -* `err`: Error if transaction failed, null if transaction succeeded. -* `memo:` Memo associated with the transaction, null if no memo is present -* `blockTime:` Estimated production time, as Unix timestamp (seconds since the Unix epoch) of when transaction was processed. null if not available. -* `confirmationStatus:` The transaction's cluster confirmation status; Either `processed`, `confirmed`, or `finalized`. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getSignaturesForAddress", - "params": [ - "Vote111111111111111111111111111111111111111", - { - "limit": 1 - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": [ - { - "err": null, - "memo": null, - "signature": "5h6xBEauJ3PK6SWCZ1PGjBvj8vDdWG3KpwATGy1ARAXFSDwt8GFXM7W5Ncn16wmqokgpiKRLuS83KUxyZyv2sUYv", - "slot": 114, - "blockTime": null - } - // More signatures... - ], - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getsignaturestatuses.md b/v1.0/RPC Nodes/others/rpc-solana/getsignaturestatuses.md deleted file mode 100644 index e217f7aa..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getsignaturestatuses.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: "getsignaturestatuses" -slug: "rpc-solana-getsignaturestatuses" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const signatures = ['4CgnQtRfnUekfn21meTyHYvoAc6pBYK3DhimeiZL6a6o2QXMTHqDomninDkaZLmSfdiEzZfyfLGN4mrDvs8HmnBh'] // list of transaction signatures -const options = {searchTransactionHistory: true} // optional - -const res = await tatum.rpc.getSignatureStatuses(signatures, options) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getSignatureStatuses` method fetches the processing statuses of a list of transactions, identified by their signatures. This is especially useful for tracking the status of transactions, whether they are being processed, confirmed or finalised. - -{% embed url="https://codepen.io/tatum-devrel/pen/gOQErNL" %} - -### Parameters - -* `signatures`: (Array of strings, required) An array of transaction signatures to fetch the statuses of. - * Example: `["4CgnQtRfnUekfn21meTyHYvoAc6pBYK3DhimeiZL6a6o2QXMTHqDomninDkaZLmSfdiEzZfyfLGN4mrDvs8HmnBh"]` -* `options` (object, optional): Configuration object containing the following fields: - * `searchTransactionHistory` (bool, optional): if `true` - a Solana node will search its ledger cache for any signatures not found in the recent status cache - * Example: `true` - -### Return Object - -The result will be an RpcResponse JSON object with `value` equal to an array of JSON objects, consisting of either: - -* `null` Unknown transaction, or -* `object` - * `slot:` The slot the transaction was processed - * `confirmations:` Number of blocks since signature confirmation, null if rooted, as well as finalized by a supermajority of the cluster - * `err:` Error if transaction failed, null if transaction succeeded. - * `confirmationStatus:` The transaction's cluster confirmation status; Either `processed`, `confirmed`, or `finalized`. - * DEPRECATED: `status:` Transaction status object - * `"Ok":` Transaction was successful - * `"Err":` Transaction failed with TransactionError - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getSignatureStatuses", - "params": [ - [ - "4CgnQtRfnUekfn21meTyHYvoAc6pBYK3DhimeiZL6a6o2QXMTHqDomninDkaZLmSfdiEzZfyfLGN4mrDvs8HmnBh" - ], - { - "searchTransactionHistory": true - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 82 - }, - "value": [ - { - "slot": 48, - "confirmations": null, - "err": null, - "status": { - "Ok": null - }, - "confirmationStatus": "finalized" - }, - null - ] - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getslot.md b/v1.0/RPC Nodes/others/rpc-solana/getslot.md deleted file mode 100644 index 1aa045d9..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getslot.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "getslot" -slug: "rpc-solana-getslot" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getSlot() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getSlot` method returns the slot that has reached the given or default commitment level. Slots are a fundamental concept in the Solana blockchain, representing the passing of time in the ledger. This method is helpful for tracking the progress of the blockchain and can be used in numerous cases, such as determining the current state of the ledger, or for timekeeping purposes in a DApp. - -{% embed url="https://codepen.io/tatum-devrel/pen/gOQEwvZ" %} - -### Parameters - -* `options` (object, optional): A configuration object containing: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at. - -### Return Object - -The method returns an integer, representing the current slot that has reached the given or default commitment level. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getSlot" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": 1234, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getslotleader.md b/v1.0/RPC Nodes/others/rpc-solana/getslotleader.md deleted file mode 100644 index 11177cd4..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getslotleader.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "getslotleader" -slug: "rpc-solana-getslotleader" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getSlotLeader() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getSlotLeader` method returns the identity of the node that is currently the leader of the slot. In the Solana network, a slot leader is responsible for producing blocks for the network during their assigned slot time. This method could be used to monitor the network's operation or for analysis of network activity. - -{% embed url="https://codepen.io/tatum-devrel/pen/WNYmGze" %} - -### Parameters - -* `options` (object, optional): A configuration object containing: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at. - -### Return Object - -The method returns a string that represents the Node identity Pubkey as a base-58 encoded string. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getSlotLeader" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": "ENvAW7JScgYq6o4zKZwewtkzzJgDzuJAFxYasvmEQdpS", - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getslotleaders.md b/v1.0/RPC Nodes/others/rpc-solana/getslotleaders.md deleted file mode 100644 index c2d3a55e..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getslotleaders.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "getslotleaders" -slug: "rpc-solana-getslotleaders" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getSlotLeaders(100,10) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getSlotLeaders` method returns an array of the slot leaders for a given slot range. In the Solana network, a slot leader is responsible for producing blocks for the network during their assigned slot time. This method could be used to monitor the network's operation, for analysis of network activity, or to understand which nodes have been assigned to produce blocks in the upcoming slots. - -### Parameters - -* `startSlot` (number, optional) -* `limit` (number, optional): Integer between 1 and 5,000. - -### Return Object - -The method returns an array of strings that represents an array of Node identity public keys as base-58 encoded strings. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id": 1, - "method": "getSlotLeaders", - "params": [100, 10] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": [ - "ChorusmmK7i1AxXeiTtQgQZhQNiXYU84ULeaYF1EH15n", - "ChorusmmK7i1AxXeiTtQgQZhQNiXYU84ULeaYF1EH15n", - "ChorusmmK7i1AxXeiTtQgQZhQNiXYU84ULeaYF1EH15n", - "ChorusmmK7i1AxXeiTtQgQZhQNiXYU84ULeaYF1EH15n", - "Awes4Tr6TX8JDzEhCZY2QVNimT6iD1zWHzf1vNyGvpLM", - "Awes4Tr6TX8JDzEhCZY2QVNimT6iD1zWHzf1vNyGvpLM", - "Awes4Tr6TX8JDzEhCZY2QVNimT6iD1zWHzf1vNyGvpLM", - "Awes4Tr6TX8JDzEhCZY2QVNimT6iD1zWHzf1vNyGvpLM", - "DWvDTSh3qfn88UoQTEKRV2JnLt5jtJAVoiCo3ivtMwXP", - "DWvDTSh3qfn88UoQTEKRV2JnLt5jtJAVoiCo3ivtMwXP" - ], - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getstakeactivation.md b/v1.0/RPC Nodes/others/rpc-solana/getstakeactivation.md deleted file mode 100644 index 714a0734..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getstakeactivation.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: "getstakeactivation" -slug: "rpc-solana-getstakeactivation" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const pubkey = "CYRJWqiSjLitBAcRxPvWpgX3s5TvmN2SuRY3eEYypFvT" -const config = { - epoch: 4 -} - -const res = await tatum.rpc.getStakeActivation(pubkey, config) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getStakeActivation` method returns epoch activation information for a stake account on the Solana blockchain. - -### Parameters - -This method takes the following parameters: - -* A string (required): This is the pubkey of the stake account to query, as a base-58 encoded string. - * Example: `"CYRJWqiSjLitBAcRxPvWpgX3s5TvmN2SuRY3eEYypFvT"` -* A configuration object (optional): This object can contain the following fields: - * `commitment` (string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at. - * `epoch` (number, optional): The epoch for which to calculate activation details. If this parameter is not provided, it defaults to the current epoch. - -### Return Object - -The method returns a JSON object that includes the following fields: - -* `state`: The activation state of the stake account. This can be 'active', 'inactive', 'activating', or 'deactivating'. -* `active`: The stake that is active during the epoch. -* `inactive`: The stake that is inactive during the epoch. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getStakeActivation", - "params": [ - "CYRJWqiSjLitBAcRxPvWpgX3s5TvmN2SuRY3eEYypFvT", - { - "epoch": 4 - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "active": 124429280, - "inactive": 73287840, - "state": "activating" - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getstakeminimumdelegation.md b/v1.0/RPC Nodes/others/rpc-solana/getstakeminimumdelegation.md deleted file mode 100644 index d999d243..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getstakeminimumdelegation.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "getstakeminimumdelegation" -slug: "rpc-solana-getstakeminimumdelegation" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getStakeMinimumDelegation() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getStakeMinimumDelegation` method is an essential component of Solana's staking process. It returns the minimum delegation amount, expressed in lamports, that is required to stake on the Solana network. The staking process is an integral part of Solana's Proof of Stake consensus mechanism, where stakeholders are rewarded for their participation in securing the network. - -This method is commonly used by wallets and staking services to inform their users about the minimum amount required for staking. By delegating a certain amount of Solana tokens, participants can earn staking rewards and contribute to the network's security. The minimum delegation amount is set by the network to prevent spam and maintain a high level of network performance. - -{% embed url="https://codepen.io/tatum-devrel/pen/YzRgGyY?editors=1010" %} - -### Parameters - -This method takes the following parameters: - -* A configuration object (optional): This object can contain the following fields: - * `commitment` (string, optional): The level of commitment desired for the query. - -### Return Object - -The return object contains a `bool` value of the minimum delegation amount for staking, in lamports. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "method": "getStakeMinimumDelegation" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 501 - }, - "value": 1000000000 - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getsupply.md b/v1.0/RPC Nodes/others/rpc-solana/getsupply.md deleted file mode 100644 index b2b70693..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getsupply.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "getsupply" -slug: "rpc-solana-getsupply" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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] - - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getSupply() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getSupply` method returns information about the current supply of lamports in the Solana network. It provides insights into the distribution of lamports, such as the total supply, the amount in circulation, and the amount that is not circulating. This can be useful for anyone interested in the macroeconomics of the Solana network or in tracking the circulation of lamports over time. - -{% embed url="https://codepen.io/tatum-devrel/pen/QWJoKoj?editors=1011" %} - -### Parameters - -* `options` (object, optional): A configuration object containing: - * `commitment`(string, optional): Specifies the level of commitment to apply when fetching data. - * `excludeNonCirculatingAccountsList` (bool, optional): If true, the returned array of non-circulating accounts will be empty. - -### Return Object - -The result field will be a JSON object containing: - -* `total`: Total supply in lamports. -* `circulating`: Circulating supply in lamports. -* `nonCirculating`: Non-circulating supply in lamports. -* `nonCirculatingAccounts`: An array of account addresses of non-circulating accounts, as strings. If `excludeNonCirculatingAccountsList` is enabled, the returned array will be empty. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getSupply" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 1114 - }, - "value": { - "circulating": 16000, - "nonCirculating": 1000000, - "nonCirculatingAccounts": [ - "FEy8pTbP5fEoqMV1GdTz83byuA8EKByqYat1PKDgVAq5", - "9huDUZfxoJ7wGMTffUE7vh1xePqef7gyrLJu9NApncqA", - "3mi1GmwEE3zo2jmfDuzvjSX9ovRXsDUKHvsntpkhuLJ9", - "BYxEJTDerkaRWBem3XgnVcdhppktBXa2HbkHPKj2Ui4Z" - ], - "total": 1016000 - } - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/gettokenaccountbalance.md b/v1.0/RPC Nodes/others/rpc-solana/gettokenaccountbalance.md deleted file mode 100644 index 67dff222..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/gettokenaccountbalance.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "gettokenaccountbalance" -slug: "rpc-solana-gettokenaccountbalance" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getTokenAccountBalance('DhzDoryP2a4rMK2bcWwJxrE2uW6ir81ES8ZwJJPPpxDN') - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getTokenAccountBalance` method provides the ability to fetch the current balance of a given SPL Token account. It is used when you want to know the amount of tokens held in a specific token account. The token account is specified by its public key. - -{% embed url="https://codepen.io/tatum-devrel/pen/KKrEzqq" %} - -### Parameters - -This method accepts two parameters: - -* `pubkey` (string, required): Pubkey of Token account to query, as base-58 encoded string - * Example: `"DhzDoryP2a4rMK2bcWwJxrE2uW6ir81ES8ZwJJPPpxDN"` -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - -### Return object - -The `getTokenAccountBalance` method returns an object containing the following fields: - -* `value`: An object containing: - * `amount`: The raw balance without decimals, a string representation of number - * `decimals`: Number of base 10 digits to the right of the decimal place - * `uiAmount`: Number or null. The balance, using mint-prescribed decimals **DEPRECATED** - * `uiAmountString`: The balance as a string, using mint-prescribed decimals - -If `withContext` is set to true, the response will also include a `context` object: - -* `context`: An object containing details about the context in which the data was fetched. - * `slot`: The slot at which the data was fetched. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTokenAccountBalance", - "params": [ - "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - { - "commitment": "finalized", - "encoding": "base64" - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "result": { - "context": { - "slot": 123456 - }, - "value": { - "amount": "10000", - "decimals": 6, - "uiAmount": 0.01, - "uiAmountString": "0.01" - } - } -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/gettokenaccountsbydelegate.md b/v1.0/RPC Nodes/others/rpc-solana/gettokenaccountsbydelegate.md deleted file mode 100644 index ff8e4789..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/gettokenaccountsbydelegate.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: "gettokenaccountsbydelegate" -slug: "rpc-solana-gettokenaccountsbydelegate" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const delegate = "GgPpTKg78vmzgDtP1DNn72CHAYjRdKY7AV6zgszoHCSa"; - -const res = await tatum.rpc.getTokenAccountsByDelegate(delegate) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getTokenAccountsByDelegate` method returns all SPL Token accounts by a specified delegate. This can be useful when you need to retrieve all token accounts associated with a specific delegate address, typically in situations where you are managing or auditing the accounts managed by a particular delegate. - -### Parameters - -* `delegate` (string, required): Pubkey of account delegate to query, as base-58 encoded string - * Example: `"GgPpTKg78vmzgDtP1DNn72CHAYjRdKY7AV6zgszoHCSa"` -* `config`(object, optional): An optional object containing either of the following: - * `mint`(string): Pubkey of the specific token Mint to limit accounts to, as base-58 encoded string - * Example: `{ mint: 'So11111111111111111111111111111111111111112' }` - * `programId` (string): Pubkey of the Token program that owns the accounts, as base-58 encoded string - * Example: `{ programId: 'So11111111111111111111111111111111111111112' }` -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at - * Example: `1000` - * `dataSlice` (object, optional): limit the returned account data using the provided `offset` (number) and `length` (number) fields; only available for `base58`, `base64` or `base64+zstd` encodings. - * Example: `{ "offset": 0, "length": 100 }` - * `encoding` (string, optional): The encoding for the account data. - * Values: `base58` `base64` `base64+zstd` `jsonParsed` - -### Return object - -The result will be an RpcResponse JSON object with `value` equal to an array of JSON objects, which will contain: - -* `pubkey`: Public key of the account. -* `account`: A JSON object, with the following sub fields: - * `executable`: Whether the account is executable. - * `owner`: Base-58 encoded Pubkey of the program this account has been assigned to - * `lamports`: Number of lamports in the account. - * `data`: Token state data associated with the account, either as encoded binary data or in JSON format `{program: state}` - * `rentEpoch`: The epoch at which the account will next owe rent. - * `size`: The data size of the account - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTokenAccountsByDelegate", - "params": [ - "28YTZEwqtMHWrhWcvv34se7pjS7wctgqzCPB3gReCFKp" - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 1114 - }, - "value": [ - { - "account": { - "data": { - "program": "spl-token", - "parsed": { - "info": { - "tokenAmount": { - "amount": "1", - "decimals": 1, - "uiAmount": 0.1, - "uiAmountString": "0.1" - }, - "delegate": "4Nd1mBQtrMJVYVfKf2PJy9NZUZdTAsp7D4xWLs4gDB4T", - "delegatedAmount": { - "amount": "1", - "decimals": 1, - "uiAmount": 0.1, - "uiAmountString": "0.1" - }, - "state": "initialized", - "isNative": false, - "mint": "3wyAj7Rt1TWVPZVteFJPLa26JmLvdb1CAKEFZm3NY75E", - "owner": "CnPoSPKXu7wJqxe59Fs72tkBeALovhsCxYeFwPCQH9TD" - }, - "type": "account" - }, - "space": 165 - }, - "executable": false, - "lamports": 1726080, - "owner": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA", - "rentEpoch": 4, - "space": 165 - }, - "pubkey": "28YTZEwqtMHWrhWcvv34se7pjS7wctgqzCPB3gReCFKp" - } - ] - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/gettokenaccountsbyowner.md b/v1.0/RPC Nodes/others/rpc-solana/gettokenaccountsbyowner.md deleted file mode 100644 index a96d0724..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/gettokenaccountsbyowner.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "gettokenaccountsbyowner" -slug: "rpc-solana-gettokenaccountsbyowner" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network, Encoding } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getTokenAccountsByOwner( - 'GgPpTKg78vmzgDtP1DNn72CHAYjRdKY7AV6zgszoHCSa', - { - mint: '1YDQ35V8g68FGvcT85haHwAXv1U7XMzuc4mZeEXfrjE', - }, - { encoding: Encoding.JsonParsed } -) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getTokenAccountsByOwner` method retrieves all SPL token accounts owned by a specified address on the Solana blockchain. It allows you to fetch a list of token accounts associated with a particular owner. This method is useful for querying the token holdings of a specific address and performing operations related to token management. - -{% embed url="https://codepen.io/tatum-devrel/pen/bGQZpaB" %} - -### Parameters - -* `ownerAddress` (string, required): The address of the owner for whom to retrieve token accounts. - * Example: `'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn'` -* `config`(object, optional): An optional object containing either of the following: - * `mint`(string): Pubkey of the specific token Mint to limit accounts to, as base-58 encoded string - * Example: `{ mint: 'So11111111111111111111111111111111111111112' }` - * `programId` (string): Pubkey of the Token program that owns the accounts, as base-58 encoded string - * Example: `{ programId: 'So11111111111111111111111111111111111111112' }` -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at - * Example: `1000` - * `dataSlice` (object, optional): limit the returned account data using the provided `offset` (number) and `length` (number) fields; only available for `base58`, `base64` or `base64+zstd` encodings. - * Example: `{ "offset": 0, "length": 100 }` - * `encoding` (string, optional): The encoding for the account data. - * Values: `base58` `base64` `base64+zstd` `jsonParsed` - -### Return object - -The result will be an RpcResponse JSON object with `value` equal to an array of JSON objects, which will contain: - -* `pubkey`: Public key of the account. -* `account`: A JSON object, with the following sub fields: - * `executable`: Whether the account is executable. - * `owner`: Base-58 encoded Pubkey of the program this account has been assigned to - * `lamports`: Number of lamports in the account. - * `data`: Token state data associated with the account, either as encoded binary data or in JSON format `{program: state}` - * `rentEpoch`: The epoch at which the account will next owe rent. - * `size`: The data size of the account - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTokenAccountsByOwner", - "params": [ - 'GgPpTKg78vmzgDtP1DNn72CHAYjRdKY7AV6zgszoHCSa', - { - mint: '1YDQ35V8g68FGvcT85haHwAXv1U7XMzuc4mZeEXfrjE', - }, - { encoding: 'jsonParsed'}, - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 1114 - }, - "value": [ - { - "account": { - "data": { - "program": "spl-token", - "parsed": { - "accountType": "account", - "info": { - "tokenAmount": { - "amount": "1", - "decimals": 1, - "uiAmount": 0.1, - "uiAmountString": "0.1" - }, - "delegate": "4Nd1mBQtrMJVYVfKf2PJy9NZUZdTAsp7D4xWLs4gDB4T", - "delegatedAmount": { - "amount": "1", - "decimals": 1, - "uiAmount": 0.1, - "uiAmountString": "0.1" - }, - "state": "initialized", - "isNative": false, - "mint": "3wyAj7Rt1TWVPZVteFJPLa26JmLvdb1CAKEFZm3NY75E", - "owner": "4Qkev8aNZcqFNSRhQzwyLMFSsi94jHqE8WNVTJzTP99F" - }, - "type": "account" - }, - "space": 165 - }, - "executable": false, - "lamports": 1726080, - "owner": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA", - "rentEpoch": 4, - "space": 165 - }, - "pubkey": "C2gJg6tKpQs41PRS1nC8aw3ZKNZK3HQQZGVrDFDup5nx" - } - ] - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/gettokenlargestaccounts.md b/v1.0/RPC Nodes/others/rpc-solana/gettokenlargestaccounts.md deleted file mode 100644 index 7cedb6e6..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/gettokenlargestaccounts.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "gettokenlargestaccounts" -slug: "rpc-solana-gettokenlargestaccounts" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getTokenLargestAccounts() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getTokenLargestAccounts` method is a valuable resource for analyzing the distribution of a particular SPL (Solana Program Library) Token in the network. This method returns the 20 largest accounts of a specific SPL Token type. - -The primary use case for this method is to gain insights into the distribution of a particular token. For instance, token issuers might want to monitor the distribution of their tokens and identify the largest holders. - -Another use case is for research and analysis purposes. Data providers, exchange platforms, or individuals might use this information to study market behavior, make predictions, or develop trading strategies based on the ownership concentration of a specific token. - -### Parameters - -This method takes the following parameters: - -* `pubkey` (string, required): A string that represents the Pubkey of the token Mint to query, as base-58 encoded string. -* A configuration object (optional): This object can contain the following fields: - * `commitment` (string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - -### Return Object - -The result will be an RpcResponse JSON object with `value` equal to an array of JSON objects containing: - -* `address`: The address of the token account. -* `amount`: The raw token account balance without decimals, a string representation of u64. -* `decimals`: The number of base 10 digits to the right of the decimal place. -* `uiAmount`: The token account balance, using mint-prescribed decimals. Note: This field is deprecated. -* `uiAmountString`: The token account balance as a string, using mint-prescribed decimals. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTokenLargestAccounts", - "params": [ - "3wyAj7Rt1TWVPZVteFJPLa26JmLvdb1CAKEFZm3NY75E" - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 1114 - }, - "value": [ - { - "address": "FYjHNoFtSQ5uijKrZFyYAxvEr87hsKXkXcxkcmkBAf4r", - "amount": "771", - "decimals": 2, - "uiAmount": 7.71, - "uiAmountString": "7.71" - }, - { - "address": "BnsywxTcaYeNUtzrPxQUvzAWxfzZe3ZLUJ4wMMuLESnu", - "amount": "229", - "decimals": 2, - "uiAmount": 2.29, - "uiAmountString": "2.29" - } - ] - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/gettokensupply.md b/v1.0/RPC Nodes/others/rpc-solana/gettokensupply.md deleted file mode 100644 index 6ff8b01e..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/gettokensupply.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "gettokensupply" -slug: "rpc-solana-gettokensupply" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const tokenMintPubkey = "3wyAj7Rt1TWVPZVteFJPLa26JmLvdb1CAKEFZm3NY75E" - -const res = await tatum.rpc.getTokenSupply(tokenMintPubkey, config) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getTokenSupply` method returns the total supply of a specific SPL (Solana Program Library) Token in the network. - -This method is especially useful for token issuers or traders who want to keep track of the total token supply for market analysis or supply management. - -Another use case for this method is for financial services applications or DeFi protocols, where it is important to know the total supply of a token to calculate various financial metrics such as market capitalisation or liquidity. - -{% embed url="https://codepen.io/tatum-devrel/pen/rNQRMxx" %} - -### Parameters - -This method takes the following parameters: - -* `pubkey` (string, required): A string that represents the Pubkey of the token Mint to query. -* `options` (object, optional): This object can contain the following fields: - * `commitment` (string, optional): Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - -### Return Object - -The result will be an RpcResponse JSON object with `value` equal to a JSON object containing: - -* `amount`: The raw total token supply without decimals, a string representation of u64. -* `decimals`: The number of base 10 digits to the right of the decimal place. -* `uiAmount`: The total token supply, using mint-prescribed decimals. Note: This field is deprecated. -* `uiAmountString`: The total token supply as a string, using mint-prescribed decimals. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTokenSupply", - "params": [ - "3wyAj7Rt1TWVPZVteFJPLa26JmLvdb1CAKEFZm3NY75E" - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 1114 - }, - "value": { - "amount": "100000", - "decimals": 2, - "uiAmount": 1000, - "uiAmountString": "1000" - } - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/gettransaction.md b/v1.0/RPC Nodes/others/rpc-solana/gettransaction.md deleted file mode 100644 index 99211333..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/gettransaction.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: "gettransaction" -slug: "rpc-solana-gettransaction" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const signature = '4CgnQtRfnUekfn21meTyHYvoAc6pBYK3DhimeiZL6a6o2QXMTHqDomninDkaZLmSfdiEzZfyfLGN4mrDvs8HmnBh' // transaction signature - -const res = await tatum.rpc.getTransaction(signature) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getTransaction` method retrieves the details of a specific transaction, identified by its signature. This method can be used to fetch transaction details such as the addresses involved, the amount transacted, the block in which the transaction was included, and so forth. - -### Parameters - -* `signature`(string): Transaction signature, as base-58 encoded string - * Example: `"4CgnQtRfnUekfn21meTyHYvoAc6pBYK3DhimeiZL6a6o2QXMTHqDomninDkaZLmSfdiEzZfyfLGN4mrDvs8HmnBh"` -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - * `maxSupportedTransactionVersion` (number): Set the max transaction version to return in responses. If the requested transaction is a higher version, an error will be returned. If this parameter is omitted, only legacy transactions will be returned, and any versioned transaction will prompt the error. - * Example: `1` - * `encoding` (string, optional): The encoding for the account data. - * Values: `base58` `base64` `jsonParsed` - -### Return Object - -* `null` If transaction is not found or not confirmed -* `object` If transaction is confirmed, an object with the following fields: - * `slot:` The slot this transaction was processed in - * `transaction:` Transaction object, either in JSON format or encoded binary data, depending on encoding parameter - * `blockTime:` Estimated production time, as Unix timestamp (seconds since the Unix epoch) of when the transaction was processed. null if not available - * `meta:` Transaction status metadata object: - * `err:` Error if transaction failed, null if transaction succeeded. - * `fee:` Fee this transaction was charged, as u64 integer - * `preBalances:` Array of u64 account balances from before the transaction was processed - * `postBalances:` Array of u64 account balances after the transaction was processed - * `innerInstructions:` List of inner instructions or `null` if inner instruction recording was not enabled during this transaction - * `preTokenBalances:` List of token balances from before the transaction was processed or omitted if token balance recording was not yet enabled during this transaction - * `postTokenBalances:` List of token balances from after the transaction was processed or omitted if token balance recording was not yet enabled during this transaction - * `logMessages:` Array of string log messages or `null` if log message recording was not enabled during this transaction - * DEPRECATED: `status:` Transaction status - * `"Ok":` Transaction was successful - * `"Err":` Transaction failed with TransactionError - * `rewards:` Transaction-level rewards, populated if rewards are requested; an array of JSON objects containing: - * `pubkey:` The public key, as base-58 encoded string, of the account that received the reward - * `lamports:`Number of reward lamports credited or debited by the account, as a i64 - * `postBalance:` Account balance in lamports after the reward was applied - * `rewardType:` Type of reward: currently only "rent", other types may be added in the future - * `commission:` Vote account commission when the reward was credited, only present for voting and staking rewards - * `loadedAddresses:` Transaction addresses loaded from address lookup tables. Undefined if `maxSupportedTransactionVersion` is not set in request params. - * `writable:` Ordered list of base-58 encoded addresses for writable loaded accounts - * `readonly:` Ordered list of base-58 encoded addresses for readonly loaded accounts - * `returnData:` The most-recent return data generated by an instruction in the transaction, with the following fields: - * `programId:` The program that generated the return data, as base-58 encoded Pubkey - * `data:` The return data itself, as base-64 encoded binary data - * `computeUnitsConsumed:` Number of compute units consumed by the transaction - * `version:` Transaction version. Undefined if `maxSupportedTransactionVersion` is not set in request params. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTransaction", - "params": [ - "4CgnQtRfnUekfn21meTyHYvoAc6pBYK3DhimeiZL6a6o2QXMTHqDomninDkaZLmSfdiEzZfyfLGN4mrDvs8HmnBh", - { - "encoding": "jsonParsed" - } - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "meta": { - "err": null, - "fee": 5000, - "innerInstructions": [], - "postBalances": [499998932500, 26858640, 1, 1, 1], - "postTokenBalances": [], - "preBalances": [499998937500, 26858640, 1, 1, 1], - "preTokenBalances": [], - "rewards": [], - "status": { - "Ok": null - } - }, - "slot": 430, - "transaction": { - "message": { - "accountKeys": [ - "3UVYmECPPMZSCqWKfENfuoTv51fTDTWicX9xmBD2euKe", - "AjozzgE83A3x1sHNUR64hfH7zaEBWeMaFuAN9kQgujrc", - "SysvarS1otHashes111111111111111111111111111", - "SysvarC1ock11111111111111111111111111111111", - "Vote111111111111111111111111111111111111111" - ], - "header": { - "numReadonlySignedAccounts": 0, - "numReadonlyUnsignedAccounts": 3, - "numRequiredSignatures": 1 - }, - "instructions": [ - { - "accounts": [1, 2, 3, 0], - "data": "37u9WtQpcm6ULa3WRQHmj49EPs4if7o9f1jSRVZpm2dvihR9C8jY4NqEwXUbLwx15HBSNcP1", - "programIdIndex": 4 - } - ], - "recentBlockhash": "mfcyqEXB3DnHXki6KjjmZck6YjmZLvpAByy2fj4nh6B" - }, - "signatures": [ - "2nBhEBYYvfaAe16UMNqRHre4YNSskvuYgx3M6E4JP1oDYvZEJHvoPzyUidNgNX5r9sTyN1J9UxtbCXy2rqYcuyuv" - ] - } - }, - "blockTime": null, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/gettransactioncount.md b/v1.0/RPC Nodes/others/rpc-solana/gettransactioncount.md deleted file mode 100644 index ef708723..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/gettransactioncount.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "gettransactioncount" -slug: "rpc-solana-gettransactioncount" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getTransactionCount() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getTransactionCount` method retrieves the current transaction count from the ledger. This can be used to track the number of transactions processed by the network. - -{% embed url="https://codepen.io/tatum-devrel/pen/jOQJroJ?editors=1111" %} - -### Parameters - -* `options` (object, optional): Configuration object containing the following fields: - * `commitment` (string, optional): Specifies the confirmation level of data to be fetched. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot`: (number, optional) The minimum slot that the request can be evaluated at. - * Example: `5` - -### Return Object - -The method returns a number indicating the current transaction count from the ledger. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTransactionCount", -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": 268, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getversion.md b/v1.0/RPC Nodes/others/rpc-solana/getversion.md deleted file mode 100644 index d5e46878..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getversion.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "getversion" -slug: "rpc-solana-getversion" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getVersion() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `getVersion` method is used to retrieve the current Solana version running on the node. This information can be useful for troubleshooting, compatibility checks, or for understanding the node's capabilities based on its version. - -{% embed url="https://codepen.io/tatum-devrel/pen/vYQPXVV" %} - -### Parameters - -This method does not require any parameters. - -### Return Object - -The result field will be a JSON object with the following fields: - -* `solana-core`: The software version of `solana-core`. -* `feature-set`: The unique identifier of the current software's feature set. - -### JSON-RPC Request Example - -```json -jsonCopy code{ - "jsonrpc": "2.0", - "id": 1, - "method": "getVersion" -} -``` - -### JSON-RPC Response Example - -```json -jsonCopy code{ - "jsonrpc": "2.0", - "result": { - "solana-core": "1.15.0" - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/getvoteaccounts.md b/v1.0/RPC Nodes/others/rpc-solana/getvoteaccounts.md deleted file mode 100644 index 0ca1e14f..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/getvoteaccounts.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "getvoteaccounts" -slug: "rpc-solana-getvoteaccounts" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.getVoteAccounts({ votePubkey: 'beefKGBWeSpHzYBHZXwp5So7wdQGX6mu4ZHCsH3uTar' }) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -{% embed url="https://codepen.io/tatum-devrel/pen/rNQReoZ" %} - -### Overview - -The `getVoteAccounts` method is used to fetch the current list of vote accounts and their associated stake in the network. This is particularly useful when you want to understand the current validators in the Solana network and their voting records. It can be used in situations where you need to analyse the active participation in the network's consensus protocol. - -### Parameters - -* `options` (object, optional): Configuration object containing the following fields: - * `commitment`(string, optional): Specifies the confirmation level of data to be fetched. - * Example: `"confirmed"` - * `votePubkey` (string, optional): Specifies the public key of the vote account to fetch. - * Example: `"beefKGBWeSpHzYBHZXwp5So7wdQGX6mu4ZHCsH3uTar"` - * `keepUnstakedDelinquents` (boolean, optional): Do not filter out delinquent validators with no stake - * Example: `true` - * `delinquentSlotDistance` (number, optional): Specify the number of slots behind the tip that a validator must fall to be considered delinquent. **NOTE:** For the sake of consistency between ecosystem products, _it is not recommended that this argument be specified._ - * Example: `10` - -### Return object - -The result field will be a JSON object of `current` and `delinquent` accounts, each containing an array of JSON objects with the following sub fields: - -* `votePubkey:`Vote account address, as base-58 encoded string -* `nodePubkey:` Validator identity, as base-58 encoded string -* `activatedStake:` The stake, in lamports, delegated to this vote account and active in this epoch -* `epochVoteAccount:` Whether the vote account is staked for this epoch -* `commission:` Percentage (0-100) of rewards payout owed to the vote account -* `lastVote:` Most recent slot voted on by this vote account -* `epochCredits:` Latest history of earned credits for up to five epochs, as an array of arrays containing: `[epoch, credits, previousCredits]`. -* `rootSlot:` Current root slot for this vote account - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "getTokenAccountsByOwner", - "params": [{votePubkey: 'beefKGBWeSpHzYBHZXwp5So7wdQGX6mu4ZHCsH3uTar'}] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "current": [ - { - "commission": 0, - "epochVoteAccount": true, - "epochCredits": [ - [1, 64, 0], - [2, 192, 64] - ], - "nodePubkey": "B97CCUW3AEZFGy6uUg6zUdnNYvnVq5VG8PUtb2HayTDD", - "lastVote": 147, - "activatedStake": 42, - "votePubkey": "3ZT31jkAGhUaw8jsy4bTknwBMP8i4Eueh52By4zXcsVw" - } - ], - "delinquent": [] - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/isblockhashvalid.md b/v1.0/RPC Nodes/others/rpc-solana/isblockhashvalid.md deleted file mode 100644 index 762f4d86..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/isblockhashvalid.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "isblockhashvalid" -slug: "rpc-solana-isblockhashvalid" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network, Commitment } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const blockhash = 'J7rBdM6AecPDEZp8aPq5iPSNKVkU5Q76F3oAV4eW5wsW' -const options = { - commitment: Commitment.Processed, - minContextSlot: 5 -} // optional - -const res = await tatum.rpc.isBlockhashValid(blockhash, options) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `isBlockhashValid` method evaluates the validity of a specified blockhash. This can be used to confirm if a blockhash is still valid on the network. - -{% embed url="https://codepen.io/tatum-devrel/pen/vYQPKoW" %} - -### Parameters - -* `blockhash`(string, required): The blockhash of the block to evaluate, as a base-58 encoded string. - * Example: `'J7rBdM6AecPDEZp8aPq5iPSNKVkU5Q76F3oAV4eW5wsW'` -* `options`: (object, optional) Configuration object containing the following fields: - * `commitment`: (string, optional) Specifies the level of commitment to apply when fetching data. - * Values: `finalized` `confirmed` `processed` - * `minContextSlot`: (number, optional) The minimum slot that the request can be evaluated at. - * Example: `5` - -### Return Object - -The return object contains a `bool` value indicating if the blockhash is still valid. - -### JSON-RPC Request Example - -```json -{ - "id": 45, - "jsonrpc": "2.0", - "method": "isBlockhashValid", - "params": [ - "J7rBdM6AecPDEZp8aPq5iPSNKVkU5Q76F3oAV4eW5wsW", {"commitment":"processed"} - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 2483 - }, - "value": false - }, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/minimumledgerslot.md b/v1.0/RPC Nodes/others/rpc-solana/minimumledgerslot.md deleted file mode 100644 index c8b21f6b..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/minimumledgerslot.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "minimumledgerslot" -slug: "rpc-solana-minimumledgerslot" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const res = await tatum.rpc.minimumLedgerSlot() - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `minimumLedgerSlot` method returns the lowest slot number that the node has information about in its ledger. This is useful when tracking the node's ledger history, such as for auditing, ledger analysis, or understanding the node's data retention policies. - -Note: This value may change over time if the node is configured to purge older ledger data, meaning that older data may no longer be accessible. - -{% embed url="https://codepen.io/tatum-devrel/pen/QWJoKBw" %} - -### Parameters - -This method does not require any parameters. - -### Return Object - -The method returns an integer that represents the minimum ledger slot number. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc":"2.0", - "id":1, - "method":"minimumLedgerSlot" -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": 1234, - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/requestairdrop.md b/v1.0/RPC Nodes/others/rpc-solana/requestairdrop.md deleted file mode 100644 index 9ec21773..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/requestairdrop.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "requestairdrop" -slug: "rpc-solana-requestairdrop" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({network: Network.SOLANA_DEVNET}) - -const res = await tatum.rpc.requestAirdrop('G35uLP74uj4eCSfMs17ePKtK1ThuH8JKebAP1T2y6CYw',1000000000) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `requestAirdrop` method is used to request an airdrop of lamports to a specific Pubkey. This is particularly useful for testing or development environments where you need to distribute tokens for various accounts for testing purposes. - -### Parameters - -* `pubkey` (string, required): The public key of the account that will receive the lamports, represented as a base-58 encoded string. -* `lamports` (integer, required): The number of lamports to airdrop. - -### Return Object - -The result is a string representing the transaction signature of the airdrop, as a base-58 encoded string. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "requestAirdrop", - "params": [ - "G35uLP74uj4eCSfMs17ePKtK1ThuH8JKebAP1T2y6CYw", - 1000000000 - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": "5VERv8NMvzbJMEkV8xnrLkEaWRtSz9CosKDYjCJjBRnbJLgp8uirBgmQpjKhoR4tjF3ZpRzrFmBV6UjKdiSZkQUW", - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/sendtransaction.md b/v1.0/RPC Nodes/others/rpc-solana/sendtransaction.md deleted file mode 100644 index 4be3d607..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/sendtransaction.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: "sendtransaction" -slug: "rpc-solana-sendtransaction" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const transaction = '4hXTCkRzt9WyecNzV1XPgCDfGAZzQKNxLXgynz5QDuWWPSAZBZSHptvWRL3BjCvzUXRdKvHL2b7yGrRQcWyaqsaBCncVG7BFggS8w9snUts67BSh3EqKpXLUm5UMHfD7ZBe9GhARjbNQMLJ1QD3Spr6oMTBU6EhdB4RD8CP2xUxr2u3d6fos36PD98XS6oX8TQjLpsMwncs5DAMiD4nNnR8NBfyghGCWvCVifVwvA8B8TJxE1aiyiv2L429BCWfyzAme5sZW8rDb14NeCQHhZbtNqfXhcp2tAnaAT' -const options = { - encoding: Encoding.Base58, - skipPreflight: false, - preflightCommitment: Commitment.Finalized, - maxRetries: 5, - minContextSlot: 10 -} // optional - -const res = await tatum.rpc.sendTransaction(transaction, options) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `sendTransaction` method is used to submit a fully signed transaction to the cluster for processing. This method does not alter the transaction in any way; it relays the transaction created by clients to the node as-is. A successful response from this method does not guarantee the transaction is processed or confirmed by the cluster. - -While the rpc service will reasonably retry to submit it, the transaction could be rejected if transaction's `recent_blockhash` expires before it lands. - -Use `getSignatureStatuses` to ensure a transaction is processed and confirmed. - -Before submitting, the following preflight checks are performed: - -1. The transaction signatures are verified -2. The transaction is simulated against the bank slot specified by the preflight commitment. On failure an error will be returned. Preflight checks may be disabled if desired. It is recommended to specify the same commitment and preflight commitment to avoid confusing behaviour. - -The returned signature is the first signature in the transaction, which is used to identify the transaction (transaction id). This identifier can be easily extracted from the transaction data before submission. - -### Parameters - -* `transaction`(string, required): Fully-signed Transaction, as an encoded string. - * Example: `'4hXTCkRzt9WyecNzV1XPgCDfGAZzQKNxLXgynz5QDuWWPSAZBZSHptvWRL3BjCvzUXRdKvHL2b7yGrRQcWyaqsaBCncVG7BFggS8w9snUts67BSh3EqKpXLUm5UMHfD7ZBe9GhARjbNQMLJ1QD3Spr6oMTBU6EhdB4RD8CP2xUxr2u3d6fos36PD98XS6oX8TQjLpsMwncs5DAMiD4nNnR8NBfyghGCWvCVifVwvA8B8TJxE1aiyiv2L429BCWfyzAme5sZW8rDb14NeCQHhZbtNqfXhcp2tAnaAT'` -* `options` (object, optional): An object containing various options for the request. - * `encoding` (string, optional): Encoding used for the transaction data. - * Values: `base58` (_slow_, **DEPRECATED**), or `base64`. - * `skipPreflight` (boolean, optional): If "true", skip the preflight transaction checks. - * `preflightCommitment`(string, optional): Commitment level to use for preflight. - * Values: `finalised` `confirmed` `processed` - * `maxRetries`(number, optional): Maximum number of times for the RPC node to retry sending the transaction to the leader. - * `minContextSlot` (number, optional): Set the minimum slot at which to perform preflight transaction checks. - -### Return Object - -The method returns a base-58 encoded `string` value which is the first Transaction Signature embedded in the transaction. This is used to identify the transaction. - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "sendTransaction", - "params": [ - "4hXTCkRzt9WyecNzV1XPgCDfGAZzQKNxLXgynz5QDuWWPSAZBZSHptvWRL3BjCvzUXRdKvHL2b7yGrRQcWyaqsaBCncVG7BFggS8w9snUts67BSh3EqKpXLUm5UMHfD7ZBe9GhARjbNQMLJ1QD3Spr6oMTBU6EhdB4RD8CP2xUxr2u3d6fos36PD98XS6oX8TQjLpsMwncs5DAMiD4nNnR8NBfyghGCWvCVifVwvA8B8TJxE1aiyiv2L429BCWfyzAme5sZW8rDb14NeCQHhZbtNqfXhcp2tAnaAT" - ] -} -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": "2id3YC2jK9G5Wo2phDx4gJVAew8DcY5NAojnVuao8rkxwPYPe8cSwE5GzhEgJA2y8fVjDEo6iR6ykBvDxrTQrtpb", - "id": 1 -} -``` diff --git a/v1.0/RPC Nodes/others/rpc-solana/simulatetransaction.md b/v1.0/RPC Nodes/others/rpc-solana/simulatetransaction.md deleted file mode 100644 index a7932eb1..00000000 --- a/v1.0/RPC Nodes/others/rpc-solana/simulatetransaction.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "simulatetransaction" -slug: "rpc-solana-simulatetransaction" -excerpt: "Solana RPC" -category: 65c5e93c623cad004b45d505 -hidden: false -metadata: - description: "Solana RPC" - image: [] - keywords: "solana, rpc" - robots: "index" -createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Tue Apr 02 2024 08:40:59 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 - -{% code overflow="wrap" lineNumbers="true" %} -```javascript -// yarn add @tatumio/tatum - -import { TatumSDK, Solana, Network } from '@tatumio/tatum' - -const tatum = await TatumSDK.init({ network: Network.SOLANA }) - -const transaction = 'AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAEDArczbMia1tLmq7zz4DinMNN0pJ1JtLdqIJPUw3YrGCzYAMHBsgN27lcgB6H2WQvFgyZuJYHa46puOQo9yQ8CVQbd9uHXZaGT2cvhRs7reawctIXtX1s3kTqM9YV+/wCp20C7Wj2aiuk5TReAXo+VTVg8QTHjs0UjNMMKCvpzZ+ABAgEBARU=' - -const options = { - encoding: 'base64' -} // optional - -const res = await tatum.rpc.simulateTransaction(transaction, options) - -await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs -``` -{% endcode %} - -### Overview - -The `simulateTransaction` method is used to simulate sending a transaction without actually submitting it to the cluster. This can be useful for debugging and testing purposes. - -### Parameters - -* `transaction`: (string, required) Transaction, as an encoded string. The transaction must have a valid blockhash, but is not required to be signed. -* `options` (object, optional): Configuration object containing various options for the request. This includes: - * `commitment` (string, optional): Commitment level to simulate the transaction at. Default is 'finalized'. - * Values: `finalised` `confirmed` `processed` - * `sigVerify` (boolean, optional): If `true`, the transaction signatures will be verified. This conflicts with `replaceRecentBlockhash`. - * `replaceRecentBlockhash` (boolean, optional): If `true`, the transaction's recent blockhash will be replaced with the most recent blockhash. This conflicts with `sigVerify`. - * `minContextSlot` (number, optional): The minimum slot that the request can be evaluated at. - * `encoding` (string, optional): Encoding used for the transaction data. Values can be `base58` or `base64`. Default is `base58`. - * `accounts` (object, optional): Accounts configuration object. This includes: - * `addresses`: (array of strings, optional) An array of accounts to return, as base-58 encoded strings. - * `encoding`: (string, optional) Encoding for returned Account data. Values can be `base64`, `base58`, `base64+zstd`, `jsonParsed`. - -### Return Object - -The method returns an `RpcResponse` object with `value` set to a JSON object with the following fields: - -* `err`: Error if transaction failed, null if transaction succeeded. -* `logs`: Array of log messages the transaction instructions output during execution. Null if simulation failed before the transaction was able to execute (for example due to an invalid blockhash or signature verification failure) -* `accounts`: Array of accounts with the same length as the `accounts.addresses` array in the request. Each Account object resolves to either: - * `null` - If the account doesn't exist or if `err` is not null - * `object` - Otherwise, a JSON object containing: - * `lamports:` Number of lamports assigned to this account, as a u64 - * `owner:` Base-58 encoded Pubkey of the program this account has been assigned to - * `data:` Data associated with the account, either as encoded binary data or JSON format `{: }` - depending on encoding parameter - * `executable:` Boolean indicating if the account contains a program (and is strictly read-only) - * `rentEpoch:` The epoch at which this account will next owe rent, as u64 -* `unitsConsumed`: The number of compute budget units consumed during the processing of this transaction. -* `returnData`: The most-recent return data generated by an instruction in the transaction - - with the following fields: - - * `programId:` The program that generated the return data, as base-58 encoded Pubkey - * `data:` The return data itself, as base-64 encoded binary data - -### JSON-RPC Request Example - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "method": "simulateTransaction", - "params": [ - "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAEDArczbMia1tLmq7zz4DinMNN0pJ1JtLdqIJPUw3YrGCzYAMHBsgN27lcgB6H2WQvFgyZuJYHa46puOQo9yQ8CVQbd9uHXZaGT2cvhRs7reawctIXtX1s3kTqM9YV+/wCp20C7Wj2aiuk5TReAXo+VTVg8QTHjs0UjNMMKCvpzZ+ABAgEBARU=", - { - "encoding": "base64" - } - ] -} - -``` - -### JSON-RPC Response Example - -```json -{ - "jsonrpc": "2.0", - "result": { - "context": { - "slot": 218 - }, - "value": { - "err": null, - "accounts": null, - "logs": [ - "Program 83astBRguLMdt2h5U1Tpdq5tjFoJ6noeGwaY3mDLVcri invoke [1]", - "Program 83astBRguLMdt2h5U1Tpdq5tjFoJ6noeGwaY3mDLVcri consumed 2366 of 1400000 compute units", - "Program return: 83astBRguLMdt2h5U1Tpdq5tjFoJ6noeGwaY3mDLVcri KgAAAAAAAAA=", - "Program 83astBRguLMdt2h5U1Tpdq5tjFoJ6noeGwaY3mDLVcri success" - ], - "returnData": { - "data": ["Kg==", "base64"], - "programId": "83astBRguLMdt2h5U1Tpdq5tjFoJ6noeGwaY3mDLVcri" - }, - "unitsConsumed": 2366 - } - }, - "id": 1 -} -``` - -\ diff --git a/v1.0/RPC Nodes/others/rpc-solana.md b/v1.0/RPC Nodes/others/rpc-stellar.md similarity index 85% rename from v1.0/RPC Nodes/others/rpc-solana.md rename to v1.0/RPC Nodes/others/rpc-stellar.md index 8e77f7a3..fbabba52 100644 --- a/v1.0/RPC Nodes/others/rpc-solana.md +++ b/v1.0/RPC Nodes/others/rpc-stellar.md @@ -1,6 +1,6 @@ --- -title: "Solana" -slug: "rpc-solana" +title: "Stellar" +slug: "rpc-stellar" excerpt: "" category: 65c5e93c623cad004b45d505 hidden: false diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAccount.md b/v1.0/RPC Nodes/others/rpc-stellar/getAccount.md new file mode 100644 index 00000000..af68b929 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAccount.md @@ -0,0 +1,155 @@ +--- +title: "getAccount" +slug: "rpc-stellar-getAccount" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define the account ID (Replace placeholder with the actual account ID) +const accountId = "YOUR_ACCOUNT_ID"; + +// Retrieve details of a specific account +const accountDetails = await tatum.rpc.getAccount(accountId); + +// Log the account details +console.log("Account Details:", accountDetails); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccount` method allows you to retrieve detailed information about a specific account. This includes information about balances and trustlines, including those that haven't been authorized yet. + +### Example use cases: + +1. **Account Information:** + Developers and applications can use this method to access detailed information about a specific account, including its balances and trustlines. + +2. **Trustline Analysis:** + You can use the response to analyze the trustlines established by the account, including those that haven't been authorized yet. + +### Request Parameters + +The `getAccount` method requires the following parameter: + +- `accountId` (string, required): + The unique identifier (account ID) of the account for which you want to retrieve details. + +### Return Object + +The `getAccount` method returns a JSON object containing details about the specified account, including balances, sponsorships, and other relevant information. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U" + }, + "transactions": { + "href": "https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/transactions{?cursor,limit,order}", + "templated": true + }, + "operations": { + "href": "https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/operations{?cursor,limit,order}", + "templated": true + }, + "payments": { + "href": "https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/payments{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/effects{?cursor,limit,order}", + "templated": true + }, + "offers": { + "href": "https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/offers{?cursor,limit,order}", + "templated": true + }, + "trades": { + "href": "https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/trades{?cursor,limit,order}", + "templated": true + }, + "data": { + "href": "https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/data/{key}", + "templated": true + } + }, + "id": "GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U", + "account_id": "GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U", + "sequence": "24739097524306468", + "subentry_count": 3, + "inflation_destination": "GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U", + "home_domain": "tempo.eu.com", + "last_modified_ledger": 23569316, + "num_sponsoring": 0, + "num_sponsored": 0, + "thresholds": { + "low_threshold": 5, + "med_threshold": 0, + "high_threshold": 0 + }, + "flags": { + "auth_required": false, + "auth_revocable": true, + "auth_immutable": false, + "auth_clawback_enabled": true + }, + "balances": [ + { + "balance": "1.0000005", + "limit": "922337203685.4775807", + "buying_liabilities": "0.0000000", + "selling_liabilities": "0.0000000", + "last_modified_ledger": 22651481, + "is_authorized": true, + "is_clawback_enabled": false, + "asset_type": "credit_alphanum4", + "asset_code": "EURT", + "asset_issuer": "GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S" + }, + { + "balance": "0.0000000", + "limit": "922337203685.4775807", + "buying_liabilities": "0.0000000", + "selling_liabilities": "0.0000000", + "last_modified_ledger": 7877447, + "is_authorized": false, + "is_clawback_enabled": false, + "asset_type": "credit_alphanum4", + "asset_code": "PHP", + "asset_issuer": "GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP" + } + ], + "signers": [ + { + "weight": 10, + "key": "GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U", + "type": "ed25519_public_key" + } + ], + "data": {}, + "paging_token": "" +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAccountData.md b/v1.0/RPC Nodes/others/rpc-stellar/getAccountData.md new file mode 100644 index 00000000..95329cb4 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAccountData.md @@ -0,0 +1,61 @@ +--- +title: "getAccountData" +slug: "rpc-stellar-getAccountData" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const params = { + accountId: "YOUR_ACCOUNT_ID", + key: "YOUR_DATA_KEY", +}; + +// Retrieve data for a specific key of a given account +const data = await tatum.rpc.getAccountData(params); + +// Log the data value +console.log("Account Data:", data.value); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountData` method allows you to retrieve a single data value for a specific key of a given account on the Stellar blockchain. Please note that the content and structure of the data returned can vary based on the specific use case and applications interacting with the Stellar blockchain. + +### Request Parameters + +The `getAccountData` method accepts the following request parameters: + +- `accountId` (string, required): + The unique identifier (account ID) of the account for which you want to retrieve data. + +- `key` (string, required): + The data key for which you want to retrieve the corresponding value. + +### Return Object + +The `getAccountData` method returns a JSON object with account data: + +`value` (string): +The value associated with the specified data key for the given account. diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAccountEffects.md b/v1.0/RPC Nodes/others/rpc-stellar/getAccountEffects.md new file mode 100644 index 00000000..32970752 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAccountEffects.md @@ -0,0 +1,113 @@ +--- +title: "getAccountEffects" +slug: "rpc-stellar-getAccountEffects" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const inputParams = { + accountId: "YOUR_ACCOUNT_ID", + cursor: "now", + order: "asc", + limit: 10, +}; + +// Retrieve effects of a specific account +const effects = await tatum.rpc.getAccountEffects(inputParams); + +// Log the list of effects +console.log("Account Effects:", effects); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountEffects` method allows you to retrieve the effects of a specific account on the Stellar blockchain. You can use this endpoint in streaming mode to listen for new effects for the specified account as they are added to the Stellar ledger. When called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. Setting the cursor value to 'now' allows you to stream effects created since your request time. + +### Request Parameters + +The `getAccountEffects` method accepts the following request parameters: + +- `accountId` (string, required): + The unique identifier (account ID) of the account for which you want to retrieve effects. + +- `cursor` (string, optional): + A cursor value that determines the starting point for retrieving effects. Set it to 'now' to stream effects created since your request time. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include 'asc' (ascending) or 'desc' (descending). If this argument isn’t set, it defaults to 'asc'. + +- `limit` (number, optional): + The maximum number of records returned. It defines the number of effects to fetch in a single request. + +### Return Object + +The `getAccountEffects` method returns a JSON object containing the list of effects associated with the specified account. Each effect represents an event that has occurred on the Stellar blockchain, such as the creation of an account, a payment, or other actions. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://.." + }, + "next": { + "href": "https://.." + }, + "prev": { + "href": "https://.." + } + }, + "_embedded": { + "records": [ + { + "_links": { + "operation": { + "href": "https://..." + }, + "succeeds": { + "href": "https://..." + }, + "precedes": { + "href": "https://..." + } + }, + "id": "0216517620744060929-0000000002", + "paging_token": "216517620744060929-2", + "account": "GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6", + "type": "claimable_balance_claimant_created", + "type_i": 51, + "created_at": "2024-02-17T14:03:50Z", + "asset": "ENIZ:GDLMUA4ZQSU3LMKEW7LETSIYLYMATTGVPXCHFRRTGQTF6K55XOQIENIZ", + "balance_id": "000000004c56a7b5e98e7d5225f37d27fbd93c4fe2f03b00d2c80d23771ae97e66f599c7", + "amount": "5000.0000000", + "predicate": { + "unconditional": true + } + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAccountOffers.md b/v1.0/RPC Nodes/others/rpc-stellar/getAccountOffers.md new file mode 100644 index 00000000..5ac6f33b --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAccountOffers.md @@ -0,0 +1,148 @@ +--- +title: "getAccountOffers" +slug: "rpc-stellar-getAccountOffers" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const params = { + accountId: "YOUR_ACCOUNT_ID", + cursor: "now", + order: "asc", + limit: 10, +}; + +// Retrieve all offers currently open for a given account +const offers = await tatum.rpc.getAccountOffers(params); + +// Log the list of offers +console.log("Account Offers:", offers); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountOffers` method allows you to retrieve all offers that a specific account has currently open on the Stellar blockchain. You can use this endpoint in streaming mode to listen for new offers for the specified account as they are added to the Stellar ledger. When called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. Setting the cursor value to 'now' allows you to stream offers created since your request time. + +### Request Parameters + +The `getAccountOffers` method accepts the following request parameters: + +- `accountId` (string, required): + The unique identifier (account ID) of the account for which you want to retrieve offers. + +- `cursor` (string, optional): + A cursor value that determines the starting point for retrieving offers. Set it to 'now' to stream offers created since your request time. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include 'asc' (ascending) or 'desc' (descending). If this argument isn’t set, it defaults to 'asc'. + +- `limit` (number, optional): + The maximum number of records returned. It defines the number of offers to fetch in a single request. + +### Return Object + +The `getAccountOffers` method returns a JSON object containing the list of offers associated with the specified account. Each offer represents an open order on the Stellar network, such as a trade offer to exchange one asset for another. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "value": { + "_links": { + "self": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164943216&limit=10&order=asc" + }, + "prev": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164555927&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://horizon.stellar.org/offers/164555927" + }, + "offer_maker": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K" + } + }, + "id": 164555927, + "paging_token": "164555927", + "seller": "GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K", + "selling": { + "asset_type": "native" + }, + "buying": { + "asset_type": "credit_alphanum4", + "asset_code": "BB1", + "asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN" + }, + "amount": "214.9999939", + "price_r": { + "n": 10000000, + "d": 86000001 + }, + "price": "0.1162791", + "last_modified_ledger": 28383147, + "last_modified_time": "2020-02-24T22:58:38Z" + }, + { + "_links": { + "self": { + "href": "https://horizon.stellar.org/offers/164943216" + }, + "offer_maker": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K" + } + }, + "id": 164943216, + "paging_token": "164943216", + "seller": "GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K", + "selling": { + "asset_type": "credit_alphanum4", + "asset_code": "BB1", + "asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN" + }, + "buying": { + "asset_type": "native" + }, + "amount": "24.9999990", + "price_r": { + "n": 32224991, + "d": 2500000 + }, + "price": "12.8899964", + "last_modified_ledger": 28394149, + "last_modified_time": "2020-02-25T15:49:57Z" + } + ] + } + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAccountOperations.md b/v1.0/RPC Nodes/others/rpc-stellar/getAccountOperations.md new file mode 100644 index 00000000..6cf44cbe --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAccountOperations.md @@ -0,0 +1,137 @@ +--- +title: "getAccountOperations" +slug: "rpc-stellar-getAccountOperations" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const params = { + accountId: "YOUR_ACCOUNT_ID", + cursor: "now", + order: "asc", + limit: 10, + includeFailed: true, + join: true, +}; + +// Retrieve successful operations for a given account +const operations = await tatum.rpc.getAccountOperations(params); + +// Log the list of operations +console.log("Account Operations:", operations); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountOperations` method allows you to retrieve successful operations for a given account on the Stellar blockchain. You can use this endpoint in streaming mode to listen for new operations for the specified account as they are added to the Stellar ledger. When called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. Setting the cursor value to 'now' allows you to stream operations created since your request time. + +### Request Parameters + +The `getAccountOperations` method accepts the following request parameters: + +- `accountId` (string, required): + The unique identifier (account ID) of the account for which you want to retrieve operations. + +- `cursor` (string, optional): + A cursor value that determines the starting point for retrieving operations. Set it to 'now' to stream operations created since your request time. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include 'asc' (ascending) or 'desc' (descending). If this argument isn’t set, it defaults to 'asc'. + +- `limit` (number, optional): + The maximum number of records returned. It defines the number of operations to fetch in a single request. + +- `includeFailed` (boolean, optional): + A flag to indicate whether to include failed operations in the results. Set to `true` to include failed operations. + +- `join` (boolean, optional): + A flag to indicate whether to join operation data with relevant accounts. Set to `true` to join operation data with accounts. + +### Return Object + +The `getAccountOperations` method returns a JSON object containing the list of operations associated with the specified account. Each operation may represent a variety of actions such as payments, account creations, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/operations?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/operations?cursor=216532408316960769&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/operations?cursor=216517620744060929&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/216517620744060929" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/8ed978ce9f9f2cfe245470a06e9d0ce178f0cc602fd2b8d5e6047192e13d7475" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/216517620744060929/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=216517620744060929" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=216517620744060929" + } + }, + "id": "216517620744060929", + "paging_token": "216517620744060929", + "transaction_successful": true, + "source_account": "GBOXZWWNZL3MQ7EP3KNL66WBVE4NH2UOLCMFKEKZFYQT5MOP2JDKENIZ", + "type": "create_claimable_balance", + "type_i": 14, + "created_at": "2024-02-17T14:03:50Z", + "transaction_hash": "8ed978ce9f9f2cfe245470a06e9d0ce178f0cc602fd2b8d5e6047192e13d7475", + "sponsor": "GBOXZWWNZL3MQ7EP3KNL66WBVE4NH2UOLCMFKEKZFYQT5MOP2JDKENIZ", + "asset": "ENIZ:GDLMUA4ZQSU3LMKEW7LETSIYLYMATTGVPXCHFRRTGQTF6K55XOQIENIZ", + "amount": "5000.0000000", + "claimants": [ + { + "destination": "GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6", + "predicate": { + "unconditional": true + } + }, + { + "destination": "GBOXZWWNZL3MQ7EP3KNL66WBVE4NH2UOLCMFKEKZFYQT5MOP2JDKENIZ", + "predicate": { + "unconditional": true + } + } + ] + } +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAccountPayments.md b/v1.0/RPC Nodes/others/rpc-stellar/getAccountPayments.md new file mode 100644 index 00000000..13ff9343 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAccountPayments.md @@ -0,0 +1,127 @@ +--- +title: "getAccountPayments" +slug: "rpc-stellar-getAccountPayments" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const params = { + accountId: "YOUR_ACCOUNT_ID", + cursor: "now", + order: "asc", + limit: 10, + includeFailed: true, + join: true, +}; + +// Retrieve successful payments for a given account +const payments = await tatum.rpc.getAccountPayments(params); + +// Log the list of payments +console.log("Account Payments:", payments); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountPayments` method allows you to retrieve successful payments for a given account on the Stellar blockchain. You can use this endpoint in streaming mode to listen for new payments for the specified account as they are added to the Stellar ledger. When called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. Setting the cursor value to 'now' allows you to stream payments created since your request time. + +### Request Parameters + +The `getAccountPayments` method accepts the following request parameters: + +- `accountId` (string, required): + The unique identifier (account ID) of the account for which you want to retrieve payments. + +- `cursor` (string, optional): + A cursor value that determines the starting point for retrieving payments. Set it to 'now' to stream payments created since your request time. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include 'asc' (ascending) or 'desc' (descending). If this argument isn’t set, it defaults to 'asc'. + +- `limit` (number, optional): + The maximum number of records returned. It defines the number of payments to fetch in a single request. + +- `includeFailed` (boolean, optional): + A flag to indicate whether to include failed payments in the results. Set to `true` to include failed payments. + +- `join` (boolean, optional): + A flag to indicate whether to join payment data with relevant accounts. Set to `true` to join payment data with accounts. + +### Return Object + +The `getAccountPayments` method returns a JSON object containing the list of payments associated with the specified account. Each payment includes details such as its source, destination, amount, and other relevant information. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/payments?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/payments?cursor=216532408316960769&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/payments?cursor=216518179090239489&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/216518179090239489" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/57d2fccfb885169155913177f74d390a6675fcc28ccab529b8848cfcb1882435" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/216518179090239489/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=216518179090239489" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=216518179090239489" + } + }, + "id": "216518179090239489", + "paging_token": "216518179090239489", + "transaction_successful": true, + "source_account": "GBOXZWWNZL3MQ7EP3KNL66WBVE4NH2UOLCMFKEKZFYQT5MOP2JDKENIZ", + "type": "payment", + "type_i": 1, + "created_at": "2024-02-17T14:16:35Z", + "transaction_hash": "57d2fccfb885169155913177f74d390a6675fcc28ccab529b8848cfcb1882435", + "asset_type": "native", + "from": "GBOXZWWNZL3MQ7EP3KNL66WBVE4NH2UOLCMFKEKZFYQT5MOP2JDKENIZ", + "to": "GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6", + "amount": "0.0000100" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAccountTrades.md b/v1.0/RPC Nodes/others/rpc-stellar/getAccountTrades.md new file mode 100644 index 00000000..0f0033e7 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAccountTrades.md @@ -0,0 +1,141 @@ +--- +title: "getAccountTrades" +slug: "rpc-stellar-getAccountTrades" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const params = { + accountId: "YOUR_ACCOUNT_ID", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// Retrieve all trades for a specific account +const trades = await tatum.rpc.getTradesByAccountId(params); + +// Log the list of trades +console.log("Trades:", trades); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountTrades` method allows you to retrieve all trades associated with a specific account on the Stellar blockchain. You can use this endpoint in streaming mode to listen for new trades as they are added to the Stellar ledger. When used in streaming mode, it starts at the earliest known trade unless a cursor is set, in which case it starts from that cursor. You can also set the cursor value to 'now' to stream trades created since your request time. + +### Request Parameters + +The `getAccountTrades` method accepts the following request parameters: + +- `accountId` (string, required): + The unique identifier (account ID) of the account for which you want to retrieve trades. + +- `cursor` (string, optional): + A cursor value that determines the starting point for pagination. Use this parameter to retrieve trades from a specific point in the trade list. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include 'asc' (ascending) or 'desc' (descending). If this argument isn’t set, it defaults to 'asc'. + +- `limit` (number, optional): + The maximum number of records returned. It defines the number of trades to fetch in a single request. + +### Return Object + +The `getAccountTrades` method returns a JSON object containing the list of trades associated with the specified account. Each trade is represented as an object with various properties describing its details. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "value": { + "_links": { + "self": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=&limit=3&order=asc" + }, + "next": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449584845914113-0&limit=3&order=asc" + }, + "prev": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449468881756161-0&limit=3&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "" + }, + "base": { + "href": "https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX" + }, + "counter": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K" + }, + "operation": { + "href": "https://horizon.stellar.org/operations/107449468881756161" + } + }, + "id": "107449468881756161-0", + "paging_token": "107449468881756161-0", + "ledger_close_time": "2019-07-26T09:17:02Z", + "trade_type": "orderbook", + "base_offer_id": "104078276", + "base_account": "GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX", + "base_amount": "4433.2000000", + "base_asset_type": "native", + "counter_offer_id": "4719135487309144065", + "counter_account": "GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K", + "counter_amount": "443.3200000", + "counter_asset_type": "credit_alphanum4", + "counter_asset_code": "BB1", + "counter_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN", + "base_is_seller": true, + "price": { + "n": "1", + "d": "10" + } + }, + { + "_links": { + "self": { + "href": "" + }, + "base": { + "href": "https://horizon.stellar.org/accounts/GCQDOTIILRG634IRWAODTUS6H6Q7VUUNKZINBDJOXGJFR7YZ57FGYV7B" + }, + "counter": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K" + }, + "operation": { + "href": "https://horizon.stellar.org/operations/107449486061649921" + } + } + } + ] + } + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAccountTransactions.md b/v1.0/RPC Nodes/others/rpc-stellar/getAccountTransactions.md new file mode 100644 index 00000000..cfbd660f --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAccountTransactions.md @@ -0,0 +1,160 @@ +--- +title: "getAccountTransactions" +slug: "rpc-stellar-getAccountTransactions" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const params = { + accountId: "YOUR_ACCOUNT_ID", + cursor: "now", + order: "asc", + limit: 10, + includeFailed: true, +}; + +// Retrieve successful transactions for a given account +const transactions = await tatum.rpc.getAccountTransactions(params); + +// Log the list of transactions +console.log("Account Transactions:", transactions); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountTransactions` method allows you to retrieve successful transactions for a given account on the Stellar blockchain. You can use this endpoint in streaming mode to listen for new transactions for the specified account as they are added to the Stellar ledger. When called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. Setting the cursor value to 'now' allows you to stream transactions created since your request time. + +### Example use cases: + +1. **Transaction History:** + Developers and applications can use this method to retrieve the transaction history for a specific Stellar account. + +2. **Real-time Transaction Monitoring:** + By using streaming mode with the appropriate cursor, you can monitor and react to new transactions in real-time. + +### Request Parameters + +The `getAccountTransactions` method accepts the following parameters: + +- `accountId` (string, required): + The unique identifier (account ID) of the account for which you want to retrieve transactions. + +- `cursor` (string, optional): + A cursor value that determines the starting point for retrieving transactions. Set it to 'now' to stream transactions created since your request time. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include 'asc' (ascending) or 'desc' (descending). If this argument isn’t set, it defaults to 'asc'. + +- `limit` (number, optional): + The maximum number of records returned. It defines the number of transactions to fetch in a single request. + +- `includeFailed` (boolean, optional): + A flag to indicate whether to include failed transactions in the results. Set to `true` to include failed transactions. + +### Return Object + +The `getAccountTransactions` method returns a JSON object containing the list of transactions associated with the specified account. Each transaction includes details such as its source, destination, amount, and other relevant information. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/transactions?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/transactions?cursor=216532408316960768&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/transactions?cursor=216517620744060928&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "memo": "Check ENIZ.IO Airdrop", + "memo_bytes": "Q2hlY2sgRU5JWi5JTyBBaXJkcm9w", + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/36de204075c7e3167e8f6d1ecc10d18c6277e2fea0ab983a894f16bb81bd5f16" + }, + "account": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GB5NGIDRDXRMBRSLT7FTZ47CBUZXCWL6LYOLBH6ZYCXR6NCNJTE2ENIZ" + }, + "ledger": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/50415380" + }, + "operations": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/36de204075c7e3167e8f6d1ecc10d18c6277e2fea0ab983a894f16bb81bd5f16/operations{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/36de204075c7e3167e8f6d1ecc10d18c6277e2fea0ab983a894f16bb81bd5f16/effects{?cursor,limit,order}", + "templated": true + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions?order=asc&cursor=216532408316960768" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions?order=desc&cursor=216532408316960768" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/36de204075c7e3167e8f6d1ecc10d18c6277e2fea0ab983a894f16bb81bd5f16" + } + }, + "id": "36de204075c7e3167e8f6d1ecc10d18c6277e2fea0ab983a894f16bb81bd5f16", + "paging_token": "216532408316960768", + "successful": true, + "hash": "36de204075c7e3167e8f6d1ecc10d18c6277e2fea0ab983a894f16bb81bd5f16", + "ledger": 50415380, + "created_at": "2024-02-17T19:44:28Z", + "source_account": "GB5NGIDRDXRMBRSLT7FTZ47CBUZXCWL6LYOLBH6ZYCXR6NCNJTE2ENIZ", + "source_account_sequence": "215074769429599166", + "fee_account": "GB5NGIDRDXRMBRSLT7FTZ47CBUZXCWL6LYOLBH6ZYCXR6NCNJTE2ENIZ", + "fee_charged": "10000", + "max_fee": "1000500", + "operation_count": 100, + "envelope_xdr": "Hex data", + "result_xdr": "Hex data", + "result_meta_xdr": "Hex data", + "fee_meta_xdr": "Hex data", + "memo_type": "text", + "signatures": [ + "yroAw0Hl/cWJymRofDN5jHkeknbBp8I5Uuq/+VGgAOL1bwVDEL7SHCYUcmCix96mIXUwln4yaeTb1v505AvtBA==" + ], + "valid_after": "1970-01-01T00:00:00Z", + "valid_before": "2024-02-17T19:45:53Z", + "preconditions": { + "timebounds": { + "min_time": "0", + "max_time": "1708199153" + } + } + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAccounts.md b/v1.0/RPC Nodes/others/rpc-stellar/getAccounts.md new file mode 100644 index 00000000..5c81dc75 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAccounts.md @@ -0,0 +1,195 @@ +--- +title: "getAccounts" +slug: "rpc-stellar-getAccounts" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define the account filters (Replace placeholders with actual values and remove redundant) +const filters: AccountFilters = { + sponsor: "YOUR_SPONSOR_ACCOUNT_ID", + asset: "YOUR_ASSET_CODE:ISSUER_ACCOUNT_ID", + signer: "YOUR_SIGNER_ACCOUNT_ID", + liquidityPool: "YOUR_LIQUIDITY_POOL_ID", + cursor: 6606617478959105, + order: "asc", + limit: 10, +}; + +// List accounts based on the specified filters +const accounts = await tatum.rpc.getAccounts(filters); + +// Log the list of accounts +console.log("List of Accounts:", accounts); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccounts` method allows you to retrieve a list of accounts based on various filters, including signer, asset, liquidity pool, or sponsor. + +**Please ensure that you are including a signer, sponsor, asset, or liquidity pool filter**. + +### Example use cases: + +1. **Account Filtering:** + Developers and applications can use this method to filter and retrieve accounts based on specific criteria, such as signer, asset, or sponsor. + +2. **Data Analysis:** + Researchers and analysts can utilize this endpoint to gather account data for analysis and reporting. + +3. **Pagination Support:** + The method supports pagination using the `cursor`, `order`, and `limit` parameters for efficient data retrieval. + +### Request Parameters + +The `getAccounts` method requires the following parameters in camelCase: + +- `sponsor` (string, optional): + Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID. + +- `asset` (string, optional): + An issued asset represented as "code:issuerAccountID". Every account in the response will have a trustline for the given asset. + +- `signer` (string, optional): + Account ID of the signer. Every account in the response will have the given account ID as a signer. + +- `liquidityPool` (string, optional): + With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool. + +- `cursor` (number, optional): + A number that points to a specific location in a collection of responses and is pulled from the `pagingToken` value of a record. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include "asc" (ascending) or "desc" (descending). If this argument isn’t set, it defaults to "asc". + +- `limit` (number, optional): + The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10. + +### Return Object + +The `getAccounts` method returns a list of accounts based on the provided filters. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://horizon.stellar.org/accounts?asset=USDC%3AGA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN&cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://horizon.stellar.org/accounts?asset=USDC%3AGA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN&cursor=GA223H7O26KC7NWDEH6R4D5ITI35I4R7BH5VDLPFTSKMWH2RUZD474TJ&limit=10&order=asc" + }, + "prev": { + "href": "https://horizon.stellar.org/accounts?asset=USDC%3AGA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN&cursor=GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://horizon.stellar.org/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6" + }, + "transactions": { + "href": "https://horizon.stellar.org/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/transactions{?cursor,limit,order}", + "templated": true + }, + "operations": { + "href": "https://horizon.stellar.org/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/operations{?cursor,limit,order}", + "templated": true + }, + "payments": { + "href": "https://horizon.stellar.org/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/payments{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://horizon.stellar.org/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/effects{?cursor,limit,order}", + "templated": true + }, + "offers": { + "href": "https://horizon.stellar.org/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/offers{?cursor,limit,order}", + "templated": true + }, + "trades": { + "href": "https://horizon.stellar.org/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/trades{?cursor,limit,order}", + "templated": true + }, + "data": { + "href": "https://horizon.stellar.org/accounts/GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6/data/{key}", + "templated": true + } + }, + "id": "GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6", + "account_id": "GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6", + "sequence": "194013564070002690", + "sequence_ledger": 45173210, + "sequence_time": "1677700612", + "subentry_count": 1, + "last_modified_ledger": 50415380, + "last_modified_time": "2024-02-17T19:44:28Z", + "thresholds": { + "low_threshold": 0, + "med_threshold": 0, + "high_threshold": 0 + }, + "flags": { + "auth_required": false, + "auth_revocable": false, + "auth_immutable": false, + "auth_clawback_enabled": false + }, + "balances": [ + { + "balance": "0.0000000", + "limit": "922337203685.4775807", + "buying_liabilities": "0.0000000", + "selling_liabilities": "0.0000000", + "last_modified_ledger": 45173210, + "is_authorized": true, + "is_authorized_to_maintain_liabilities": true, + "asset_type": "credit_alphanum4", + "asset_code": "USDC", + "asset_issuer": "GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN" + }, + { + "balance": "2.9975391", + "buying_liabilities": "0.0000000", + "selling_liabilities": "0.0000000", + "asset_type": "native" + } + ], + "signers": [ + { + "weight": 1, + "key": "GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6", + "type": "ed25519_public_key" + } + ], + "data": {}, + "num_sponsoring": 0, + "num_sponsored": 0, + "paging_token": "GA2224DCGO3WHC4EALA2PR2BZEMAYZPBPTHS243ZYYWQMBWRPJSZH5A6" + } +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getAssets.md b/v1.0/RPC Nodes/others/rpc-stellar/getAssets.md new file mode 100644 index 00000000..5bb319be --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getAssets.md @@ -0,0 +1,129 @@ +--- +title: "getAssets" +slug: "rpc-stellar-getAssets" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const inputParams = { + assetCode: "YOUR_ASSET_CODE", + assetIssuer: "YOUR_ASSET_ISSUER", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// Retrieve a list of all assets +const assets = await tatum.rpc.getAssets(inputParams); + +// Log the list of assets +console.log("Assets:", assets); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAssets` method allows you to retrieve a list of all assets on the Stellar blockchain. You can use various filtering options to narrow down the asset list based on asset code, asset issuer, cursor for pagination, sorting order, and limit for the number of records to be returned. + +### Request Parameters + +The `getAssets` method accepts the following request parameters: + +- `assetCode` (string, optional): + The asset code for filtering assets by code. Use this parameter to list assets with a specific code. + +- `assetIssuer` (string, optional): + The asset issuer for filtering assets by issuer. Use this parameter to list assets issued by a specific account. + +- `cursor` (string, optional): + A cursor value that determines the starting point for pagination. Use this parameter to retrieve assets from a specific point in the asset list. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include 'asc' (ascending) or 'desc' (descending). If this argument isn’t set, it defaults to 'asc'. + +- `limit` (number, optional): + The maximum number of records returned. It defines the number of assets to fetch in a single request. + +### Return Object + +The `getAssets` method returns a JSON object containing the list of assets that match the specified criteria. Each asset is represented as an object with various properties describing its characteristics. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/assets?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/assets?cursor=0001_GB7L7CB7F5R7GXXI2VY3AUHDIBGWHUB2SAYO7NPERUCQO4F35G62DBAR_credit_alphanum4&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/assets?cursor=0_GBBJZOYEGLOCW32Q4ZGWRWQ7UKIGMMIQXIRBBBOVJVFJTZW7CR2VQKAT_credit_alphanum4&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "toml": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/.well-known/stellar.toml" + } + }, + "asset_type": "credit_alphanum4", + "asset_code": "0", + "asset_issuer": "GBBJZOYEGLOCW32Q4ZGWRWQ7UKIGMMIQXIRBBBOVJVFJTZW7CR2VQKAT", + "paging_token": "0_GBBJZOYEGLOCW32Q4ZGWRWQ7UKIGMMIQXIRBBBOVJVFJTZW7CR2VQKAT_credit_alphanum4", + "num_accounts": 24, + "num_claimable_balances": 0, + "num_liquidity_pools": 0, + "num_contracts": 0, + "num_archived_contracts": 0, + "amount": "998.9481303", + "accounts": { + "authorized": 24, + "authorized_to_maintain_liabilities": 0, + "unauthorized": 0 + }, + "claimable_balances_amount": "0.0000000", + "liquidity_pools_amount": "0.0000000", + "contracts_amount": "0.0000000", + "archived_contracts_amount": "0.0000000", + "balances": { + "authorized": "998.9481303", + "authorized_to_maintain_liabilities": "0.0000000", + "unauthorized": "0.0000000" + }, + "flags": { + "auth_required": false, + "auth_revocable": false, + "auth_immutable": false, + "auth_clawback_enabled": false + } + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getClaimableBalance.md b/v1.0/RPC Nodes/others/rpc-stellar/getClaimableBalance.md new file mode 100644 index 00000000..e36f491a --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getClaimableBalance.md @@ -0,0 +1,109 @@ +--- +title: "getClaimableBalance" +slug: "rpc-stellar-getClaimableBalance" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define the claimable balance ID (Replace 'YOUR_CLAIMABLE_BALANCE_ID' with the actual claimable balance ID) +const claimableBalanceId = "YOUR_CLAIMABLE_BALANCE_ID"; + +// Retrieve information about a specific claimable balance +const claimableBalance = await tatum.rpc.getClaimableBalance( + claimableBalanceId +); + +// Log the claimable balance details +console.log("Claimable Balance:", claimableBalance); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getClaimableBalance` method allows you to retrieve information about a specific claimable balance on the Stellar blockchain. You need to provide the claimable balance ID to identify the balance you want to retrieve. + +### Request Parameters + +The `getClaimableBalance` method accepts the following request parameters: + +- `claimableBalanceId` (string, required): + The unique identifier of the claimable balance you want to retrieve. + +### Return Object + +The `getClaimableBalance` method returns a JSON object containing the details of the requested claimable balance. The object includes various properties describing the characteristics of the claimable balance. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances?cursor=33494305-000000006f6cd6031f3e4fcdfb795412cc0f1ffd45663098691f5eff88ff9b6cff1006a0&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances?cursor=32747318-00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9" + }, + "transactions": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions{?cursor,limit,order}", + "templated": true + }, + "operations": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations{?cursor,limit,order}", + "templated": true + } + }, + "id": "00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9", + "asset": "BODHI:GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF", + "amount": "0.1000000", + "sponsor": "GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF", + "last_modified_ledger": 32747318, + "last_modified_time": null, + "claimants": [ + { + "destination": "GBEUDKANIFPTFHPWJ5T3R6RIO36RQBFGHYPAQ6STH7KMNDHAT36LHOLD", + "predicate": { + "unconditional": true + } + } + ], + "flags": { + "clawback_enabled": false + }, + "paging_token": "32747318-00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getClaimableBalances.md b/v1.0/RPC Nodes/others/rpc-stellar/getClaimableBalances.md new file mode 100644 index 00000000..556d8a6e --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getClaimableBalances.md @@ -0,0 +1,129 @@ +--- +title: "getClaimableBalances" +slug: "rpc-stellar-getClaimableBalances" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const params = { + sponsor: "YOUR_SPONSOR_ACCOUNT_ID", + asset: "YOUR_ASSET", + claimant: "YOUR_CLAIMANT_ACCOUNT_ID", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// Retrieve a list of all claimable balances +const claimableBalances = await tatum.rpc.getClaimableBalances(params); + +// Log the list of claimable balances +console.log("Claimable Balances:", claimableBalances); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getClaimableBalances` method allows you to retrieve a list of all available claimable balances on the Stellar blockchain. You can use various filtering options to narrow down the list based on the sponsor account, asset code, claimant account, cursor for pagination, sorting order, and limit for the number of records to be returned. + +### Request Parameters + +The `getClaimableBalances` method accepts the following request parameters: + +- `sponsor` (string, optional): + The account ID of the sponsor to filter claimable balances. Use this parameter to list claimable balances sponsored by a specific account. + +- `asset` (string, optional): + The asset code to filter claimable balances. Use this parameter to list claimable balances associated with a specific asset. + +- `claimant` (string, optional): + The account ID of the claimant to filter claimable balances. Use this parameter to list claimable balances claimable by a specific account. + +- `cursor` (string, optional): + A cursor value that determines the starting point for pagination. Use this parameter to retrieve claimable balances from a specific point in the list. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include 'asc' (ascending) or 'desc' (descending). If this argument isn’t set, it defaults to 'asc'. + +- `limit` (number, optional): + The maximum number of records returned. It defines the number of claimable balances to fetch in a single request. + +### Return Object + +The `getClaimableBalances` method returns a JSON object containing the list of claimable balances that match the specified criteria. Each claimable balance is represented as an object with various properties describing its characteristics. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances?cursor=33494305-000000006f6cd6031f3e4fcdfb795412cc0f1ffd45663098691f5eff88ff9b6cff1006a0&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances?cursor=32747318-00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9" + }, + "transactions": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions{?cursor,limit,order}", + "templated": true + }, + "operations": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations{?cursor,limit,order}", + "templated": true + } + }, + "id": "00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9", + "asset": "BODHI:GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF", + "amount": "0.1000000", + "sponsor": "GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF", + "last_modified_ledger": 32747318, + "last_modified_time": null, + "claimants": [ + { + "destination": "GBEUDKANIFPTFHPWJ5T3R6RIO36RQBFGHYPAQ6STH7KMNDHAT36LHOLD", + "predicate": { + "unconditional": true + } + } + ], + "flags": { + "clawback_enabled": false + }, + "paging_token": "32747318-00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getEffects.md b/v1.0/RPC Nodes/others/rpc-stellar/getEffects.md new file mode 100644 index 00000000..2cdb2567 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getEffects.md @@ -0,0 +1,112 @@ +--- +title: "getEffects" +slug: "rpc-stellar-getEffects" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// List all effects +const effects = await tatum.rpc.getEffects(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getEffects` method allows you to list all effects in the Stellar blockchain. Effects represent events or actions that have occurred on the network, such as payments, offers, and trustline changes. + +### Example use cases: + +1. **Effect Monitoring:** + Developers and applications can use this method to monitor and retrieve information about all effects on the Stellar network. + +2. **Streaming Effects:** + Users can use streaming mode to listen for real-time updates to effects as they are added to the Stellar ledger. + +### Request Parameters + +The `getEffects` method accepts a `params` object with the following properties: + +- `cursor` (string, optional): + An optional cursor to start listing effects from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of effects to return. The limit can range from 1 to 200. + +### Return Object + +The `getEffects` method returns an array of effects from the Stellar blockchain. Each effect object contains information about the effect type, details, and related transaction. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?cursor=215271955673288705-1&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?cursor=215271955673169921-1&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "operation": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215271955673169921" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=215271955673169921-1" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=215271955673169921-1" + } + }, + "id": "0215271955673169921-0000000001", + "paging_token": "215271955673169921-1", + "account": "GCEETSI6ZGG3CS37YUFAUKCCJSCOILXL43JOJVZ435KBJ5NICDYY4EMP", + "type": "account_credited", + "type_i": 2, + "created_at": "2024-01-28T14:07:11Z", + "asset_type": "credit_alphanum4", + "asset_code": "yXLM", + "asset_issuer": "GARDNV3Q7YGT4AKSDF25LT32YSCCW4EV22Y2TV3I2PU2MMXJTEDL5T55", + "amount": "1.0291984" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getFeeStats.md b/v1.0/RPC Nodes/others/rpc-stellar/getFeeStats.md new file mode 100644 index 00000000..147c7f9e --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getFeeStats.md @@ -0,0 +1,84 @@ +--- +title: "getFeeStats" +slug: "rpc-stellar-getFeeStats" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Retrieve fee statistics +const feeStats = await tatum.rpc.getFeeStats(); + +// Log the fee statistics +console.log("Fee Statistics:", feeStats); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getFeeStats` method allows you to retrieve information about per-operation fee statistics over the last 5 ledgers on the Stellar blockchain. + +### Return Object + +The `getFeeStats` method returns a JSON object containing fee statistics for various operations. The structure of the returned object is defined by the `FeeStats` schema. + +(Note: The exact fields in the return object may vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "last_ledger": "50744146", + "last_ledger_base_fee": "100", + "ledger_capacity_usage": "0.58", + "fee_charged": { + "max": "100", + "min": "100", + "mode": "100", + "p10": "100", + "p20": "100", + "p30": "100", + "p40": "100", + "p50": "100", + "p60": "100", + "p70": "100", + "p80": "100", + "p90": "100", + "p95": "100", + "p99": "100" + }, + "max_fee": { + "max": "369592103", + "min": "100", + "mode": "100", + "p10": "100", + "p20": "100", + "p30": "100", + "p40": "1000", + "p50": "20000", + "p60": "51234", + "p70": "51234", + "p80": "100159", + "p90": "250005", + "p95": "500000", + "p99": "358388826" + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLedger.md b/v1.0/RPC Nodes/others/rpc-stellar/getLedger.md new file mode 100644 index 00000000..cbe45c0e --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLedger.md @@ -0,0 +1,97 @@ +--- +title: "getLedger" +slug: "rpc-stellar-getLedger" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define the sequence number of the ledger to retrieve (Replace placeholders with actual values and remove redundant) +const sequenceNumber = "YOUR_SEQUENCE_NUMBER"; + +// Retrieve information about a specific ledger using its sequence number +const ledgerInfo = await tatum.rpc.getLedger(sequenceNumber); + +// Log the ledger information +console.log("Ledger Info:", ledgerInfo); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLedger` method allows you to retrieve information about a specific ledger on the Stellar blockchain. You can specify the ledger you want to retrieve by providing its sequence number as a parameter. + +### Request Parameters + +The `getLedger` method requires the following request parameter: + +- `sequence` (string, required): + The sequence number of the ledger you want to retrieve. This uniquely identifies the ledger you're interested in. + +### Return Object + +The `getLedger` method returns a JSON object containing information about the specified ledger. The returned object includes various properties describing the ledger's characteristics, such as its sequence number, transaction count, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908" + }, + "transactions": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/transactions{?cursor,limit,order}", + "templated": true + }, + "operations": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/operations{?cursor,limit,order}", + "templated": true + }, + "payments": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/payments{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/effects{?cursor,limit,order}", + "templated": true + } + }, + "id": "377342fc7d2d3e8e8aebcc2bd069cebce97ef59142afcf3834187e27670b69e5", + "paging_token": "214305588031520768", + "hash": "377342fc7d2d3e8e8aebcc2bd069cebce97ef59142afcf3834187e27670b69e5", + "prev_hash": "64b283aa8f123102b27334c9b0b4d0ba7baca635bc0fdee2471762755185fc8d", + "sequence": 49896908, + "successful_transaction_count": 122, + "failed_transaction_count": 16, + "operation_count": 422, + "tx_set_operation_count": 444, + "closed_at": "2024-01-13T08:44:04Z", + "total_coins": "105443902087.3472865", + "fee_pool": "4352705.3880757", + "base_fee_in_stroops": 100, + "base_reserve_in_stroops": 5000000, + "max_tx_set_size": 1000, + "protocol_version": 19, + "header_xdr": "AAAAE2Syg6qPEjECsnM0ybC00Lp7rKY1vA/e4kcXYnVRhfyNp1FbP/TkMcsgPzxpkwmSanCPlHIkEEdIUluDz3RuOMAAAAAAZaJNVAAAAAAAAAABAAAAAJnoMfsa4vmDNtUy8T76WXcr2up7H7MouQjkXcMmro3YAAAAQOWiXUUgvk9prIYO2MowcNsSmp7gJ2pDeKstCpOS1JDvEGry7E0EIA2uNNuQicQkF0LPkzibuNqFIrRAlS3qwQt2V4R3dnRsy/hBIt5wz7oIBqVZNDN+w21lovTVBGxHHh5McTecKdm6+JSPeLr+qWjW8QFh7Z8+TOcgCjAtJkI1AvldzA6iHrPseVthAAAnlm6VrbUAAAEWAAAAAFZtQfcAAABkAExLQAAAA+jlo5p0S2VRLG/2qoS2AHIAqWpkozbDmPnGixgTrfRM4EhakDMvJGA2NlrXaNdrDghS8gBVmir/lvjB5aIM8CqaNZ3+bNIMjENN35Wl0SqvmRPHm1ba+rIkuDOUxRhPT5cTHtTJQ8xzm+/8UT+eTL84VX2S5mxKeyMkTW+VYnrVPwAAAAA=" +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLedgerEffects.md b/v1.0/RPC Nodes/others/rpc-stellar/getLedgerEffects.md new file mode 100644 index 00000000..8edb5816 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLedgerEffects.md @@ -0,0 +1,108 @@ +--- +title: "getLedgerEffects" +slug: "rpc-stellar-getLedgerEffects" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define the ledger sequence number and optional parameters (Replace placeholders with actual values and remove redundant) +const params = { + sequence: "YOUR_LEDGER_SEQUENCE", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// Retrieve effects related to a specific ledger +const ledgerEffects = await tatum.rpc.getLedgersEffects(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLedgersEffects` method allows you to retrieve the effects of a specific Stellar ledger. + +### Example use cases: + +1. **Transaction Analysis:** Developers and applications can use this method to analyze the effects related to transactions and operations within a specific ledger. +2. **Transaction Tracking:** Tracking and monitoring the effects of operations within a specific ledger for auditing or analysis purposes. +3. **Historical Data Retrieval:** Researchers and analysts can retrieve effect-related data for historical analysis and record-keeping. + +### Request Parameters + +The `getLedgersEffects` method requires the following parameters: + +- `sequence` (string, required): The sequence number of the ledger for which you want to retrieve effects. +- `cursor` (string, optional): An optional cursor to start listing effects from a specific point within the ledger. +- `order` (string, optional): An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. +- `limit` (number, optional): An optional parameter to specify the maximum number of effects to return. The limit can range from 1 to 200. + +### Return Object + +The `getLedgersEffects` method returns an array of effects related to the specified ledger. Each effect includes details such as the type, account, operation, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/effects?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/effects?cursor=214305588031623169-6&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/effects?cursor=214305588031610881-1&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "operation": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031610881" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031610881-1" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031610881-1" + } + }, + "id": "0214305588031610881-0000000001", + "paging_token": "214305588031610881-1", + "account": "GC2ATEL4K2O5BJO7Z76MYSV6TKHCROKV5GXEOU7NO2TUEOOMFDDIPWID", + "type": "trustline_flags_updated", + "type_i": 26, + "created_at": "2024-01-13T08:44:04Z", + "asset_type": "credit_alphanum4", + "asset_code": "USD", + "asset_issuer": "GC2ATEL4K2O5BJO7Z76MYSV6TKHCROKV5GXEOU7NO2TUEOOMFDDIPWID", + "trustor": "GDFQ5USFBAUR2XEKCC7Z6VBEN5TJJH7TZPFKNHR47RCW36NCO3RQ5U5T", + "authorized_flag": true + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLedgerOperations.md b/v1.0/RPC Nodes/others/rpc-stellar/getLedgerOperations.md new file mode 100644 index 00000000..ac745510 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLedgerOperations.md @@ -0,0 +1,142 @@ +--- +title: "getLedgerOperations" +slug: "rpc-stellar-getLedgerOperations" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define the ledger sequence number and optional parameters (Replace placeholders with actual values and remove redundant) +const params = { + sequence: "YOUR_LEDGER_SEQUENCE", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, + includeFailed: true, + join: "inner", +}; + +// Retrieve successful operations related to a specific ledger +const ledgerOperations = await tatum.rpc.getLedgersOperations(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLedgersOperations` method allows you to retrieve successful operations in a specific Stellar ledger. + +### Example use cases: + +1. **Transaction Analysis:** + Developers and applications can use this method to analyze successful operations within a specific ledger, including operations like payments, account creation, and more. + +2. **Transaction Tracking:** + Tracking and monitoring successful operations made within a specific ledger for auditing or analysis purposes. + +3. **Historical Data Retrieval:** + Researchers and analysts can retrieve operation-related data for historical analysis and record-keeping. + +### Request Parameters + +The `getLedgersOperations` method requires the following parameters: + +- `sequence` (string, required): + The sequence number of the ledger for which you want to retrieve successful operations. + +- `cursor` (string, optional): + An optional cursor to start listing operations from a specific point within the ledger. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of operations to return. The limit can range from 1 to 200. + +- `includeFailed` (boolean, optional): + An optional parameter to include failed operations in the results (true or false). If not provided, it defaults to 'false'. + +- `join` (string, optional): + An optional parameter to specify the join type (inner or left). If not provided, it defaults to 'inner'. + +### Return Object + +The `getLedgersOperations` method returns an array of successful operations within the specified ledger. Each operation includes details such as the source account, operation type, asset, amount, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/operations?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/operations?cursor=214305588031541254&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/operations?cursor=214305588031524865&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031524865" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/83e580608afbc0d269107dd92629ae5be4a039c2751896bdf8e357a9cd947ea4" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031524865/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031524865" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031524865" + } + }, + "id": "214305588031524865", + "paging_token": "214305588031524865", + "transaction_successful": true, + "source_account": "GAZCCHIATB5Z6ATORF46EDXRUKVDNGHOFL3NKG7Y577NBTSOWMJX2DOS", + "type": "manage_buy_offer", + "type_i": 12, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "83e580608afbc0d269107dd92629ae5be4a039c2751896bdf8e357a9cd947ea4", + "amount": "105606.5780934", + "price": "0.0094863", + "price_r": { + "n": 94863, + "d": 10000000 + }, + "buying_asset_type": "credit_alphanum4", + "buying_asset_code": "SSLX", + "buying_asset_issuer": "GBHFGY3ZNEJWLNO4LBUKLYOCEK4V7ENEBJGPRHHX7JU47GWHBREH37UR", + "selling_asset_type": "native", + "offer_id": "1449752262" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLedgerPayments.md b/v1.0/RPC Nodes/others/rpc-stellar/getLedgerPayments.md new file mode 100644 index 00000000..d67620f8 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLedgerPayments.md @@ -0,0 +1,467 @@ +--- +title: "getLedgerPayments" +slug: "rpc-stellar-getLedgerPayments" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define the ledger sequence number and optional parameters (Replace placeholders with actual values and remove redundant) +const params = { + sequence: 'YOUR_LEDGER_SEQUENCE', + cursor: 'YOUR_CURSOR', + order: 'asc', + limit: 10, + includeFailed: true + join: 'inner', +}; + +// Retrieve payments related to a specific ledger +const ledgerPayments = await tatum.rpc.getLedgersPayments(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLedgersPayments` method allows you to retrieve all payment-related operations in a specific Stellar ledger. This includes operations such as `create_account`, `payment`, `path_payment`, and `account_merge`. + +### Example use cases: + +1. **Payment Analysis:** Developers and applications can use this method to analyze payment-related operations within a specific ledger. +2. **Transaction Tracking:** Tracking and monitoring payments made within a specific ledger for auditing or analysis purposes. +3. **Historical Data Retrieval:** Researchers and analysts can retrieve payment-related data for historical analysis and record-keeping. + +### Request Parameters + +The `getLedgersPayments` method requires the following parameters: + +- `sequence` (string, required): The sequence number of the ledger for which you want to retrieve payment-related operations. +- `cursor` (string, optional): An optional cursor to start listing payments from a specific point within the ledger. +- `order` (string, optional): An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. +- `limit` (number, optional): An optional parameter to specify the maximum number of payments to return. The limit can range from 1 to 200. +- `includeFailed` (boolean, optional): An optional parameter to include failed payments in the results (true or false). If not provided, it defaults to 'false'. +- `join` (string, optional): An optional parameter to specify the join type (inner or left). If not provided, it defaults to 'inner'. + +### Return Object + +The `getLedgersPayments` method returns an array of payment-related operations within the specified ledger. Each operation includes details such as the sender, receiver, asset, amount, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/payments?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/payments?cursor=214305588031754246&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/payments?cursor=214305588031623169&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031623169" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/97181f9964085703256e88c1e093fb28b329b7d0dfcf727221b2e957c33301ba" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031623169/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031623169" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031623169" + } + }, + "id": "214305588031623169", + "paging_token": "214305588031623169", + "transaction_successful": true, + "source_account": "GA4QH4AJGERVYX4PBY55JYTQJ4RTLJIBYV7OCYIV56LWZE5MVDH3R3UQ", + "type": "path_payment_strict_receive", + "type_i": 2, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "97181f9964085703256e88c1e093fb28b329b7d0dfcf727221b2e957c33301ba", + "asset_type": "native", + "from": "GA4QH4AJGERVYX4PBY55JYTQJ4RTLJIBYV7OCYIV56LWZE5MVDH3R3UQ", + "to": "GA4QH4AJGERVYX4PBY55JYTQJ4RTLJIBYV7OCYIV56LWZE5MVDH3R3UQ", + "amount": "0.0961919", + "path": [ + { + "asset_type": "credit_alphanum4", + "asset_code": "MOBI", + "asset_issuer": "GA6HCMBLTZS5VYYBCATRBRZ3BZJMAFUDKYYF6AH6MVCMGWMRDNSWJPIH" + }, + { + "asset_type": "credit_alphanum12", + "asset_code": "DOGET", + "asset_issuer": "GDOEVDDBU6OBWKL7VHDAOKD77UP4DKHQYKOKJJT5PR3WRDBTX35HUEUX" + }, + { + "asset_type": "credit_alphanum4", + "asset_code": "HODL", + "asset_issuer": "GAQEDFS2JK6JSQO53DWT23TGOLH5ZUZG4O3MNLF3CFUZWEJ6M7MMGJAV" + } + ], + "source_amount": "0.0959902", + "source_max": "0.0961919", + "source_asset_type": "native" + }, + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031696897" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/3047186e18a70351c5ec795a33fb97f4c466773df72d0540f0b5bc0332402153" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031696897/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031696897" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031696897" + } + }, + "id": "214305588031696897", + "paging_token": "214305588031696897", + "transaction_successful": true, + "source_account": "GAT7RNROHRNZG7RVOU4G6ODYP7C7QSV7N64BBFVB5U3J2RCZOGAUPBKO", + "type": "path_payment_strict_receive", + "type_i": 2, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "3047186e18a70351c5ec795a33fb97f4c466773df72d0540f0b5bc0332402153", + "asset_type": "credit_alphanum4", + "asset_code": "MOBI", + "asset_issuer": "GA6HCMBLTZS5VYYBCATRBRZ3BZJMAFUDKYYF6AH6MVCMGWMRDNSWJPIH", + "from": "GAT7RNROHRNZG7RVOU4G6ODYP7C7QSV7N64BBFVB5U3J2RCZOGAUPBKO", + "to": "GAT7RNROHRNZG7RVOU4G6ODYP7C7QSV7N64BBFVB5U3J2RCZOGAUPBKO", + "amount": "4.6175312", + "path": [ + { + "asset_type": "credit_alphanum4", + "asset_code": "USDC", + "asset_issuer": "GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN" + }, + { + "asset_type": "native" + } + ], + "source_amount": "4.6142496", + "source_max": "4.6175304", + "source_asset_type": "credit_alphanum4", + "source_asset_code": "MOBI", + "source_asset_issuer": "GA6HCMBLTZS5VYYBCATRBRZ3BZJMAFUDKYYF6AH6MVCMGWMRDNSWJPIH" + }, + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031709185" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/53dad14d0f7cd496edf2b5f6fb66e6aa423f8b79637f8f2558c954cc0a03f942" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031709185/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031709185" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031709185" + } + }, + "id": "214305588031709185", + "paging_token": "214305588031709185", + "transaction_successful": true, + "source_account": "GBDFUEX5ULIO54S5IYRNNORXI265GVYXXXEYUAEHCVQF2XWA7WJONRJT", + "type": "payment", + "type_i": 1, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "53dad14d0f7cd496edf2b5f6fb66e6aa423f8b79637f8f2558c954cc0a03f942", + "asset_type": "native", + "from": "GBDFUEX5ULIO54S5IYRNNORXI265GVYXXXEYUAEHCVQF2XWA7WJONRJT", + "to": "GC5SCPJLHX6WFLUG2GF2W57R4LQ4QUEJEXFOXSZTBSGNUD6RJW2ZX4D3", + "amount": "50.0000000" + }, + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031721473" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/1097e158b818ee82dc358ee88f7428b81590546aefd78904ee57bf49cdcbbe41" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031721473/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031721473" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031721473" + } + }, + "id": "214305588031721473", + "paging_token": "214305588031721473", + "transaction_successful": true, + "source_account": "GA4QH4AJGERVYX4PBY55JYTQJ4RTLJIBYV7OCYIV56LWZE5MVDH3R3UQ", + "type": "path_payment_strict_receive", + "type_i": 2, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "1097e158b818ee82dc358ee88f7428b81590546aefd78904ee57bf49cdcbbe41", + "asset_type": "native", + "from": "GA4QH4AJGERVYX4PBY55JYTQJ4RTLJIBYV7OCYIV56LWZE5MVDH3R3UQ", + "to": "GA4QH4AJGERVYX4PBY55JYTQJ4RTLJIBYV7OCYIV56LWZE5MVDH3R3UQ", + "amount": "0.0509312", + "path": [ + { + "asset_type": "credit_alphanum4", + "asset_code": "MOBI", + "asset_issuer": "GA6HCMBLTZS5VYYBCATRBRZ3BZJMAFUDKYYF6AH6MVCMGWMRDNSWJPIH" + }, + { + "asset_type": "credit_alphanum12", + "asset_code": "LIBRE", + "asset_issuer": "GAYCCWKECNGDRHYU3UTREBD2XLC3CUQN6FV22TKM4WCQER3IWR7TF5CY" + }, + { + "asset_type": "credit_alphanum4", + "asset_code": "NLT", + "asset_issuer": "GAX25ZVO4JVPEDK3R7EUFCGVI5XCOQGMVGQNZVFLGY2RWTBIQBW2ZNLT" + } + ], + "source_amount": "0.0506995", + "source_max": "0.0509312", + "source_asset_type": "native" + }, + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754241" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754241/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031754241" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031754241" + } + }, + "id": "214305588031754241", + "paging_token": "214305588031754241", + "transaction_successful": true, + "source_account": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "type": "payment", + "type_i": 1, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571", + "asset_type": "credit_alphanum4", + "asset_code": "SSLX", + "asset_issuer": "GBHFGY3ZNEJWLNO4LBUKLYOCEK4V7ENEBJGPRHHX7JU47GWHBREH37UR", + "from": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "to": "GCP4FHBWMDMV73LUOENECG6HYR3SXZ4KUB2S4FIGCAWZL7ZQDA27PSYC", + "amount": "0.0100000" + }, + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754242" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754242/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031754242" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031754242" + } + }, + "id": "214305588031754242", + "paging_token": "214305588031754242", + "transaction_successful": true, + "source_account": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "type": "payment", + "type_i": 1, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571", + "asset_type": "credit_alphanum4", + "asset_code": "SSLX", + "asset_issuer": "GBHFGY3ZNEJWLNO4LBUKLYOCEK4V7ENEBJGPRHHX7JU47GWHBREH37UR", + "from": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "to": "GCP4DTPJ346VZDN3WMKZVGVTW73Q5J4SOCYHE23SBI3XSYMMPWZLGCTP", + "amount": "0.0100000" + }, + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754243" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754243/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031754243" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031754243" + } + }, + "id": "214305588031754243", + "paging_token": "214305588031754243", + "transaction_successful": true, + "source_account": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "type": "payment", + "type_i": 1, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571", + "asset_type": "credit_alphanum4", + "asset_code": "SSLX", + "asset_issuer": "GBHFGY3ZNEJWLNO4LBUKLYOCEK4V7ENEBJGPRHHX7JU47GWHBREH37UR", + "from": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "to": "GCP4BVXCBHJJNZ3F6N7CSGZ6TMXAKKGENFSGLWFP7BRSCS77X3XI6RTN", + "amount": "0.0100000" + }, + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754244" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754244/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031754244" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031754244" + } + }, + "id": "214305588031754244", + "paging_token": "214305588031754244", + "transaction_successful": true, + "source_account": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "type": "payment", + "type_i": 1, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571", + "asset_type": "credit_alphanum4", + "asset_code": "SSLX", + "asset_issuer": "GBHFGY3ZNEJWLNO4LBUKLYOCEK4V7ENEBJGPRHHX7JU47GWHBREH37UR", + "from": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "to": "GCP4AQ2H5R2ZPL6VZMD5UTXIBALY47SE2TWE4LOIUPZEDYTSHCQXWQB6", + "amount": "0.0100000" + }, + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754245" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754245/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031754245" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031754245" + } + }, + "id": "214305588031754245", + "paging_token": "214305588031754245", + "transaction_successful": true, + "source_account": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "type": "payment", + "type_i": 1, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571", + "asset_type": "credit_alphanum4", + "asset_code": "SSLX", + "asset_issuer": "GBHFGY3ZNEJWLNO4LBUKLYOCEK4V7ENEBJGPRHHX7JU47GWHBREH37UR", + "from": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "to": "GCP3WXBZOCDFUXLRHY27EYAFQXLJ4NNWV7HBHBL56IPFKOJQGPBOTNSN", + "amount": "0.0100000" + }, + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754246" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031754246/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214305588031754246" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214305588031754246" + } + }, + "id": "214305588031754246", + "paging_token": "214305588031754246", + "transaction_successful": true, + "source_account": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "type": "payment", + "type_i": 1, + "created_at": "2024-01-13T08:44:04Z", + "transaction_hash": "e03ea73b0e5d575f492fdcab271cc2217172d078f6e842f47df37cf2df2fc571", + "asset_type": "credit_alphanum4", + "asset_code": "SSLX", + "asset_issuer": "GBHFGY3ZNEJWLNO4LBUKLYOCEK4V7ENEBJGPRHHX7JU47GWHBREH37UR", + "from": "GDYW6MND6EB32PNRZAMQNOTFLJOZEAFDG3DUWID7I7NRILFWJS66NOWB", + "to": "GCP3URZ5H3L77QOJ2G44OCOFTVKXXR34CUUWG3IDDKPX3GRPRCMDSJAW", + "amount": "0.0100000" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLedgerTransactions.md b/v1.0/RPC Nodes/others/rpc-stellar/getLedgerTransactions.md new file mode 100644 index 00000000..77af65d5 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLedgerTransactions.md @@ -0,0 +1,141 @@ +--- +title: "getLedgerTransactions" +slug: "rpc-stellar-getLedgerTransactions" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define the ledger sequence number and optional parameters (Replace placeholders with actual values and remove redundant) +const params = { + sequence: "YOUR_LEDGER_SEQUENCE", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, + includeFailed: true, +}; + +// Retrieve transactions for a specific ledger +const ledgerTransactions = await tatum.rpc.getLedgersTransactions(params); + +// Log the list of ledger transactions +console.log("Ledger Transactions:", ledgerTransactions); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLedgersTransactions` method allows you to retrieve a list of successful transactions associated with a specific ledger on the Stellar blockchain. You can specify the ledger's sequence number and use optional parameters to customize the result. + +### Request Parameters + +The `getLedgersTransactions` method requires the following parameters: + +- `sequence` (string, required): Specify the sequence number of the ledger for which you want to retrieve transactions. +- `cursor` (string, optional): Set the cursor to start listing transactions from a specific transaction within the ledger. If not specified, it starts from the beginning. +- `order` (string, optional): Set the order of listing, which can be either 'asc' (ascending) or 'desc' (descending). If not specified, it defaults to 'asc'. +- `limit` (integer, optional): Set the maximum number of transactions to return in a single request. The limit can range from 1 to an upper limit hardcoded in Horizon for performance reasons. If not specified, it defaults to 10. +- `includeFailed` (boolean, optional): Specify whether to include failed transactions in the results. Set to `true` to include failed transactions, or `false` to exclude them. If not specified, it defaults to `false`. + +### Return Object + +The `getLedgersTransactions` method returns a JSON object representing a list of successful transactions associated with the specified ledger. Each transaction entry includes various properties describing the transaction, such as its transaction hash, source account, operation details, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/transactions?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/transactions?cursor=214305588031565824&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/transactions?cursor=214305588031524864&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/83e580608afbc0d269107dd92629ae5be4a039c2751896bdf8e357a9cd947ea4" + }, + "account": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GAZCCHIATB5Z6ATORF46EDXRUKVDNGHOFL3NKG7Y577NBTSOWMJX2DOS" + }, + "ledger": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908" + }, + "operations": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/83e580608afbc0d269107dd92629ae5be4a039c2751896bdf8e357a9cd947ea4/operations{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/83e580608afbc0d269107dd92629ae5be4a039c2751896bdf8e357a9cd947ea4/effects{?cursor,limit,order}", + "templated": true + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions?order=asc&cursor=214305588031524864" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions?order=desc&cursor=214305588031524864" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/83e580608afbc0d269107dd92629ae5be4a039c2751896bdf8e357a9cd947ea4" + } + }, + "id": "83e580608afbc0d269107dd92629ae5be4a039c2751896bdf8e357a9cd947ea4", + "paging_token": "214305588031524864", + "successful": true, + "hash": "83e580608afbc0d269107dd92629ae5be4a039c2751896bdf8e357a9cd947ea4", + "ledger": 49896908, + "created_at": "2024-01-13T08:44:04Z", + "source_account": "GAZCCHIATB5Z6ATORF46EDXRUKVDNGHOFL3NKG7Y577NBTSOWMJX2DOS", + "source_account_sequence": "157780425393618577", + "fee_account": "GAZCCHIATB5Z6ATORF46EDXRUKVDNGHOFL3NKG7Y577NBTSOWMJX2DOS", + "fee_charged": "100", + "max_fee": "100", + "operation_count": 1, + "envelope_xdr": "AAAAAgAAAAAyIR0AmHufAm6JeeIO8aKqNpjuKvbVG/jv/tDOTrMTfQAAAGQCMIx2ABi+kQAAAAEAAAAAAAAAAAAAAABlok1uAAAAAAAAAAEAAAAAAAAADAAAAAAAAAABU1NMWAAAAABOU2N5aRNltdxYaKXhwiK5X5GkCkz4nPf6ac+axwxIfQAAAPXibPzGAAFyjwCYloAAAAAAVml2xgAAAAAAAAABTrMTfQAAAEDf1H9htFjhgBsmeu+wg7k0wWJzTsX0bPmUuulWF2cW6A83T0Dc/iea50iARBqCjlF0u7ANpEmOWdhK2CW3/UAF", + "result_xdr": "AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAMAAAAAAAAAAAAAAABAAAAADIhHQCYe58Cbol54g7xoqo2mO4q9tUb+O/+0M5OsxN9AAAAAFZpdsYAAAAAAAAAAVNTTFgAAAAATlNjeWkTZbXcWGil4cIiuV+RpApM+Jz3+mnPmscMSH0AAAACVSDxEQCYloAAAXKPAAAAAAAAAAAAAAAA", + "result_meta_xdr": "AAAAAgAAAAIAAAADAvldzAAAAAAAAAAAMiEdAJh7nwJuiXniDvGiqjaY7ir21Rv47/7Qzk6zE30AAAAW0Mp5WAIwjHYAGL6QAAAAJgAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAACJBvvGgAAAAFba2mA4AAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAC+V3LAAAAAGWiTU4AAAAAAAAAAQL5XcwAAAAAAAAAADIhHQCYe58Cbol54g7xoqo2mO4q9tUb+O/+0M5OsxN9AAAAFtDKeVgCMIx2ABi+kQAAACYAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAiQb7xoAAAABW2tpgOAAAAAgAAAAAAAAAAAAAAAAAAAAMAAAAAAvldzAAAAABlok1UAAAAAAAAAAEAAAAGAAAAAwL5XOYAAAACAAAAADIhHQCYe58Cbol54g7xoqo2mO4q9tUb+O/+0M5OsxN9AAAAAFZpdsYAAAAAAAAAAVNTTFgAAAAATlNjeWkTZbXcWGil4cIiuV+RpApM+Jz3+mnPmscMSH0AAAACVSF7XwCYloAAAXKPAAAAAAAAAAAAAAAAAAAAAQL5XcwAAAACAAAAADIhHQCYe58Cbol54g7xoqo2mO4q9tUb+O/+0M5OsxN9AAAAAFZpdsYAAAAAAAAAAVNTTFgAAAAATlNjeWkTZbXcWGil4cIiuV+RpApM+Jz3+mnPmscMSH0AAAACVSDxEQCYloAAAXKPAAAAAAAAAAAAAAAAAAAAAwL5XcsAAAABAAAAADIhHQCYe58Cbol54g7xoqo2mO4q9tUb+O/+0M5OsxN9AAAAAVNTTFgAAAAATlNjeWkTZbXcWGil4cIiuV+RpApM+Jz3+mnPmscMSH0AAAEkapBph3zmbFDihAAAAAAAAQAAAAEAAAOQdGO06wAAAPIDPIERAAAAAAAAAAAAAAABAvldzAAAAAEAAAAAMiEdAJh7nwJuiXniDvGiqjaY7ir21Rv47/7Qzk6zE30AAAABU1NMWAAAAABOU2N5aRNltdxYaKXhwiK5X5GkCkz4nPf6ac+axwxIfQAAASRqkGmHfOZsUOKEAAAAAAABAAAAAQAAA5B0KsGBAAAA8gM8gREAAAAAAAAAAAAAAAMC+V3MAAAAAAAAAAAyIR0AmHufAm6JeeIO8aKqNpjuKvbVG/jv/tDOTrMTfQAAABbQynlYAjCMdgAYvpEAAAAmAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAIkG+8aAAAAAVtraYDgAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAL5XcwAAAAAZaJNVAAAAAAAAAABAvldzAAAAAAAAAAAMiEdAJh7nwJuiXniDvGiqjaY7ir21Rv47/7Qzk6zE30AAAAW0Mp5WAIwjHYAGL6RAAAAJgAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAACJBvvGgAAAAFba2DcAAAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAC+V3MAAAAAGWiTVQAAAAAAAAAAA==", + "fee_meta_xdr": "AAAAAgAAAAMC+V3LAAAAAAAAAAAyIR0AmHufAm6JeeIO8aKqNpjuKvbVG/jv/tDOTrMTfQAAABbQynm8AjCMdgAYvpAAAAAmAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAABAAAAIkG+8aAAAAAVtraYDgAAAAIAAAAAAAAAAAAAAAAAAAADAAAAAAL5XcsAAAAAZaJNTgAAAAAAAAABAvldzAAAAAAAAAAAMiEdAJh7nwJuiXniDvGiqjaY7ir21Rv47/7Qzk6zE30AAAAW0Mp5WAIwjHYAGL6QAAAAJgAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAQAAACJBvvGgAAAAFba2mA4AAAACAAAAAAAAAAAAAAAAAAAAAwAAAAAC+V3LAAAAAGWiTU4AAAAA", + "memo_type": "none", + "signatures": [ + "39R/YbRY4YAbJnrvsIO5NMFic07F9Gz5lLrpVhdnFugPN09A3P4nmudIgEQago5RdLuwDaRJjlnYStglt/1ABQ==" + ], + "valid_after": "1970-01-01T00:00:00Z", + "valid_before": "2024-01-13T08:44:30Z", + "preconditions": { + "timebounds": { + "min_time": "0", + "max_time": "1705135470" + } + } + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLedgers.md b/v1.0/RPC Nodes/others/rpc-stellar/getLedgers.md new file mode 100644 index 00000000..a6c78d9b --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLedgers.md @@ -0,0 +1,124 @@ +--- +title: "getLedgers" +slug: "rpc-stellar-getLedgers" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define optional parameters for listing ledgers (Replace placeholders with actual values and remove redundant) +const params = { + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// List all ledgers or stream new ledgers as they close +const ledgers = await tatum.rpc.getLedgers(params); + +// Log the list of ledgers +console.log("Ledgers:", ledgers); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLedgers` method allows you to retrieve a list of all ledgers on the Stellar blockchain. You can use this endpoint to either list all existing ledgers or stream new ledgers as they are created. + +### Request Parameters + +The `getLedgers` method supports the following optional request parameters: + +- `cursor` (string, optional): + Set the cursor to start listing ledgers from a specific ledger. If not specified, it starts from the earliest known ledger. + +- `order` (string, optional): + Set the order of listing, which can be either 'asc' (ascending) or 'desc' (descending). If not specified, it defaults to 'asc'. + +- `limit` (integer, optional): + Set the maximum number of ledgers to return in a single request. The limit can range from 1 to an upper limit hardcoded in Horizon for performance reasons. If not specified, it defaults to 10. + +### Return Object + +The `getLedgers` method returns a JSON object representing a list of ledgers on the Stellar blockchain. Each ledger entry includes various properties describing the ledger's characteristics, such as its sequence number, transaction count, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers?cursor=209252254065098752&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers?cursor=214305626686226432&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers?cursor=214305588031520768&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908" + }, + "transactions": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/transactions{?cursor,limit,order}", + "templated": true + }, + "operations": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/operations{?cursor,limit,order}", + "templated": true + }, + "payments": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/payments{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/49896908/effects{?cursor,limit,order}", + "templated": true + } + }, + "id": "377342fc7d2d3e8e8aebcc2bd069cebce97ef59142afcf3834187e27670b69e5", + "paging_token": "214305588031520768", + "hash": "377342fc7d2d3e8e8aebcc2bd069cebce97ef59142afcf3834187e27670b69e5", + "prev_hash": "64b283aa8f123102b27334c9b0b4d0ba7baca635bc0fdee2471762755185fc8d", + "sequence": 49896908, + "successful_transaction_count": 122, + "failed_transaction_count": 16, + "operation_count": 422, + "tx_set_operation_count": 444, + "closed_at": "2024-01-13T08:44:04Z", + "total_coins": "105443902087.3472865", + "fee_pool": "4352705.3880757", + "base_fee_in_stroops": 100, + "base_reserve_in_stroops": 5000000, + "max_tx_set_size": 1000, + "protocol_version": 19, + "header_xdr": "AAAAE2Syg6qPEjECsnM0ybC00Lp7rKY1vA/e4kcXYnVRhfyNp1FbP/TkMcsgPzxpkwmSanCPlHIkEEdIUluDz3RuOMAAAAAAZaJNVAAAAAAAAAABAAAAAJnoMfsa4vmDNtUy8T76WXcr2up7H7MouQjkXcMmro3YAAAAQOWiXUUgvk9prIYO2MowcNsSmp7gJ2pDeKstCpOS1JDvEGry7E0EIA2uNNuQicQkF0LPkzibuNqFIrRAlS3qwQt2V4R3dnRsy/hBIt5wz7oIBqVZNDN+w21lovTVBGxHHh5McTecKdm6+JSPeLr+qWjW8QFh7Z8+TOcgCjAtJkI1AvldzA6iHrPseVthAAAnlm6VrbUAAAEWAAAAAFZtQfcAAABkAExLQAAAA+jlo5p0S2VRLG/2qoS2AHIAqWpkozbDmPnGixgTrfRM4EhakDMvJGA2NlrXaNdrDghS8gBVmir/lvjB5aIM8CqaNZ3+bNIMjENN35Wl0SqvmRPHm1ba+rIkuDOUxRhPT5cTHtTJQ8xzm+/8UT+eTL84VX2S5mxKeyMkTW+VYnrVPwAAAAA=" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPool.md b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPool.md new file mode 100644 index 00000000..89694fdc --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPool.md @@ -0,0 +1,98 @@ +--- +title: "getLiquidityPool" +slug: "rpc-stellar-getLiquidityPool" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Replace 'YOUR_LIQUIDITY_POOL_ID' with the actual Liquidity Pool ID +const liquidityPoolId = "YOUR_LIQUIDITY_POOL_ID"; + +// Retrieve information about a specific liquidity pool +const liquidityPool = await tatum.rpc.getLiquidityPool(liquidityPoolId); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLiquidityPool` method allows you to retrieve information about a specific liquidity pool on the Stellar blockchain. + +### Example use cases: + +1. **Liquidity Pool Analysis:** + Developers and applications can use this method to analyze and retrieve detailed information about a specific liquidity pool. + +2. **Liquidity Pool Management:** + Platform administrators can access information about a liquidity pool for management purposes. + +3. **Liquidity Pool Exploration:** + Researchers and analysts can explore and study the characteristics of individual liquidity pools. + +### Request Parameters + +The `getLiquidityPool` method requires the following parameter: + +- `liquidityPoolId` (string): + The unique identifier of the liquidity pool you want to retrieve information about. + +### Return Object + +The `getLiquidityPool` method returns an object containing detailed information about the specified liquidity pool. This information may include the liquidity pool ID, reserve assets, total value, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a" + }, + "transactions": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/transactions{?cursor,limit,order}", + "templated": true + }, + "operations": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/operations{?cursor,limit,order}", + "templated": true + } + }, + "id": "0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a", + "paging_token": "0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a", + "fee_bp": 30, + "type": "constant_product", + "total_trustlines": "1", + "total_shares": "5494.2144063", + "reserves": [ + { + "asset": "native", + "amount": "3.5287238" + }, + { + "asset": "GOLDBANK001:GDEUQ2MX3YXMITFOTC3CO3GW5V3XE3IVG7JKLZZAOZ7WFYIN256INDUS", + "amount": "11669718.3952703" + } + ], + "last_modified_ledger": 50744249, + "last_modified_time": "2024-03-11T13:02:15Z" +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolEffects.md b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolEffects.md new file mode 100644 index 00000000..1a74c545 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolEffects.md @@ -0,0 +1,97 @@ +--- +title: "getLiquidityPoolEffects" +slug: "rpc-stellar-getLiquidityPoolEffects" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Replace 'YOUR_LIQUIDITY_POOL_ID' with the actual Liquidity Pool ID +const liquidityPoolId = "YOUR_LIQUIDITY_POOL_ID"; + +// Retrieve effects related to a specific liquidity pool +const effects = await tatum.rpc.liquidityPoolEffects(liquidityPoolId); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `liquidityPoolEffects` method allows you to retrieve effects related to a specific liquidity pool on the Stellar blockchain. Effects represent various events or changes that occur within the Stellar network, such as trades, payments, and more. + +### Example use cases: + +1. **Monitoring Liquidity Pool Activity:** + Developers and applications can use this method to monitor and track events related to a particular liquidity pool. + +2. **Transaction Analysis:** + Researchers and analysts can analyze the effects of liquidity pool transactions for reporting and insights. + +3. **Real-time Updates:** + Applications can subscribe to streaming updates to receive real-time notifications of new effects associated with the liquidity pool. + +### Request Parameters + +The `liquidityPoolEffects` method requires the following parameters: + +- `liquidityPoolId` (string): + The unique identifier of the liquidity pool for which you want to retrieve related effects. + + ```json + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/effects?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/effects?cursor=214312580239376385-2&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/effects?cursor=214312571649462273-1&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "operation": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214312571649462273" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=214312571649462273-1" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=214312571649462273-1" + } + }, + "id": "0214312571649462273-0000000001", + "paging_token": "214312571649462273-1", + "account": "GA5Q3UHRKBBZFUQBFF3CEEPY322UIEALGUA7KS7LKGMAK7WJ4NF3W742", + "type": "account_credited", + "type_i": 2, + "created_at": "2024-01-13T11:19:52Z", + "asset_type": "native", + "amount": "0.0252872" + } + ] + } + } + ``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolOperations.md b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolOperations.md new file mode 100644 index 00000000..33f2542e --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolOperations.md @@ -0,0 +1,167 @@ +--- +title: "getLiquidityPoolOperations" +slug: "rpc-stellar-getLiquidityPoolOperations" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + liquidityPoolId: "YOUR_LIQUIDITY_POOL_ID", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, + includeFailed: true, + join: true, +}; + +// Retrieve operations related to a liquidity pool +const liquidityPoolOperations = await tatum.rpc.getLiquidityPoolOperations( + params +); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLiquidityPoolOperations` method allows you to retrieve a list of operations related to a specific liquidity pool on the Stellar blockchain. + +### Example use cases: + +1. **Liquidity Pool Operation Analysis:** + Developers and applications can use this method to analyze and retrieve information about operations associated with a liquidity pool. + +2. **Liquidity Pool Operation Monitoring:** + Platform administrators can monitor and track operations related to liquidity pools for auditing and management purposes. + +3. **Liquidity Pool Operation Exploration:** + Researchers and analysts can explore and analyze the characteristics of operations involving liquidity pools on the Stellar network. + +### Request Parameters + +The `getLiquidityPoolOperations` method accepts the following optional parameters: + +- `liquidityPoolId` (string, required): + The unique identifier of the liquidity pool for which you want to retrieve operations. + +- `cursor` (string, optional): + An optional cursor to start listing operations from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of operations to return. The limit can range from 1 to 200. + +- `includeFailed` (boolean, optional): + An optional parameter to include failed operations. If set to true, failed operations will be included in the results. Defaults to false. + +- `join` (boolean, optional): + An optional parameter to join results. If set to true, results will be joined. Defaults to false. + +### Return Object + +The `getLiquidityPoolOperations` method returns an array of operations related to the specified liquidity pool on the Stellar blockchain. Each operation object contains information such as the operation ID, source account, type of operation, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/operations?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/operations?cursor=215379467295031297&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/operations?cursor=215280038803128321&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215280038803128321" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/91a59ae616f077b905d29841d7b053282862d3fade107163ea9256847588ef56" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215280038803128321/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=215280038803128321" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=215280038803128321" + } + }, + "id": "215280038803128321", + "paging_token": "215280038803128321", + "transaction_successful": true, + "source_account": "GA5Q3UHRKBBZFUQBFF3CEEPY322UIEALGUA7KS7LKGMAK7WJ4NF3W742", + "type": "path_payment_strict_receive", + "type_i": 2, + "created_at": "2024-01-28T17:10:34Z", + "transaction_hash": "91a59ae616f077b905d29841d7b053282862d3fade107163ea9256847588ef56", + "asset_type": "native", + "from": "GA5Q3UHRKBBZFUQBFF3CEEPY322UIEALGUA7KS7LKGMAK7WJ4NF3W742", + "to": "GA5Q3UHRKBBZFUQBFF3CEEPY322UIEALGUA7KS7LKGMAK7WJ4NF3W742", + "amount": "0.0149988", + "path": [ + { + "asset_type": "credit_alphanum12", + "asset_code": "XRPBANK003", + "asset_issuer": "GAUCPLSPBJKOSN7WZK6SDD2BYPQMC3YSWMLX4XXY7S4JPQFLJXEINDUS" + }, + { + "asset_type": "credit_alphanum12", + "asset_code": "XRPGOLD", + "asset_issuer": "GAUCPLSPBJKOSN7WZK6SDD2BYPQMC3YSWMLX4XXY7S4JPQFLJXEINDUS" + }, + { + "asset_type": "credit_alphanum12", + "asset_code": "BRICSGOLD", + "asset_issuer": "GAUCPLSPBJKOSN7WZK6SDD2BYPQMC3YSWMLX4XXY7S4JPQFLJXEINDUS" + }, + { + "asset_type": "credit_alphanum12", + "asset_code": "RUGOLDBRIDGE", + "asset_issuer": "GAUCPLSPBJKOSN7WZK6SDD2BYPQMC3YSWMLX4XXY7S4JPQFLJXEINDUS" + }, + { + "asset_type": "credit_alphanum12", + "asset_code": "GOLDBANK001", + "asset_issuer": "GDEUQ2MX3YXMITFOTC3CO3GW5V3XE3IVG7JKLZZAOZ7WFYIN256INDUS" + } + ], + "source_amount": "0.0145987", + "source_max": "0.0149988", + "source_asset_type": "native" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolTrades.md b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolTrades.md new file mode 100644 index 00000000..56e10fe7 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolTrades.md @@ -0,0 +1,128 @@ +--- +title: "getLiquidityPoolTrades" +slug: "rpc-stellar-getLiquidityPoolTrades" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + liquidityPoolId: "YOUR_LIQUIDITY_POOL_ID", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// Retrieve trades related to a liquidity pool +const liquidityPoolTrades = await tatum.rpc.getLiquidityPoolTrades(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLiquidityPoolTrades` method allows you to retrieve successful trades fulfilled by a specific liquidity pool on the Stellar blockchain. + +### Example use cases: + +1. **Liquidity Pool Monitoring:** + Developers and applications can use this method to monitor and retrieve successful trades related to liquidity pools. + +2. **Liquidity Pool Analysis:** + Researchers and analysts can analyze the trade history of liquidity pools to gain insights into their performance. + +### Request Parameters + +The `getLiquidityPoolTrades` method accepts the following parameters: + +- `liquidityPoolId` (string): + The ID of the liquidity pool for which you want to retrieve related trades. + +- `cursor` (string, optional): + An optional cursor to start listing liquidity pool trades from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of trades to return. The limit can range from 1 to 200. + +### Return Object + +The `getLiquidityPoolTrades` method returns an array of trades related to the specified liquidity pool on the Stellar blockchain. Each trade object contains information such as the trade ID, asset details, timestamp, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/trades?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/trades?cursor=214318047732097026-0&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/trades?cursor=214312571649462273-0&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "" + }, + "base": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA5Q3UHRKBBZFUQBFF3CEEPY322UIEALGUA7KS7LKGMAK7WJ4NF3W742" + }, + "counter": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a" + }, + "operation": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214312571649462273" + } + }, + "id": "214312571649462273-0", + "paging_token": "214312571649462273-0", + "ledger_close_time": "2024-01-13T11:19:52Z", + "trade_type": "liquidity_pool", + "liquidity_pool_fee_bp": 30, + "base_offer_id": "4825998590076850177", + "base_account": "GA5Q3UHRKBBZFUQBFF3CEEPY322UIEALGUA7KS7LKGMAK7WJ4NF3W742", + "base_amount": "0.0242091", + "base_asset_type": "native", + "counter_liquidity_pool_id": "0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a", + "counter_amount": "23250.7124160", + "counter_asset_type": "credit_alphanum12", + "counter_asset_code": "GOLDBANK001", + "counter_asset_issuer": "GDEUQ2MX3YXMITFOTC3CO3GW5V3XE3IVG7JKLZZAOZ7WFYIN256INDUS", + "base_is_seller": false, + "price": { + "n": "232507124160", + "d": "242091" + } + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolTransactions.md b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolTransactions.md new file mode 100644 index 00000000..ce5751de --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPoolTransactions.md @@ -0,0 +1,172 @@ +--- +title: "getLiquidityPoolTransactions" +slug: "rpc-stellar-getLiquidityPoolTransactions" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + liquidityPoolId: "YOUR_LIQUIDITY_POOL_ID", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, + includeFailed: true, +}; + +// Retrieve transactions related to a liquidity pool +const liquidityPoolTransactions = await tatum.rpc.getLiquidityPoolsTransactions( + params +); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLiquidityPoolsTransactions` method allows you to retrieve a list of transactions related to a specific liquidity pool on the Stellar blockchain. + +### Example use cases: + +1. **Liquidity Pool Transaction Analysis:** + Developers and applications can use this method to analyze and retrieve information about transactions associated with a liquidity pool. +2. **Liquidity Pool Transaction Monitoring:** + Platform administrators can monitor and track transactions related to liquidity pools for auditing and management purposes. + +3. **Liquidity Pool Transaction Exploration:** + Researchers and analysts can explore and analyze the characteristics of transactions involving liquidity pools on the Stellar network. + +### Request Parameters + +The `getLiquidityPoolsTransactions` method accepts the following optional parameters: + +- `liquidityPoolId` (string, required): + The unique identifier of the liquidity pool for which you want to retrieve transactions. + +- `cursor` (string, optional): + An optional cursor to start listing transactions from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of transactions to return. The limit can range from 1 to 200. + +- `includeFailed` (boolean, optional): + An optional parameter to include failed transactions. If set to true, failed transactions will be included in the results. Defaults to false. + +### Return Object + +The `getLiquidityPoolsTransactions` method returns an array of transactions related to the specified liquidity pool on the Stellar blockchain. Each transaction object contains information such as the transaction ID, source account, destination account, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/transactions?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/transactions?cursor=215379467295031296&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/transactions?cursor=215280038803128320&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/91a59ae616f077b905d29841d7b053282862d3fade107163ea9256847588ef56" + }, + "account": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA4OGQSH75L2BBUEBRI4R56BP7ONJIJPGPSZXZYFCKQGXICPOXWFAU4H" + }, + "ledger": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/ledgers/50123790" + }, + "operations": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/91a59ae616f077b905d29841d7b053282862d3fade107163ea9256847588ef56/operations{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/91a59ae616f077b905d29841d7b053282862d3fade107163ea9256847588ef56/effects{?cursor,limit,order}", + "templated": true + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions?order=asc&cursor=215280038803128320" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions?order=desc&cursor=215280038803128320" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/91a59ae616f077b905d29841d7b053282862d3fade107163ea9256847588ef56" + } + }, + "id": "91a59ae616f077b905d29841d7b053282862d3fade107163ea9256847588ef56", + "paging_token": "215280038803128320", + "successful": true, + "hash": "91a59ae616f077b905d29841d7b053282862d3fade107163ea9256847588ef56", + "ledger": 50123790, + "created_at": "2024-01-28T17:10:34Z", + "source_account": "GA4OGQSH75L2BBUEBRI4R56BP7ONJIJPGPSZXZYFCKQGXICPOXWFAU4H", + "account_muxed": "MA4OGQSH75L2BBUEBRI4R56BP7ONJIJPGPSZXZYFCKQGXICPOXWFAAAACJ4MHP7NAT4JQ", + "account_muxed_id": "20309889510660", + "source_account_sequence": "169911040828572928", + "fee_account": "GA5Q3UHRKBBZFUQBFF3CEEPY322UIEALGUA7KS7LKGMAK7WJ4NF3W742", + "fee_charged": "200", + "max_fee": "2000", + "operation_count": 1, + "envelope_xdr": "", + "result_xdr": "", + "result_meta_xdr": "", + "memo_type": "none", + "signatures": [ + "qJxrEWQTd6cpHZyTgN4Ms+OwcE2rg+AqDlhUP5a450NlP8R4Vd6mgIxHR7ituxy9GS2W7Rl1XmqpgNCVup0kCw==" + ], + "valid_after": "1970-01-01T00:00:00Z", + "preconditions": { + "timebounds": { + "min_time": "0" + } + }, + "fee_bump_transaction": { + "hash": "91a59ae616f077b905d29841d7b053282862d3fade107163ea9256847588ef56", + "signatures": [ + "qJxrEWQTd6cpHZyTgN4Ms+OwcE2rg+AqDlhUP5a450NlP8R4Vd6mgIxHR7ituxy9GS2W7Rl1XmqpgNCVup0kCw==" + ] + }, + "inner_transaction": { + "hash": "a87a96da677ed8c7e079ac7e920399c864bfc811299d351fc4cf7b5588b1ddbd", + "signatures": [ + "EK3OcLKkmFFHZaM75DkXF2OrSB3hc57kmUvqTA85yVKCu4WWAjQuDXSUJUczBiwKj3XMOTBUrDAJt+tYiB/YAA==", + "Qu/5Py1qmxLO3zo1qB0kFfTithuGiv+mGfiVh1/IkN1PAuHNZPJkLMpzxgYiAYHj9vJnsgqG7IIfU5+23E1kCA==" + ], + "max_fee": "500" + } + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPools.md b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPools.md new file mode 100644 index 00000000..62b54fc4 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getLiquidityPools.md @@ -0,0 +1,133 @@ +--- +title: "getLiquidityPools" +slug: "rpc-stellar-getLiquidityPools" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define optional parameters (Replace placeholders with actual values and remove redundant) +const params = { + reserve: "YOUR_RESERVE", + account: "YOUR_ACCOUNT", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// List all available liquidity pools +const liquidityPools = await tatum.rpc.getLiquidityPools(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLiquidityPools` method allows you to retrieve a list of all available liquidity pools on the Stellar blockchain. + +### Example use cases: + +1. **Liquidity Pool Analysis:** + Developers and applications can use this method to analyze and retrieve information about existing liquidity pools. + +2. **Liquidity Pool Management:** + Platform administrators can manage liquidity pools by listing and tracking their status. + +3. **Liquidity Pool Exploration:** + Researchers and analysts can explore and analyze the characteristics of liquidity pools on the Stellar network. + +### Request Parameters + +The `getLiquidityPools` method accepts the following optional parameters: + +- `reserve` (string, optional): + Filter liquidity pools by the reserve asset. Provide the asset code of the reserve asset. + +- `account` (string, optional): + Filter liquidity pools by account ID. Provide the account ID associated with the liquidity pool. + +- `cursor` (string, optional): + An optional cursor to start listing liquidity pools from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of liquidity pools to return. The limit can range from 1 to 200. + +### Return Object + +The `getLiquidityPools` method returns an array of liquidity pools on the Stellar blockchain. Each liquidity pool object contains information such as the liquidity pool ID, reserve asset, total value, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools?cursor=00293f3a22c8ef5561de7cefc98f9286ac688cb8abf6b1c29a1dabbb63f265ce&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools?cursor=0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a" + }, + "transactions": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/transactions{?cursor,limit,order}", + "templated": true + }, + "operations": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/liquidity_pools/0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a/operations{?cursor,limit,order}", + "templated": true + } + }, + "id": "0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a", + "paging_token": "0000a8198b5e25994c1ca5b0556faeb27325ac746296944144e0a7406d501e8a", + "fee_bp": 30, + "type": "constant_product", + "total_trustlines": "1", + "total_shares": "5494.2144063", + "reserves": [ + { + "asset": "native", + "amount": "3.5287238" + }, + { + "asset": "GOLDBANK001:GDEUQ2MX3YXMITFOTC3CO3GW5V3XE3IVG7JKLZZAOZ7WFYIN256INDUS", + "amount": "11669718.3952703" + } + ], + "last_modified_ledger": 50744249, + "last_modified_time": "2024-03-11T13:02:15Z" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getOffer.md b/v1.0/RPC Nodes/others/rpc-stellar/getOffer.md new file mode 100644 index 00000000..1009f5ca --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getOffer.md @@ -0,0 +1,93 @@ +--- +title: "getOffer" +slug: "rpc-stellar-getOffer" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const offerId = "OFFER_ID"; + +// Retrieve information on a specific offer +const offerInfo = await tatum.rpc.getOffer(offerId); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getOffer` method allows you to retrieve information on a specific offer by providing the offer's unique identifier. + +### Example use cases: + +1. **Offer Information Retrieval:** + Developers and applications can use this method to retrieve detailed information about a specific offer on the Stellar network. + +2. **Offer Verification:** + Users can verify the details of an offer, including the asset types, issuer, code, and other relevant information. + +### Request Parameters + +The `getOffer` method accepts the following parameter: + +- `offerId` (string, required): + The unique identifier of the offer for which you want to retrieve information. + +### Return Object + +The `getOffer` method returns detailed information about the specified offer on the Stellar blockchain. The response includes data such as the offer ID, sponsor, seller, buying asset, selling asset, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/offers/2" + }, + "offer_maker": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GBPO4N6XOLOLW2EV6X2AEQMLKOBH3WF2IJCZEQU65SVVSN4JD44WORKD" + } + }, + "id": "2", + "paging_token": "2", + "seller": "GBPO4N6XOLOLW2EV6X2AEQMLKOBH3WF2IJCZEQU65SVVSN4JD44WORKD", + "selling": { + "asset_type": "credit_alphanum4", + "asset_code": "CHP", + "asset_issuer": "GDW3CNKSP5AOTDQ2YCKNGC6L65CE4JDX3JS5BV427OB54HCF2J4PUEVG" + }, + "buying": { + "asset_type": "credit_alphanum4", + "asset_code": "BEER", + "asset_issuer": "GDW3CNKSP5AOTDQ2YCKNGC6L65CE4JDX3JS5BV427OB54HCF2J4PUEVG" + }, + "amount": "1.9991292", + "price_r": { + "n": 1903, + "d": 20 + }, + "price": "95.1500000", + "last_modified_ledger": 50044488, + "last_modified_time": null +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getOfferTrades.md b/v1.0/RPC Nodes/others/rpc-stellar/getOfferTrades.md new file mode 100644 index 00000000..fd9ee6de --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getOfferTrades.md @@ -0,0 +1,133 @@ +--- +title: "getOfferTrades" +slug: "rpc-stellar-getOfferTrades" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + offerId = 'OFFER_ID'; + cursor = 'YOUR_CURSOR'; + order = 'asc'; + limit = 10; +} + +// Retrieve trades for a specific offer +const offerTrades = await tatum.rpc.getOfferTrades(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getOfferTrades` method allows you to retrieve all trades associated with a specific offer by providing the offer's unique identifier. + +### Example use cases: + +1. **Trade Analysis:** + Developers and applications can use this method to analyze and retrieve information about trades related to a specific offer on the Stellar network. + +2. **Trade Monitoring:** + Platform administrators can monitor and track trades associated with offers for auditing and management purposes. + +3. **Streaming Trades:** + Users can use streaming mode to listen for new trades related to the offer as they are added to the Stellar ledger. + +### Request Parameters + +The `getOfferTrades` method accepts the following optional parameters: + +- `offerId` (string, required): + The unique identifier of the offer for which you want to retrieve trades. + +- `cursor` (string, optional): + An optional cursor to start listing trades from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of trades to return. The limit can range from 1 to 200. + +### Return Object + +The `getOfferTrades` method returns an array of trades related to the specified offer on the Stellar blockchain. Each trade object contains information such as the trade ID, seller, buyer, price, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "value": { + "_links": { + "self": { + "href": "https://horizon.stellar.org/offers/104078276/trades?cursor=&limit=3&order=asc" + }, + "next": { + "href": "https://horizon.stellar.org/offers/104078276/trades?cursor=107449584845914113-0&limit=3&order=asc" + }, + "prev": { + "href": "https://horizon.stellar.org/offers/104078276/trades?cursor=107449468881756161-0&limit=3&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "" + }, + "base": { + "href": "https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX" + }, + "counter": { + "href": "https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K" + }, + "operation": { + "href": "https://horizon.stellar.org/operations/107449468881756161" + } + }, + "id": "107449468881756161-0", + "paging_token": "107449468881756161-0", + "ledger_close_time": "2019-07-26T09:17:02Z", + "offer_id": "104078276", + "base_offer_id": "104078276", + "base_account": "GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX", + "base_amount": "4433.2000000", + "base_asset_type": "native", + "counter_offer_id": "4719135487309144065", + "counter_account": "GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K", + "counter_amount": "443.3200000", + "counter_asset_type": "credit_alphanum4", + "counter_asset_code": "BB1", + "counter_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN", + "base_is_seller": true, + "price": { + "n": "1", + "d": 10 + } + } + ] + } + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getOffers.md b/v1.0/RPC Nodes/others/rpc-stellar/getOffers.md new file mode 100644 index 00000000..8849144a --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getOffers.md @@ -0,0 +1,155 @@ +--- +title: "getOffers" +slug: "rpc-stellar-getOffers" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + sponsor: "SPONSOR_ADDRESS", + seller: "SELLER_ADDRESS", + sellingAssetType: "ASSET_TYPE", + sellingAssetIssuer: "ASSET_ISSUER", + sellingAssetCode: "ASSET_CODE", + buyingAssetType: "ASSET_TYPE", + buyingAssetIssuer: "ASSET_ISSUER", + buyingAssetCode: "ASSET_CODE", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// List all open offers +const allOffers = await tatum.rpc.getOffers(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getOffers` method allows you to list all currently open offers on the Stellar blockchain. + +### Example use cases: + +1. **Offer Monitoring:** + Developers and applications can use this method to monitor and retrieve information about all open offers on the Stellar network. + +2. **Offer Filtering:** + Platform administrators can filter and search for specific offers based on various criteria, such as asset type, issuer, code, seller, and more. + +3. **Streaming Offers:** + Users can use streaming mode to listen for new offers as they are added to the Stellar ledger. + +### Request Parameters + +The `getOffers` method accepts the following optional parameters: + +- `sponsor` (string, optional): + Filter by the sponsor of the offer. + +- `seller` (string, optional): + Filter by the seller of the offer. + +- `sellingAssetType` (string, optional): + Filter by the selling asset type. + +- `sellingAssetIssuer` (string, optional): + Filter by the selling asset issuer. + +- `sellingAssetCode` (string, optional): + Filter by the selling asset code. + +- `buyingAssetType` (string, optional): + Filter by the buying asset type. + +- `buyingAssetIssuer` (string, optional): + Filter by the buying asset issuer. + +- `buyingAssetCode` (string, optional): + Filter by the buying asset code. + +- `cursor` (string, optional): + An optional cursor to start listing offers from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of offers to return. The limit can range from 1 to 200. + +### Return Object + +The `getOffers` method returns an array of open offers on the Stellar blockchain. Each offer object contains information such as the offer ID, sponsor, seller, buying asset, selling asset, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/offers?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/offers?cursor=1848&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/offers?cursor=2&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/offers/2" + }, + "offer_maker": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GBPO4N6XOLOLW2EV6X2AEQMLKOBH3WF2IJCZEQU65SVVSN4JD44WORKD" + } + }, + "id": "2", + "paging_token": "2", + "seller": "GBPO4N6XOLOLW2EV6X2AEQMLKOBH3WF2IJCZEQU65SVVSN4JD44WORKD", + "selling": { + "asset_type": "credit_alphanum4", + "asset_code": "CHP", + "asset_issuer": "GDW3CNKSP5AOTDQ2YCKNGC6L65CE4JDX3JS5BV427OB54HCF2J4PUEVG" + }, + "buying": { + "asset_type": "credit_alphanum4", + "asset_code": "BEER", + "asset_issuer": "GDW3CNKSP5AOTDQ2YCKNGC6L65CE4JDX3JS5BV427OB54HCF2J4PUEVG" + }, + "amount": "1.9991292", + "price_r": { + "n": 1903, + "d": 20 + }, + "price": "95.1500000", + "last_modified_ledger": 50044488, + "last_modified_time": null + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getOperation.md b/v1.0/RPC Nodes/others/rpc-stellar/getOperation.md new file mode 100644 index 00000000..a42aa5a3 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getOperation.md @@ -0,0 +1,123 @@ +--- +title: "getOperation" +slug: "rpc-stellar-getOperation" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + operationId: "OPERATION_ID", + join: true, +}; + +// Retrieve information about a specific operation +const operationInfo = await tatum.rpc.getOperation(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getOperation` method allows you to retrieve detailed information about a specific operation on the Stellar blockchain by providing the operation's unique identifier. + +### Example use cases: + +1. **Operation Information Retrieval:** + Developers and applications can use this method to retrieve detailed information about a specific operation on the Stellar network. + +2. **Operation Verification:** + Users can verify the details of an operation, including its type, source account, destination account, and other relevant information. + +### Request Parameters + +The `getOperation` method accepts the following parameters: + +- `operationId` (string, required): + The unique identifier of the operation for which you want to retrieve information. + +- `join` (boolean, optional): + An optional parameter to join results. If set to true, results will be joined. Defaults to false. + +### Return Object + +The `getOperation` method returns detailed information about the specified operation on the Stellar blockchain. The response includes data such as the operation ID, source account, destination account, type of operation, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations?cursor=215271955673231361&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations?cursor=215271955673128961&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215271955673128961" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/bf3e8c575c463bff1c23c1a7113b38d1cb79c983be62bf696dc96632ef00af47" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215271955673128961/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=215271955673128961" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=215271955673128961" + } + }, + "id": "215271955673128961", + "paging_token": "215271955673128961", + "transaction_successful": true, + "source_account": "GBARZTOSSCH3XDC7NMRIHQVOWEYX7VOBQ4TZTR4HZRBZS3UO7QID242H", + "type": "manage_sell_offer", + "type_i": 3, + "created_at": "2024-01-28T14:07:11Z", + "transaction_hash": "bf3e8c575c463bff1c23c1a7113b38d1cb79c983be62bf696dc96632ef00af47", + "amount": "0.1833209", + "price": "5.4578916", + "price_r": { + "n": 545789163, + "d": 100000000 + }, + "buying_asset_type": "native", + "selling_asset_type": "credit_alphanum4", + "selling_asset_code": "RIO", + "selling_asset_issuer": "GBNLJIYH34UWO5YZFA3A3HD3N76R6DOI33N4JONUOHEEYZYCAYTEJ5AK", + "offer_id": "1461815697" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getOperationEffects.md b/v1.0/RPC Nodes/others/rpc-stellar/getOperationEffects.md new file mode 100644 index 00000000..cead9e95 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getOperationEffects.md @@ -0,0 +1,116 @@ +--- +title: "getOperationEffects" +slug: "rpc-stellar-getOperationEffects" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + operationId: "OPERATION_ID", + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// Retrieve effects of a specific operation +const operationEffects = await tatum.rpc.getOperationEffects(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getOperationEffects` method allows you to retrieve the effects of a specific operation on the Stellar blockchain by providing the operation's unique identifier. + +### Example use cases: + +1. **Effect Information Retrieval:** + Developers and applications can use this method to retrieve detailed information about the effects of a specific operation on the Stellar network. + +2. **Effect Analysis:** + Users can analyze the effects of an operation, which may include details about changes to account balances, trustlines, data entries, and more. + +### Request Parameters + +The `getOperationEffects` method accepts a single `params` object with the following properties: + +- `operationId` (string, required): + The unique identifier of the operation for which you want to retrieve effects. + +- `cursor` (string, optional): + An optional cursor to start listing effects from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of effects to return. The limit can range from 1 to 200. + +### Return Object + +The `getOperationEffects` method returns an array of effects related to the specified operation on the Stellar blockchain. Each effect object contains information about the changes that occurred as a result of the operation. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations//effects?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations//effects?cursor=215271955673288705-1&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations//effects?cursor=215271955673169921-1&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "operation": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215271955673169921" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=215271955673169921-1" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=215271955673169921-1" + } + }, + "id": "0215271955673169921-0000000001", + "paging_token": "215271955673169921-1", + "account": "GCEETSI6ZGG3CS37YUFAUKCCJSCOILXL43JOJVZ435KBJ5NICDYY4EMP", + "type": "account_credited", + "type_i": 2, + "created_at": "2024-01-28T14:07:11Z", + "asset_type": "credit_alphanum4", + "asset_code": "yXLM", + "asset_issuer": "GARDNV3Q7YGT4AKSDF25LT32YSCCW4EV22Y2TV3I2PU2MMXJTEDL5T55", + "amount": "1.0291984" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getOperations.md b/v1.0/RPC Nodes/others/rpc-stellar/getOperations.md new file mode 100644 index 00000000..ed837e39 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getOperations.md @@ -0,0 +1,138 @@ +--- +title: "getOperations" +slug: "rpc-stellar-getOperations" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, + includeFailed: true, + join: true, +}; + +// List all successful operations +const allOperations = await tatum.rpc.listAllOperations(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `listAllOperations` method allows you to list all successful operations on the Stellar blockchain. + +### Example use cases: + +1. **Operation Monitoring:** + Developers and applications can use this method to monitor and retrieve information about all successful operations on the Stellar network. + +2. **Operation Filtering:** + Platform administrators can filter and search for specific operations based on various criteria, such as cursor, order, and more. + +3. **Streaming Operations:** + Users can use streaming mode to listen for new operations as they are added to the Stellar ledger. + +### Request Parameters + +The `listAllOperations` method accepts a single `params` object with the following properties: + +- `cursor` (string, optional): + An optional cursor to start listing operations from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of operations to return. The limit can range from 1 to 200. + +- `includeFailed` (boolean, optional): + An optional parameter to include failed operations. If set to true, failed operations will be included in the results. Defaults to false. + +- `join` (boolean, optional): + An optional parameter to join results. If set to true, results will be joined. Defaults to false. + +### Return Object + +The `listAllOperations` method returns an array of successful operations on the Stellar blockchain. Each operation object contains information such as the operation ID, source account, destination account, type of operation, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations?cursor=215271955673231361&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations?cursor=215271955673128961&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215271955673128961" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/bf3e8c575c463bff1c23c1a7113b38d1cb79c983be62bf696dc96632ef00af47" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215271955673128961/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=215271955673128961" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=215271955673128961" + } + }, + "id": "215271955673128961", + "paging_token": "215271955673128961", + "transaction_successful": true, + "source_account": "GBARZTOSSCH3XDC7NMRIHQVOWEYX7VOBQ4TZTR4HZRBZS3UO7QID242H", + "type": "manage_sell_offer", + "type_i": 3, + "created_at": "2024-01-28T14:07:11Z", + "transaction_hash": "bf3e8c575c463bff1c23c1a7113b38d1cb79c983be62bf696dc96632ef00af47", + "amount": "0.1833209", + "price": "5.4578916", + "price_r": { + "n": 545789163, + "d": 100000000 + }, + "buying_asset_type": "native", + "selling_asset_type": "credit_alphanum4", + "selling_asset_code": "RIO", + "selling_asset_issuer": "GBNLJIYH34UWO5YZFA3A3HD3N76R6DOI33N4JONUOHEEYZYCAYTEJ5AK", + "offer_id": "1461815697" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getOrderBook.md b/v1.0/RPC Nodes/others/rpc-stellar/getOrderBook.md new file mode 100644 index 00000000..ac82299f --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getOrderBook.md @@ -0,0 +1,169 @@ +--- +title: "getOrderBook" +slug: "rpc-stellar-getOrderBook" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + sellingAssetType: "SELLING_ASSET_TYPE", + sellingAssetIssuer: "SELLING_ASSET_ISSUER", + sellingAssetCode: "SELLING_ASSET_CODE", + buyingAssetType: "BUYING_ASSET_TYPE", + buyingAssetIssuer: "BUYING_ASSET_ISSUER", + buyingAssetCode: "BUYING_ASSET_CODE", + limit: 10, +}; + +// Retrieve an order book +const orderBook = await tatum.rpc.getOrderBook(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getOrderBook` method allows you to retrieve an order book for a specific trading pair on the Stellar blockchain. The order book provides information about the current bids and asks for the specified assets. + +### Example use cases: + +1. **Order Book Data Retrieval:** + Developers and applications can use this method to retrieve order book data for trading pairs on the Stellar network. + +2. **Trading Pair Analysis:** + Traders and investors can analyze the current order book to make informed decisions about buying or selling assets. + +3. **Streaming Order Book:** + Users can use streaming mode to listen for updates to the order book in real-time. + +### Request Parameters + +The `getOrderBook` method accepts a single `params` object with the following properties: + +- `sellingAssetType` (string, required): + The asset type of the selling asset (e.g., "native" or "credit_alphanum4" or "credit_alphanum12"). + +- `sellingAssetIssuer` (string, optional): + The issuer account of the selling asset (required if the selling asset type is not "native"). + +- `sellingAssetCode` (string, optional): + The asset code of the selling asset (required if the selling asset type is not "native"). + +- `buyingAssetType` (string, required): + The asset type of the buying asset (e.g., "native" or "credit_alphanum4" or "credit_alphanum12"). + +- `buyingAssetIssuer` (string, optional): + The issuer account of the buying asset (required if the buying asset type is not "native"). + +- `buyingAssetCode` (string, optional): + The asset code of the buying asset (required if the buying asset type is not "native"). + +- `limit` (number, optional): + An optional parameter to specify the maximum number of bids and asks to return. The limit can range from 1 to 200. + +### Return Object + +The `getOrderBook` method returns an order book for the specified trading pair on the Stellar blockchain. The order book includes a list of bids (buy orders) and asks (sell orders) with details such as price and quantity. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "bids": [ + { + "price_r": { + "n": "10000000", + "d": "139999999" + }, + "price": "0.0714286", + "amount": "24.9999990" + }, + { + "price_r": { + "n": "1", + "d": "14" + }, + "price": "0.0714286", + "amount": "188.0000000" + }, + { + "price_r": { + "n": "1", + "d": "15" + }, + "price": "0.0666667", + "amount": "230.3200000" + }, + { + "price_r": { + "n": "1", + "d": "16" + }, + "price": "0.0625000", + "amount": "50.0000000" + } + ], + "asks": [ + { + "price_r": { + "n": "5000000", + "d": "62500001" + }, + "price": "0.0800000", + "amount": "4.9400001" + }, + { + "price_r": { + "n": "10000000", + "d": "125000001" + }, + "price": "0.0800000", + "amount": "2516.5154327" + }, + { + "price_r": { + "n": "2", + "d": "25" + }, + "price": "0.0800000", + "amount": "3125.0000000" + }, + { + "price_r": { + "n": "4", + "d": "49" + }, + "price": "0.0816327", + "amount": "4593.7500000" + } + ], + "base": { + "asset_type": "native" + }, + "counter": { + "asset_type": "credit_alphanum4", + "asset_code": "BB1", + "asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN" + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getPayments.md b/v1.0/RPC Nodes/others/rpc-stellar/getPayments.md new file mode 100644 index 00000000..1fea2516 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getPayments.md @@ -0,0 +1,158 @@ +--- +title: "getPayments" +slug: "rpc-stellar-getPayments" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, + includeFailed: true, + join: true, +}; + +// List all successful payment-related operations +const allPayments = await tatum.rpc.listAllPayments(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `listAllPayments` method allows you to list all successful payment-related operations on the Stellar blockchain. + +### Example use cases: + +1. **Payment Monitoring:** + Developers and applications can use this method to monitor and retrieve information about all successful payment-related operations on the Stellar network. + +2. **Payment Filtering:** + Platform administrators can filter and search for specific payments based on various criteria, such as cursor, order, and more. + +3. **Streaming Payments:** + Users can use streaming mode to listen for new payments as they are added to the Stellar ledger. + +### Request Parameters + +The `listAllPayments` method accepts a single `params` object with the following properties: + +- `cursor` (string, optional): + An optional cursor to start listing payments from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of payments to return. The limit can range from 1 to 200. + +- `includeFailed` (boolean, optional): + An optional parameter to include failed payments. If set to true, failed payments will be included in the results. Defaults to false. + +- `join` (boolean, optional): + An optional parameter to join results. If set to true, results will be joined. Defaults to false. + +### Return Object + +The `listAllPayments` method returns an array of successful payment-related operations on the Stellar blockchain. Each operation object corresponds to a payment operation, and it contains information such as the operation ID, source account, destination account, amount, asset, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/payments?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/payments?cursor=215271955673706503&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/payments?cursor=215271955673169921&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215271955673169921" + }, + "transaction": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/transactions/c2b52adc99766007cf1cb1f218b2c40b9771123450282e0d6e3c0be69159880d" + }, + "effects": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/215271955673169921/effects" + }, + "succeeds": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=desc&cursor=215271955673169921" + }, + "precedes": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/effects?order=asc&cursor=215271955673169921" + } + }, + "id": "215271955673169921", + "paging_token": "215271955673169921", + "transaction_successful": true, + "source_account": "GCEETSI6ZGG3CS37YUFAUKCCJSCOILXL43JOJVZ435KBJ5NICDYY4EMP", + "type": "path_payment_strict_send", + "type_i": 13, + "created_at": "2024-01-28T14:07:11Z", + "transaction_hash": "c2b52adc99766007cf1cb1f218b2c40b9771123450282e0d6e3c0be69159880d", + "asset_type": "credit_alphanum4", + "asset_code": "yXLM", + "asset_issuer": "GARDNV3Q7YGT4AKSDF25LT32YSCCW4EV22Y2TV3I2PU2MMXJTEDL5T55", + "from": "GCEETSI6ZGG3CS37YUFAUKCCJSCOILXL43JOJVZ435KBJ5NICDYY4EMP", + "to": "GCEETSI6ZGG3CS37YUFAUKCCJSCOILXL43JOJVZ435KBJ5NICDYY4EMP", + "amount": "1.0291984", + "path": [ + { + "asset_type": "credit_alphanum4", + "asset_code": "PL", + "asset_issuer": "GBV34DLSYPWQYJTWGC6AYDRNSU7YM244SD4NLPBLDR7D74PZMFEL5OMG" + }, + { + "asset_type": "credit_alphanum4", + "asset_code": "XRP", + "asset_issuer": "GCNSGHUCG5VMGLT5RIYYZSO7VQULQKAJ62QA33DBC5PPBSO57LFWVV6P" + }, + { + "asset_type": "credit_alphanum4", + "asset_code": "XRP", + "asset_issuer": "GBXRPL45NPHCVMFFAYZVUVFFVKSIZ362ZXFP7I2ETNQ3QKZMFLPRDTD5" + }, + { + "asset_type": "credit_alphanum4", + "asset_code": "SHX", + "asset_issuer": "GDSTRSHXHGJ7ZIVRBXEYE5Q74XUVCUSEKEBR7UCHEUUEK72N7I7KJ6JH" + } + ], + "source_amount": "1.0000000", + "destination_min": "1.0000000", + "source_asset_type": "native" + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getStrictReceivePaymentPaths.md b/v1.0/RPC Nodes/others/rpc-stellar/getStrictReceivePaymentPaths.md new file mode 100644 index 00000000..31ae332d --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getStrictReceivePaymentPaths.md @@ -0,0 +1,190 @@ +--- +title: "getStrictReceivePaymentPaths" +slug: "rpc-stellar-getStrictReceivePaymentPaths" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + sourceAccount: "SOURCE_ACCOUNT", + sourceAssets: ["CODE:ISSUER_ACCOUNT", "CODE:ISSUER_ACCOUNT2"], + destinationAssetType: "DESTINATION_ASSET_TYPE", + destinationAssetIssuer: "DESTINATION_ASSET_ISSUER", + destinationAssetCode: "DESTINATION_ASSET_CODE", + destinationAmount: "DESTINATION_AMOUNT", +}; + +// List strict receive payment paths +const paymentPaths = await tatum.rpc.listStrictReceivePaymentPaths(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `listStrictReceivePaymentPaths` method allows you to list the payment paths a payment can take based on the amount of an asset you want the recipient to receive. The destination asset amount remains constant, and the type and amount of the source asset sent varies based on offers in the order books. The methods requires either a list of source assets or a source account. Both fields cannot be present. + +### Example use cases: + +1. **Payment Path Analysis:** + Developers and applications can use this method to analyze and retrieve payment paths based on specific destination amounts and assets. + +2. **Payment Path Selection:** + Users can select the optimal payment path to ensure that a recipient receives a specific amount of a destination asset. + +3. **Streaming Payment Paths:** + Users can use streaming mode to listen for updates to payment paths in real-time. + +### Request Parameters + +The `listStrictReceivePaymentPaths` method accepts a `params` object with the following properties: + +- `sourceAccount` (string, required if sourceAssets are not selected): + The source account from which to start the payment path search. + +- `sourceAssets` (array of strings, required if sourceAccount is not selected): + An array of source assets that are available to the sender. A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict receive path payments. + +- `destinationAssetType` (string, required): + The asset type of the destination asset (e.g., "native" or "credit_alphanum4" or "credit_alphanum12"). + +- `destinationAssetIssuer` (string, optional): + The issuer account of the destination asset (required if the destination asset type is not "native"). + +- `destinationAssetCode` (string, optional): + The asset code of the destination asset (required if the destination asset type is not "native"). + +- `destinationAmount` (string, required): + The amount of the destination asset that the recipient should receive. + +### Return Object + +The `listStrictReceivePaymentPaths` method returns a list of payment paths from the source assets to the destination asset that satisfy the specified destination amount. Each path includes details about the source and destination assets, as well as the offers in the order books that make up the path. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "value": { + "_embedded": { + "records": [ + { + "source_asset_type": "credit_alphanum4", + "source_asset_code": "CNY", + "source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX", + "source_amount": "28.9871131", + "destination_asset_type": "credit_alphanum4", + "destination_asset_code": "BB1", + "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN", + "destination_amount": "5.0000000", + "path": [ + { + "asset_type": "credit_alphanum4", + "asset_code": "XCN", + "asset_issuer": "GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY" + }, + { + "asset_type": "native" + } + ] + }, + { + "source_asset_type": "credit_alphanum4", + "source_asset_code": "CNY", + "source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX", + "source_amount": "29.0722784", + "destination_asset_type": "credit_alphanum4", + "destination_asset_code": "BB1", + "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN", + "destination_amount": "5.0000000", + "path": [ + { + "asset_type": "credit_alphanum4", + "asset_code": "ULT", + "asset_issuer": "GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT" + }, + { + "asset_type": "native" + } + ] + }, + { + "source_asset_type": "credit_alphanum4", + "source_asset_code": "CNY", + "source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX", + "source_amount": "29.4000002", + "destination_asset_type": "credit_alphanum4", + "destination_asset_code": "BB1", + "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN", + "destination_amount": "5.0000000", + "path": [ + { + "asset_type": "native" + } + ] + }, + { + "source_asset_type": "credit_alphanum4", + "source_asset_code": "CNY", + "source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX", + "source_amount": "31.8955888", + "destination_asset_type": "credit_alphanum4", + "destination_asset_code": "BB1", + "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN", + "destination_amount": "5.0000000", + "path": [ + { + "asset_type": "credit_alphanum4", + "asset_code": "USD", + "asset_issuer": "GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU" + }, + { + "asset_type": "native" + } + ] + }, + { + "source_asset_type": "credit_alphanum4", + "source_asset_code": "CNY", + "source_asset_issuer": "GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX", + "source_amount": "34.7086084", + "destination_asset_type": "credit_alphanum4", + "destination_asset_code": "BB1", + "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN", + "destination_amount": "5.0000000", + "path": [ + { + "asset_type": "credit_alphanum4", + "asset_code": "USD", + "asset_issuer": "GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX" + }, + { + "asset_type": "native" + } + ] + } + ] + } + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getStrictSendPaymentPaths.md b/v1.0/RPC Nodes/others/rpc-stellar/getStrictSendPaymentPaths.md new file mode 100644 index 00000000..b98bbcc1 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getStrictSendPaymentPaths.md @@ -0,0 +1,138 @@ +--- +title: "getStrictSendPaymentPaths" +slug: "rpc-stellar-getStrictSendPaymentPaths" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + sourceAccount: "SOURCE_ACCOUNT", + sourceAssets: ["SOURCE_ASSET_1", "SOURCE_ASSET_2"], + sourceAssetType: "SOURCE_ASSET_TYPE", + sourceAssetIssuer: "SOURCE_ASSET_ISSUER", + sourceAssetCode: "SOURCE_ASSET_CODE", + sourceAmount: "SOURCE_AMOUNT", + destinationAccount: "DESTINATION_ACCOUNT", + destinationAssets: ["DESTINATION_ASSET_1", "DESTINATION_ASSET_2"], +}; + +// List strict send payment paths +const paymentPaths = await tatum.rpc.getStrictSendPaymentPaths(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getStrictSendPaymentPaths` method allows you to list the payment paths a payment can take based on the amount of a source asset you want to send. The source asset amount remains constant, and the type and amount of the asset received vary based on offers in the order books. + +### Example use cases: + +1. **Payment Path Analysis:** + Developers and applications can use this method to analyze and retrieve payment paths based on specific source amounts and assets. + +2. **Payment Path Selection:** + Users can select the optimal payment path to send a specific source amount and receive a variable amount of a destination asset. + +3. **Streaming Payment Paths:** + Users can use streaming mode to listen for updates to payment paths in real-time. + +### Request Parameters + +The `getStrictSendPaymentPaths` method accepts a `params` object with the following properties: + +- `sourceAccount` (string, optional): + The source account from which to start the payment path search. + +- `sourceAssets` (array of strings, optional): + An array of source assets that the sender wants to send. + +- `sourceAssetType` (string, required): + The asset type of the source asset (e.g., "native" or "credit_alphanum4" or "credit_alphanum12"). + +- `sourceAssetIssuer` (string, optional): + The issuer account of the source asset (required if the source asset type is not "native"). + +- `sourceAssetCode` (string, optional): + The asset code of the source asset (required if the source asset type is not "native"). + +- `sourceAmount` (string, required): + The constant amount of the source asset that the sender wants to send. + +- `destinationAccount` (string, required if destinationAssets are not present): + The destination account to which the recipient can receive the assets. + +- `destinationAssets` (array of strings, required if destinationAccount is not present): + An array of destination assets that the recipient can receive. + +### Return Object + +The `getStrictSendPaymentPaths` method returns a list of payment paths from the source assets to the destination asset that satisfy the specified source amount. Each path includes details about the source and destination assets, as well as the offers in the order books that make up the path. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "value": { + "_embedded": { + "records": [ + { + "source_asset_type": "credit_alphanum4", + "source_asset_code": "BRL", + "source_asset_issuer": "GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP", + "source_amount": "400.0000000", + "destination_asset_type": "credit_alphanum4", + "destination_asset_code": "BB1", + "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN", + "destination_amount": "87.6373649", + "path": [ + { + "asset_type": "native" + } + ] + }, + { + "source_asset_type": "credit_alphanum4", + "source_asset_code": "BRL", + "source_asset_issuer": "GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP", + "source_amount": "400.0000000", + "destination_asset_type": "credit_alphanum4", + "destination_asset_code": "BB1", + "destination_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN", + "destination_amount": "36.0841597", + "path": [ + { + "asset_type": "native" + }, + { + "asset_type": "credit_alphanum4", + "asset_code": "EURT", + "asset_issuer": "GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S" + } + ] + } + ] + } + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getTradeAggregations.md b/v1.0/RPC Nodes/others/rpc-stellar/getTradeAggregations.md new file mode 100644 index 00000000..273f31cc --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getTradeAggregations.md @@ -0,0 +1,184 @@ +--- +title: "getTradeAggregations" +slug: "rpc-stellar-getTradeAggregations" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + startTime: "START_TIME", + endTime: "END_TIME", + resolution: "RESOLUTION", + offset: "OFFSET", + baseAssetType: "BASE_ASSET_TYPE", + baseAssetIssuer: "BASE_ASSET_ISSUER", + baseAssetCode: "BASE_ASSET_CODE", + counterAssetType: "COUNTER_ASSET_TYPE", + counterAssetIssuer: "COUNTER_ASSET_ISSUER", + counterAssetCode: "COUNTER_ASSET_CODE", + order: "asc", + limit: 10, +}; + +// List trade aggregations +const tradeAggregations = await tatum.rpc.getTradeAggregations(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getTradeAggregations` method allows you to list trade data based on filters set in the arguments. It divides a given time range into segments and aggregates statistics for a given asset pair (base, counter) over each of these segments. The duration of the segments is specified with the `resolution` parameter. The `startTime` and `endTime` parameters define the start and end of the time range, which are both rounded to the nearest multiple of `resolution` since epoch. The individual segments are also aligned with multiples of `resolution` since epoch. If you want to change this alignment, the segments can be offset by specifying the `offset` parameter. + +### Example use cases: + +1. **Trade Data Analysis:** + Developers and applications can use this method to analyze and retrieve aggregated trade data for specific asset pairs over a specified time range. + +2. **Historical Trade Statistics:** + Users can request historical trade statistics for asset pairs to gain insights into trading activity. + +3. **Trade Data Visualization:** + Data visualization tools can use this method to generate charts and graphs of trade data over time. + +### Request Parameters + +The `getTradeAggregations` method accepts a `params` object with the following properties: + +- `startTime` (string, optional): + The start time of the time range for trade aggregations. + +- `endTime` (string, optional): + The end time of the time range for trade aggregations. + +- `resolution` (string, optional): + The duration of each aggregation segment (e.g., '1d' for one day, '1h' for one hour). + +- `offset` (string, optional): + An optional parameter to offset the segments from multiples of `resolution` since epoch. + +- `baseAssetType` (string, required): + The asset type of the base asset (e.g., 'native' or 'credit_alphanum4' or 'credit_alphanum12'). + +- `baseAssetIssuer` (string, optional): + The issuer account of the base asset (required if the base asset type is not 'native'). + +- `baseAssetCode` (string, optional): + The asset code of the base asset (required if the base asset type is not 'native'). + +- `counterAssetType` (string, required): + The asset type of the counter asset (e.g., 'native' or 'credit_alphanum4' or 'credit_alphanum12'). + +- `counterAssetIssuer` (string, optional): + The issuer account of the counter asset (required if the counter asset type is not 'native'). + +- `counterAssetCode` (string, optional): + The asset code of the counter asset (required if the counter asset type is not 'native'). + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of trade aggregations to return. The limit can range from 1 to 200. + +### Return Object + +The `getTradeAggregations` method returns an array of trade aggregations based on the specified parameters. Each trade aggregation object contains statistics and data for a specific time segment and asset pair. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "value": { + "_links": { + "self": { + "href": "https://horizon.stellar.org/trade_aggregations?base_asset_type=native&counter_asset_code=EURT&counter_asset_issuer=GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S&counter_asset_type=credit_alphanum4&resolution=3600000&start_time=1582156800000&end_time=1582178400001" + }, + "next": { + "href": "https://horizon.stellar.org/trade_aggregations?base_asset_type=native&counter_asset_code=EURT&counter_asset_issuer=GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S&counter_asset_type=credit_alphanum4&end_time=1582178400001&resolution=3600000&start_time=1582171200000" + }, + "prev": { + "href": "" + } + }, + "_embedded": { + "records": [ + { + "timestamp": 1582164000000, + "trade_count": 3, + "base_volume": "399.3873200", + "counter_volume": "25.5368082", + "avg": "0.0639400", + "high": "0.0652169", + "high_r": { + "N": 652169, + "D": 10000000 + }, + "low": "0.0638338", + "low_r": { + "N": 8107550, + "D": 127010393 + }, + "open": "0.0652169", + "open_r": { + "N": 652169, + "D": 10000000 + }, + "close": "0.0638338", + "close_r": { + "N": 8107550, + "D": 127010393 + } + }, + { + "timestamp": 1582167600000, + "trade_count": 1, + "base_volume": "149.8415320", + "counter_volume": "9.7149804", + "avg": "0.0648350", + "high": "0.0648350", + "high_r": { + "N": 5000000, + "D": 77118803 + }, + "low": "0.0648350", + "low_r": { + "N": 5000000, + "D": 77118803 + }, + "open": "0.0648350", + "open_r": { + "N": 5000000, + "D": 77118803 + }, + "close": "0.0648350", + "close_r": { + "N": 5000000, + "D": 77118803 + } + } + ] + } + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getTrades.md b/v1.0/RPC Nodes/others/rpc-stellar/getTrades.md new file mode 100644 index 00000000..19d51ee0 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getTrades.md @@ -0,0 +1,151 @@ +--- +title: "getTrades" +slug: "rpc-stellar-getTrades" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define input parameters as an object (Replace placeholders with actual values and remove redundant) +const params = { + offerId: "YOUR_OFFER_ID", + baseAssetType: "YOUR_BASE_ASSET_TYPE", + baseAssetIssuer: "YOUR_BASE_ASSET_ISSUER", + baseAssetCode: "YOUR_BASE_ASSET_CODE", + counterAssetType: "YOUR_COUNTER_ASSET_TYPE", + counterAssetIssuer: "YOUR_COUNTER_ASSET_ISSUER", + counterAssetCode: "YOUR_COUNTER_ASSET_CODE", + tradeType: "YOUR_TRADE_TYPE", + cursor: "YOUR_CURSOR", + order: "YOUR_ORDER", + limit: 10, +}; + +// List all trades or use streaming mode to listen for new trades +const trades = await tatum.rpc.listTrades(params); + +// Log the list of trades +console.log("Trades:", trades); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `listTrades` method allows you to list all trades on the Stellar blockchain. You can also use streaming mode to listen for new trades as they are added to the Stellar ledger. When called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. + +### Request Parameters + +The `listTrades` method accepts the following request parameters: + +- `offerId` (string, optional): + The identifier of the offer to filter trades. Use this parameter to list trades for a specific offer. + +- `baseAssetType` (string, optional): + The asset type of the base asset to filter trades. Use this parameter to filter trades by the base asset type. + +- `baseAssetIssuer` (string, optional): + The issuer account of the base asset to filter trades. Use this parameter to filter trades by the base asset issuer. + +- `baseAssetCode` (string, optional): + The asset code of the base asset to filter trades. Use this parameter to filter trades by the base asset code. + +- `counterAssetType` (string, optional): + The asset type of the counter asset to filter trades. Use this parameter to filter trades by the counter asset type. + +- `counterAssetIssuer` (string, optional): + The issuer account of the counter asset to filter trades. Use this parameter to filter trades by the counter asset issuer. + +- `counterAssetCode` (string, optional): + The asset code of the counter asset to filter trades. Use this parameter to filter trades by the counter asset code. + +- `tradeType` (string, optional): + The type of trade to filter. Use this parameter to filter trades by trade type. + +- `cursor` (string, optional): + A cursor value that determines the starting point for pagination. Use this parameter to retrieve trades from a specific point in the list. + +- `order` (string, optional): + A designation of the order in which records should appear. Options include 'asc' (ascending) or 'desc' (descending). If this argument isn’t set, it defaults to 'asc'. + +- `limit` (number, optional): + The maximum number of records returned. It defines the number of trades to fetch in a single request. + +### Response + +The `listTrades` method returns a JSON object containing the list of trades that match the specified criteria. Each trade is represented as an object with various properties describing its characteristics. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "_links": { + "self": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/trades?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/trades?cursor=214305588031721473-2&limit=10&order=asc" + }, + "prev": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/trades?cursor=214305588031623169-0&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "" + }, + "base": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GBZVMDOMNU5ZNDAUVHCSZXFJ6FJRBNXFL6NTY2BBANBVNM6NWPGTFUCV" + }, + "counter": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/accounts/GA4QH4AJGERVYX4PBY55JYTQJ4RTLJIBYV7OCYIV56LWZE5MVDH3R3UQ" + }, + "operation": { + "href": "https://01-vinthill-068-01.rpc.tatum.io/operations/214305588031623169" + } + }, + "id": "214305588031623169-0", + "paging_token": "214305588031623169-0", + "ledger_close_time": "2024-01-13T08:44:04Z", + "trade_type": "orderbook", + "base_offer_id": "1449996661", + "base_account": "GBZVMDOMNU5ZNDAUVHCSZXFJ6FJRBNXFL6NTY2BBANBVNM6NWPGTFUCV", + "base_amount": "1.0756875", + "base_asset_type": "credit_alphanum4", + "base_asset_code": "MOBI", + "base_asset_issuer": "GA6HCMBLTZS5VYYBCATRBRZ3BZJMAFUDKYYF6AH6MVCMGWMRDNSWJPIH", + "counter_offer_id": "4825991606459011073", + "counter_account": "GA4QH4AJGERVYX4PBY55JYTQJ4RTLJIBYV7OCYIV56LWZE5MVDH3R3UQ", + "counter_amount": "0.0959902", + "counter_asset_type": "native", + "base_is_seller": true, + "price": { + "n": "10000000", + "d": "112062267" + } + } + ] + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getTransaction.md b/v1.0/RPC Nodes/others/rpc-stellar/getTransaction.md new file mode 100644 index 00000000..dad092a6 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getTransaction.md @@ -0,0 +1,109 @@ +--- +title: "getTransaction" +slug: "rpc-stellar-getTransaction" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const transactionHash = "YOUR_TRANSACTION_HASH"; + +// Retrieve a specific transaction by its hash +const transaction = await tatum.rpc.getTransaction(transactionHash); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getTransaction` method allows you to retrieve information about a specific transaction on the Stellar blockchain. You can specify the transaction you want to retrieve by providing its unique transaction hash. + +### Example use cases: + +1. **Transaction Details:** + Developers and applications can use this method to fetch detailed information about a specific transaction, including its source, destination, amount, and other transaction-specific data. + +2. **Transaction Verification:** + Users can use this method to verify and validate specific transactions on the Stellar network. + +3. **Auditing and Reporting:** + Platform administrators can access transaction data for auditing and reporting purposes. + +### Request Parameters + +The `getTransaction` method accepts a `transactionHash` parameter, which is a string representing the unique hash of the transaction you want to retrieve. + +- `transactionHash` (string, required): + The unique hash of the transaction you want to retrieve. + +### Return Object + +The `getTransaction` method returns detailed information about the specified transaction on the Stellar blockchain. The response includes data such as the transaction ID, source account, destination account, amount, fee, and other transaction-specific details. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "value": { + "_links": { + "self": { + "href": "https://horizon.stellar.org/transactions/5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc" + }, + "account": { + "href": "https://horizon.stellar.org/accounts/GDI5EK4HNMBHJJQGP3GUXQJIIOHU2CJO3LABPWD6WYSPJZP5NP67TMNN" + }, + "ledger": { + "href": "https://horizon.stellar.org/ledgers/27963785" + }, + "operations": { + "href": "https://horizon.stellar.org/transactions/5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc/operations{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://horizon.stellar.org/transactions/5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc/effects{?cursor,limit,order}", + "templated": true + }, + "precedes": { + "href": "https://horizon.stellar.org/transactions?order=asc&cursor=120103542047408128" + }, + "succeeds": { + "href": "https://horizon.stellar.org/transactions?order=desc&cursor=120103542047408128" + } + }, + "id": "5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc", + "paging_token": "120103542047408128", + "successful": true, + "hash": "5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc", + "ledger": 27963785, + "created_at": "2020-01-28T10:03:33Z", + "source_account": "GDI5EK4HNMBHJJQGP3GUXQJIIOHU2CJO3LABPWD6WYSPJZP5NP67TMNN", + "source_account_sequence": "65046128646685383", + "fee_charged": 100, + "max_fee": 100, + "operation_count": 1, + "envelope_xdr": "hex data", + "result_xdr": "AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=", + "result_meta_xdr": "hex data", + "fee_meta_xdr": "hex data" + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getTransactionEffects.md b/v1.0/RPC Nodes/others/rpc-stellar/getTransactionEffects.md new file mode 100644 index 00000000..5632694f --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getTransactionEffects.md @@ -0,0 +1,139 @@ +--- +title: "getTransactionEffects" +slug: "rpc-stellar-getTransactionEffects" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + hash: "YOUR_TRANSACTION_HASH", // Replace with the actual transaction hash + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, +}; + +// Get effects for a specific transaction +const transactionEffects = await tatum.rpc.getTransactionsEffects(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `Retrieve a Transaction's Effects` method allows you to retrieve the effects of a specific transaction on the Stellar blockchain. You can use this method to view the various effects produced by the transaction, such as offers created, payments made, and more. + +### Example use cases: + +1. **Transaction Analysis:** + Developers and applications can use this method to analyze the effects of a particular transaction, including its impact on the Stellar network. + +2. **Auditing and Reporting:** + Users can retrieve the effects of a transaction for auditing and reporting purposes. + +### Request Parameters + +The `Retrieve a Transaction's Effects` method accepts the following parameters: + +- `hash` (string, required): + The hash of the transaction for which you want to retrieve effects. + +- `cursor` (string, optional): + An optional cursor to start listing effects from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of effects to return. The limit can range from 1 to 200. + +### Return Object + +The `Retrieve a Transaction's Effects` method returns an array of effects associated with the specified transaction on the Stellar blockchain. Each effect object contains information such as the effect type, asset details, and other relevant data. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +Feel free to replace `'YOUR_TRANSACTION_HASH'` with the actual hash of the transaction you want to retrieve effects for. + +```json +{ + "value": { + "_links": { + "self": { + "href": "https://horizon.stellar.org/transactions/512a9946bc7ff4a363299f14f79e0beb9b9cdbd0103e3a69a44446a0aa6471a8/effects?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://horizon.stellar.org/transactions/512a9946bc7ff4a363299f14f79e0beb9b9cdbd0103e3a69a44446a0aa6471a8/effects?cursor=121628667754319873-2&limit=10&order=asc" + }, + "prev": { + "href": "https://horizon.stellar.org/transactions/512a9946bc7ff4a363299f14f79e0beb9b9cdbd0103e3a69a44446a0aa6471a8/effects?cursor=121628667754319873-1&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "operation": { + "href": "https://horizon.stellar.org/operations/121628667754319873" + }, + "succeeds": { + "href": "https://horizon.stellar.org/effects?order=desc&cursor=121628667754319873-1" + }, + "precedes": { + "href": "https://horizon.stellar.org/effects?order=asc&cursor=121628667754319873-1" + } + }, + "id": "0121628667754319873-0000000001", + "paging_token": "121628667754319873-1", + "account": "GAHK7EEG2WWHVKDNT4CEQFZGKF2LGDSW2IVM4S5DP42RBW3K6BTODB4A", + "type": "account_credited", + "type_i": 2, + "created_at": "2020-02-20T21:18:33Z", + "asset_type": "native", + "amount": "1573.5112616" + }, + { + "_links": { + "operation": { + "href": "https://horizon.stellar.org/operations/121628667754319873" + }, + "succeeds": { + "href": "https://horizon.stellar.org/effects?order=desc&cursor=121628667754319873-2" + }, + "precedes": { + "href": "https://horizon.stellar.org/effects?order=asc&cursor=121628667754319873-2" + } + }, + "id": "0121628667754319873-0000000002", + "paging_token": "121628667754319873-2", + "account": "GA2XP4KMY4KWNPW4KUCUKYUF2J7Y6HO5HLPUEA3VPVSMYCM3TGNEZP5S", + "type": "account_debited", + "type_i": 3, + "created_at": "2020-02-20T21:18:33Z", + "asset_type": "native", + "amount": "1573.5112616" + } + ] + } + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getTransactionOperations.md b/v1.0/RPC Nodes/others/rpc-stellar/getTransactionOperations.md new file mode 100644 index 00000000..948a36be --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getTransactionOperations.md @@ -0,0 +1,141 @@ +--- +title: "getTransactionOperations" +slug: "rpc-stellar-getTransactionOperations" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + transactionHash: 'TRANSACTION_HASH' + cursor: 'YOUR_CURSOR', + order: 'asc', + limit: 10, + includeFailed: true, + join: true +}; + +// Get operations for a specific transaction +const transactionOperations = await tatum.rpc.getTransactionsOperations(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getTransactionsOperations` method allows you to retrieve Successful operations for a specific transaction on the Stellar blockchain. You can use this method to fetch the operations associated with a particular transaction. + +### Example use cases: + +1. **Transaction Analysis:** + Users can retrieve the operations related to a specific transaction for analysis and auditing purposes. + +2. **Transaction History:** + Developers can use this method to obtain the operations performed within a specific transaction. + +### Request Parameters + +The `getTransactionsOperations` method accepts the following optional parameters: + +- `transaction_hash` (string, required): + The hash of the transaction for which you want to retrieve operations. + +- `cursor` (string, optional): + An optional cursor to start listing operations from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of operations to return. The limit can range from 1 to 200. + +- `includeFailed` (boolean, optional): + An optional parameter to include failed operations. If set to true, failed operations will be included in the results. Defaults to false. + +- `join` (boolean, optional): + Set to transactions to include the transactions which created each of the operations in the response. + +### Response Object + +The `getTransactionsOperations` method returns an array of Successful operations related to the specified transaction. Each operation object contains information such as the operation type, source account, destination account, amount, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "value": { + "_links": { + "self": { + "href": "https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a/operations?cursor=&limit=10&order=asc" + }, + "next": { + "href": "https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a/operations?cursor=120133379185221636&limit=10&order=asc" + }, + "prev": { + "href": "https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a/operations?cursor=120133379185221633&limit=10&order=desc" + } + }, + "_embedded": { + "records": [ + { + "_links": { + "self": { + "href": "https://horizon.stellar.org/operations/120133379185221633" + }, + "transaction": { + "href": "https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a" + }, + "effects": { + "href": "https://horizon.stellar.org/operations/120133379185221633/effects" + }, + "succeeds": { + "href": "https://horizon.stellar.org/effects?order=desc&cursor=120133379185221633" + }, + "precedes": { + "href": "https://horizon.stellar.org/effects?order=asc&cursor=120133379185221633" + } + }, + "id": "120133379185221633", + "paging_token": "120133379185221633", + "transaction_successful": true, + "source_account": "GDJX67SFY2N73H72TWMKKBQP5UPBNKBNUMNE2IGFKNES43S4327X6DHG", + "type": "manage_buy_offer", + "type_i": 12, + "created_at": "2020-01-28T21:14:59Z", + "transaction_hash": "6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a", + "amount": "0.0000000", + "price": "0.0001000", + "price_r": { + "n": 1, + "d": 10000 + }, + "buying_asset_type": "native", + "selling_asset_type": "credit_alphanum4", + "selling_asset_code": "ETH", + "selling_asset_issuer": "GBDEVU63Y6NTHJQQZIKVTC23NWLQVP3WJ2RI2OTSJTNYOIGICST6DUXR", + "offer_id": 149983118 + } + ] + } + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/getTransactions.md b/v1.0/RPC Nodes/others/rpc-stellar/getTransactions.md new file mode 100644 index 00000000..1b857831 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/getTransactions.md @@ -0,0 +1,145 @@ +--- +title: "getTransactions" +slug: "rpc-stellar-getTransactions" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const params = { + cursor: "YOUR_CURSOR", + order: "asc", + limit: 10, + includeFailed: true, +}; + +// Get a list of transactions +const transactions = await tatum.rpc.getTransactions(params); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getTransactions` method allows you to retrieve a list of transactions on the Stellar blockchain. You can use this method in streaming mode to listen for new transactions as they are added to the Stellar ledger. When used in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time. + +### Example use cases: + +1. **Transaction Monitoring:** + Developers and applications can use this method to monitor and track all transactions on the Stellar network in real-time. + +2. **Transaction Data Analysis:** + Users can retrieve a list of transactions for analysis, reporting, and auditing purposes. + +3. **Stream Transactions:** + You can use streaming mode to receive real-time updates of new transactions on the Stellar ledger. + +### Request Parameters + +The `getTransactions` method accepts the following optional parameters: + +- `cursor` (string, optional): + An optional cursor to start listing transactions from a specific point. + +- `order` (string, optional): + An optional parameter to specify the order of listing (asc or desc). If not provided, it defaults to 'asc'. + +- `limit` (number, optional): + An optional parameter to specify the maximum number of transactions to return. The limit can range from 1 to 200. + +- `includeFailed` (boolean, optional): + An optional parameter to include failed transactions. If set to true, failed transactions will be included in the results. Defaults to false. + +### Return Object + +The `getTransactions` method returns an array of transactions on the Stellar blockchain. Each transaction object contains information such as the transaction ID, source account, destination account, amount, fee, and more. + +(Note: The exact fields in the return object might vary based on the Stellar blockchain's implementation and version.) + +```json +{ + "value": { + "_links": { + "self": { + "href": "https://horizon.stellar.org/transactions?cursor=&limit=3&order=asc" + }, + "next": { + "href": "https://horizon.stellar.org/transactions?cursor=33736968114176&limit=3&order=asc" + }, + "prev": { + "href": "https://horizon.stellar.org/transactions?cursor=12884905984&limit=3&order=desc" + } + }, + "_embedded": { + "records": [ + { + "memo": "hello world", + "_links": { + "self": { + "href": "https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889" + }, + "account": { + "href": "https://horizon.stellar.org/accounts/GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7" + }, + "ledger": { + "href": "https://horizon.stellar.org/ledgers/3" + }, + "operations": { + "href": "https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/operations{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/effects{?cursor,limit,order}", + "templated": true + }, + "precedes": { + "href": "https://horizon.stellar.org/transactions?order=asc&cursor=12884905984" + }, + "succeeds": { + "href": "https://horizon.stellar.org/transactions?order=desc&cursor=12884905984" + } + }, + "id": "3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889", + "paging_token": "12884905984", + "successful": true, + "hash": "3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889", + "ledger": 3, + "created_at": "2015-09-30T17:15:54Z", + "source_account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7", + "source_account_sequence": "1", + "fee_charged": 300, + "max_fee": 300, + "operation_count": 3, + "envelope_xdr": "AAAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhAAABLAAAAAAAAAABAAAAAAAAAAEAAAALaGVsbG8gd29ybGQAAAAAAwAAAAAAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAAAAAAAAQAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAN4Lazj4x61AAAAAAAAAAFAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABLaqcIQAAAEBKwqWy3TaOxoGnfm9eUjfTRBvPf34dvDA0Nf+B8z4zBob90UXtuCqmQqwMCyH+okOI3c05br3khkH0yP4kCwcE", + "result_xdr": "AAAAAAAAASwAAAAAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAFAAAAAAAAAAA=", + "result_meta_xdr": "AAAAAAAAAAMAAAACAAAAAAAAAAMAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAADAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAMAAAAAAAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhDeC2s5t4PNQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAwAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQAAAAAL68IAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAL68IAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDzUAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAABAAAAAwAAAAAAAAAAAZRyYo7njrknFNItA5CWPCTZJ+oAmZlIbokfrC2qnCEAAAAAC+vCAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=", + "fee_meta_xdr": "AAAAAgAAAAMAAAABAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnZAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnY/7UAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==", + "memo_type": "text", + "signatures": [ + "SsKlst02jsaBp35vXlI300Qbz39+HbwwNDX/gfM+MwaG/dFF7bgqpkKsDAsh/qJDiN3NOW695IZB9Mj+JAsHBA==" + ] + } + ] + } + } +} +``` diff --git a/v1.0/RPC Nodes/others/rpc-stellar/submitTransaction.md b/v1.0/RPC Nodes/others/rpc-stellar/submitTransaction.md new file mode 100644 index 00000000..d28601b9 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-stellar/submitTransaction.md @@ -0,0 +1,120 @@ +--- +title: "submitTransaction" +slug: "rpc-stellar-submitTransaction" +excerpt: "Stellar RPC" +category: 65c5e93c623cad004b45d505 +hidden: false +metadata: + description: "Stellar RPC" + image: [] + keywords: "stellar, rpc" + robots: "index" +createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 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, Stellar, Network } from "@tatumio/tatum"; + +// Initialize the Tatum SDK for Stellar +const tatum = await TatumSDK.init({ network: Network.STELLAR }); + +// Define parameters (Replace placeholders with actual values and remove redundant) +const tx = "BASE64_ENCODED_TRANSACTION_XDR"; + +// Submit a transaction +const result = await tatum.rpc.submitTransaction(tx); + +// 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 transaction to the Stellar network. It takes a single, required parameter, which is the base64-encoded XDR of the transaction. If you submit a transaction that has already been included in a ledger, this endpoint will return the same response as would have been returned for the original transaction submission. This allows for safe resubmission of transactions in error scenarios, as highlighted in the error-handling guide. + +### Example use cases: + +1. **Transaction Submission:** + Developers and applications can use this method to submit transactions to the Stellar network. + +### Request Parameters + +The `submitTransaction` method accepts the following parameters: + +- `tx` (string, required): + The base64-encoded XDR of the transaction to be submitted. + +### Response Object + +The `submitTransaction` method returns the result of the transaction submission. The exact response object may vary based on the Stellar blockchain's implementation and version. + +```json +{ + "value": { + "memo": "Test Transaction", + "memo_bytes": "VGVzdCBUcmFuc2FjdGlvbg==", + "_links": { + "self": { + "href": "https://horizon-testnet.stellar.org/transactions/8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124" + }, + "account": { + "href": "https://horizon-testnet.stellar.org/accounts/GCIHAQVWZH2AB5BB5NP63FBSIREG77LQZZNUVKD2LN2IOCLOT6N72MJN" + }, + "ledger": { + "href": "https://horizon-testnet.stellar.org/ledgers/139575" + }, + "operations": { + "href": "https://horizon-testnet.stellar.org/transactions/8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124/operations{?cursor,limit,order}", + "templated": true + }, + "effects": { + "href": "https://horizon-testnet.stellar.org/transactions/8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124/effects{?cursor,limit,order}", + "templated": true + }, + "precedes": { + "href": "https://horizon-testnet.stellar.org/transactions?order=asc&cursor=599470060347392" + }, + "succeeds": { + "href": "https://horizon-testnet.stellar.org/transactions?order=desc&cursor=599470060347392" + }, + "transaction": { + "href": "https://horizon-testnet.stellar.org/transactions/8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124" + } + }, + "id": "8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124", + "paging_token": "599470060347392", + "successful": true, + "hash": "8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124", + "ledger": 139575, + "created_at": "2021-03-25T21:14:11Z", + "source_account": "GCIHAQVWZH2AB5BB5NP63FBSIREG77LQZZNUVKD2LN2IOCLOT6N72MJN", + "source_account_sequence": "599336916353025", + "fee_account": "GCIHAQVWZH2AB5BB5NP63FBSIREG77LQZZNUVKD2LN2IOCLOT6N72MJN", + "fee_charged": "100", + "max_fee": "100", + "operation_count": 1, + "envelope_xdr": "AAAAAgAAAACQcEK2yfQA9CHrX+2UMkRIb/1wzltKqHpbdIcJbp+b/QAAAGQAAiEYAAAAAQAAAAEAAAAAAAAAAAAAAABgXP3QAAAAAQAAABBUZXN0IFRyYW5zYWN0aW9uAAAAAQAAAAAAAAABAAAAAJBwQrbJ9AD0Ietf7ZQyREhv/XDOW0qoelt0hwlun5v9AAAAAAAAAAAF9eEAAAAAAAAAAAFun5v9AAAAQKdJnG8QRiv9xGp1Oq7ACv/xR2BnNqjfUHrGNua7m4tWbrun3+GmAj6ca3xz+4ZppWRTbvTUcCxvpbHERZ85QgY=", + "result_xdr": "AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=", + "result_meta_xdr": "AAAAAgAAAAIAAAADAAIhNwAAAAAAAAAAkHBCtsn0APQh61/tlDJESG/9cM5bSqh6W3SHCW6fm/0AAAAXSHbnnAACIRgAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAIhNwAAAAAAAAAAkHBCtsn0APQh61/tlDJESG/9cM5bSqh6W3SHCW6fm/0AAAAXSHbnnAACIRgAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAA=", + "fee_meta_xdr": "AAAAAgAAAAMAAiEYAAAAAAAAAACQcEK2yfQA9CHrX+2UMkRIb/1wzltKqHpbdIcJbp+b/QAAABdIdugAAAIhGAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAiE3AAAAAAAAAACQcEK2yfQA9CHrX+2UMkRIb/1wzltKqHpbdIcJbp+b/QAAABdIduecAAIhGAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==", + "memo_type": "text", + "max_fee": "100", + "operation_count": 1, + "envelope_xdr": "AAAAAgAAAACQcEK2yfQA9CHrX+2UMkRIb/1wzltKqHpbdIcJbp+b/QAAAGQAAiEYAAAAAQAAAAEAAAAAAAAAAAAAAABgXP3QAAAAAQAAABBUZXN0IFRyYW5zYWN0aW9uAAAAAQAAAAAAAAABAAAAAJBwQrbJ9AD0Ietf7ZQyREhv/XDOW0qoelt0hwlun5v9AAAAAAAAAAAF9eEAAAAAAAAAAAFun5v9AAAAQKdJnG8QRiv9xGp1Oq7ACv/xR2BnNqjfUHrGNua7m4tWbrun3+GmAj6ca3xz+4ZppWRTbvTUcCxvpbHERZ85QgY=", + "result_xdr": "AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=", + "result_meta_xdr": "AAAAAgAAAAIAAAADAAIhNwAAAAAAAAAAkHBCtsn0APQh61/tlDJESG/9cM5bSqh6W3SHCW6fm/0AAAAXSHbnnAACIRgAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAIhNwAAAAAAAAAAkHBCtsn0APQh61/tlDJESG/9cM5bSqh6W3SHCW6fm/0AAAAXSHbnnAACIRgAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAA=", + "fee_meta_xdr": "AAAAAgAAAAMAAiEYAAAAAAAAAACQcEK2yfQA9CHrX+2UMkRIb/1wzltKqHpbdIcJbp+b/QAAABdIdugAAAIhGAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAiE3AAAAAAAAAACQcEK2yfQA9CHrX+2UMkRIb/1wzltKqHpbdIcJbp+b/QAAABdIduecAAIhGAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==", + "memo_type": "text", + "signatures": [ + "p0mcbxBGK/3EanU6rsAK//FHYGc2qN9QesY25rubi1Zuu6ff4aYCPpxrfHP7hmmlZFNu9NRwLG+lscRFnzlCBg==" + ], + "valid_after": "1970-01-01T00:00:00Z", + "valid_before": "2021-03-25T21:17:04Z" + } +} +```