getOperations

How to use it

// 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<Stellar>({ 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.)

{
  "_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"
          }
        },