Triton One

https://docs.triton.one
Admin
Triton One provides high-performance, reliable, and fast blockchain RPC services with advanced...
Tokens:147,086
Snippets:1,013
Trust Score:8.4
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install with Yarn

Source: https://docs.triton.one/project-yellowstone/yellowstone-account-sync-beta

Install the Triton SDK using Yarn. Run this command in the project root.

```bash
yarn add @triton-one/triton-sdk
```

--------------------------------

### Install with pnpm

Source: https://docs.triton.one/project-yellowstone/yellowstone-account-sync-beta

Install the Triton SDK using pnpm. Run this command in the project root.

```bash
pnpm add @triton-one/triton-sdk
```

--------------------------------

### Install with npm

Source: https://docs.triton.one/project-yellowstone/yellowstone-account-sync-beta

Install the Triton SDK using npm. Run this command in the project root.

```bash
npm install @triton-one/triton-sdk
```

--------------------------------

### Install @codama/renderers-vixen-parser

Source: https://docs.triton.one/project-yellowstone/vixen-parsing-framework/generate-parsers-with-codama

Installs the Codama package that provides the Vixen parser renderer.

```bash
pnpm install @codama/renderers-vixen-parser
```

--------------------------------

### Example CLI usage

Source: https://docs.triton.one/chains/solana/preconfirmations-grpc

The repository ships `preconfs-subscribe`, which subscribes and logs every event. Examples show how to use it with various options.

```APIDOC
## Example CLI usage

### Description
The repository ships `preconfs-subscribe`, which subscribes and logs every event. Examples show how to use it with various options.

### Code
```bash
cargo run -p preconfs-example -- --x-token $TOKEN --region harmonic:ams \
    --account TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA
```

```bash
cargo run -p preconfs-example -- --x-token $TOKEN --region bam:fra \
    --instruction dbcij3LWUppWqq96dh6gJWwBifmcGfLSB5D4DuSMaqN:0:c9cff3724b6f2fbd
```
```

--------------------------------

### Example response for GET subscription

Source: https://docs.triton.one/account-management/api-access/subscriptions

Sample JSON response for a successful subscription retrieval. It includes the subscription object with account, supported rate tiers, endpoints, and deactivation reasons.

```json
{
   "subscription": {
      "uuid": "5d8d4591-12cc-424a-8f39-32de0ba6acc3",
      "name": "Example App",
      "account_uuid": "4ad26b8a-a9a1-4f9b-b0fa-c13a682d64b1",
      "subscription_type": "mainnet-shared",
      "starts_at": null,
      "ends_at": null,
      "is_active": false,
      "created_at": "2023-05-02T16:32:46Z",
      "updated_at": "2023-05-02T16:32:46Z",
      "users_count": 1,
      "tokens_count": 0,
      "endpoints_count": 1,
      "subscriptions_count": 2,
      "is_helio_pay_stream_active": false,
      "pay_stream_id": "639cbcba989eacb2574a055",
      "metrics_enabled": false,
      "payment_method": "manual",
      "maximum_tokens": -1,
      "allow_ip_ranges": false,
      "supported_rate_tiers": [ // A roll-up of related supported rate tiers
         {
            "uuid": "ca141f49-a989-4a46-8f39-32de0ba6acc3",
            "name": "developer",
            "active_tokens_count": 5,
            "endpoints_count": 1,
            "subscriptions_count": 2
         }
      ],
      "endpoints": [ // A roll-up of related endpoints
         {
            "uuid": "23ab660b-a9a1-4f9b-b0fa-c13a682d64b1",
            "name": "Jacobson LLC cbp4i3u71m",
            "value": null,
            "slug": "academy-strict-fnalfmab4l",
            "rate_tier": "developer",
            "is_active": true,
            "value_override": null,
            "values": [
               "academy-strict-fnalfmab4l.TEST 1",
               "academy-strict-fnalfmab4l.TWST 2"
            ],
            "default_values": [
               "academy-strict-fnalfmab4l.TEST 1",
               "academy-strict-fnalfmab4l.TWST 2"
            ],
            "allowed_origins": [
               {
                  "id": 1,
                  "uuid": "b4d5ec62-410d-45f8-8b45-44fe6641cf1f",
                  "value": "vonrueden-haag.co",
                  "endpoint_id": 1,
                  "created_at": "2023-05-02T16:32:46Z",
                  "updated_at": "2023-05-02T16:32:46Z",
                  "is_active": true
               }
            ]
         }
      ],
      "tokens": [ // A roll-up of related tokens
         {
            "uuid": "fa2fec9c-8aa3-4fa2-b09e-361f6af8d972",
            "name": "Token name",
            "value": "8d8c4591-47cc-424a-8f39-32de0ba6acc3",
            "rate_tier": "tier1",
            "auth_username": "tylerqt-tylerwi-db8c",
            "is_active": false
         }
      ],
      "deactivation_reasons": [
         {
            "description": "Deactivation reason description",
            "created_at": "2023-07-03T16:32:46Z"
         }
      ]
   }
}
```

--------------------------------

### grpcurl subscription example

Source: https://docs.triton.one/project-yellowstone/dragons-mouth-grpc-subscriptions

Example command to subscribe to Solana gRPC streams using grpcurl. Requires geyser.proto and the x-token header. Replace endpoint and token with your own.

```bash
./grpcurl \
  -proto geyser.proto \
  -d '{"slots": { "slots": { } }, "accounts": { "usdc": { "account": ["9wFFyRfZBsuAha4YcuxcXLKwMxJR43S7fPfQLusDBzvT"] } }, "transactions": {}, "blocks": {}, "blocks_meta": {}}' \
  -H "x-token: <token>" \
  api.rpcpool.com:443 \
  geyser.Geyser/Subscribe
```

--------------------------------

### Install NodeJS Yellowstone gRPC client

Source: https://docs.triton.one/project-yellowstone/dragons-mouth-grpc-subscriptions

Install the @triton-one/yellowstone-grpc package using npm or yarn.

```bash
npm install --save @triton-one/yellowstone-grpc

# or, for yarn:

yarn add @triton-one/yellowstone-grpc
```

--------------------------------

### Install @triton-one/vixen-stream with npm

Source: https://docs.triton.one/project-yellowstone/program-data-streams

Installs the Triton One Vixen Stream SDK for TypeScript/Node.js. Run this command in your project directory.

```bash
npm install @triton-one/vixen-stream
```

--------------------------------

### Minimal Vixen Pipeline Example

Source: https://docs.triton.one/project-yellowstone/vixen-parsing-framework

A minimal example that listens to Token Program updates and logs parsed data. It sets up a logger handler, builds a runtime with a Yellowstone gRPC source, and runs with a config file.

```rust
use yellowstone_vixen::Pipeline;
use yellowstone_vixen_parser::token_program::{AccountParser, InstructionParser};
use yellowstone_vixen_yellowstone_grpc_source::YellowstoneGrpcSource;

#[derive(Debug)]
pub struct Logger;

impl<V: std::fmt::Debug + Sync> vixen::Handler<V> for Logger {
    async fn handle(&self, value: &V) -> vixen::HandlerResult<()> {
        tracing::info!(?value);
        Ok(())
    }
}

fn main() {
    // Set up logging and config parsing
    ...

    yellowstone_vixen::Runtime::builder()
        .source(YellowstoneGrpcSource::new())
        .account(Pipeline::new(AccountParser, [Logger]))
        .instruction(Pipeline::new(InstructionParser, [Logger]))
        .metrics(yellowstone_vixen::metrics::Prometheus)
        .commitment_level(yellowstone_vixen::CommitmentLevel::Confirmed)
        .build(config)
        .run();
}
```

--------------------------------

### Complete lifecycle example with Triton SDK

Source: https://docs.triton.one/project-yellowstone/yellowstone-account-sync-beta

A full example that creates a Connection with accountSync GRPC transport, adds/removes/sets accounts, reads account info, and closes the connection. The SDK does not enforce an account-count limit; practical limits depend on your endpoint, memory, CPU, network, and the account-sync service.

```typescript
import {
  AccountSyncTransports,
  Connection,
  PublicKey,
} from "@triton-one/triton-sdk";

const endpoint = process.env.RPC_ENDPOINT;

if (!endpoint) throw new Error("Set RPC_ENDPOINT");

const address = new PublicKey(
  "So11111111111111111111111111111111111111112",
);

const newAddress = new PublicKey(
  "ping6gwBZx1ccMMFyLgkVSupUmujYrFidEXuNRPq989",
);

const connection = new Connection(endpoint, {
  accountSync: {
    transport: AccountSyncTransports.GRPC,
    initialAccounts: [],
    dynamicSubscriptionTtlMs: 60_000,
  },
});

try {
  await connection.addAccounts([address]);

  const first = await connection.getAccountInfoAndContext(address);
  console.log("First read:", first);

  await connection.removeAccounts([address]);

  // Re-add it before the next read so it remains pinned.
  await connection.addAccounts([address]);

  const second = await connection.getAccountInfoAndContext(address);
  console.log("Read after re-add:", second);

  // Clear all buffered accounts and pin new accounts
  await connection.setAccounts([newAddress]);

  // Read the new accounts
  const third = await connection.getAccountInfoAndContext(newAddress);
  console.log("New account:", third);
} finally {
  // close the streams and clear the buffered accounts
  await connection.close();
}
```

--------------------------------

### Install node-ws on Linux

Source: https://docs.triton.one/chains/monad

Required for testing WebSocket connections. Run these commands in a Linux terminal to install node-ws.

```bash
sudo apt update
sudo apt install node-ws
```

--------------------------------

### SearchAssets Request Example

Source: https://docs.triton.one/digital-assets-api/fungible-assets

Example JSON-RPC request to search assets by owner address and token type. The method is 'searchAssets' and the tokenType is set to 'All'.

```json
{
    "jsonrpc": "2.0",
    "id": "string",
    "method": "searchAssets",
    "params": {
        "ownerAddress": "5aZZ4duJUKiMsJN9vRsoAn4SDX7agvKu7Q3QdFWRfWze",
        "tokenType": "All"
    }
}
```

--------------------------------

### SearchAssets Response Example

Source: https://docs.triton.one/digital-assets-api/fungible-assets

Example response for a searchAssets request, showing metadata and token_info for a fungible token. Includes balance, supply, decimals, token_program, and associated_token_address.

```json
{
    "id": "TokenMintAddress",
    "content": {
        "metadata": {
            "name": "Jito Staked SOL",
            "symbol": "JitoSOL",
            "token_standard": "Fungible"
        },
        "token_info": {
            "symbol": "EXT",
            "balance": 1000000000,
            "supply": 500000000000,
            "decimals": 9,
            "token_program": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA",
            "associated_token_address": "H7iLu4DPFpzEx1AGN8BCN7Qg966YFndt781p6ukhgki9"
        }
    }
}
```

--------------------------------

### Pin initial accounts at startup

Source: https://docs.triton.one/project-yellowstone/yellowstone-account-sync-beta

Pins accounts to be tracked from the start by providing them in the accountSync.initialAccounts option.

```javascript
const connection = new Connection(endpoint, {
  accountSync: {
    initialAccounts: [addressA, addressB],
  },
});
```

--------------------------------

### Install Shield CLI

Source: https://docs.triton.one/project-yellowstone/shield-transaction-policies

Commands to clone and build the yellowstone-shield repository, producing the yellowstone-shield-cli binary.

```bash
git clone https://github.com/rpcpool/yellowstone-shield
cd yellowstone-shield
cargo build --release --bin yellowstone-shield-cli
```

--------------------------------

### logsNotification stream data example

Source: https://docs.triton.one/project-yellowstone/whirligig-websockets

Example of the streamed notification from logsSubscribe, containing logs of program invocations and a signature.

```json
{
  "jsonrpc": "2.0",
  "method": "logsNotification",
  "params": {
    "result": {
      "context": {
        "apiVersion": "1.16.1",
        "slot": 206126709
      },
      "value": {
        "err": null,
        "logs": [
          "Program FC81tbGt6JWRXidaWYFXxGnTk4VgobhJHATvTRVMqgWj invoke [1]",
          "Program log: process_instruction: FC81tbGt6JWRXidaWYFXxGnTk4VgobhJHATvTRVMqgWj: 3 accounts, data=[12]",
          "Program log: Instruction: UpdateLendingPool",
          "Program log: current_borrow_rate: 73081853393945351",
          "Program FC81tbGt6JWRXidaWYFXxGnTk4VgobhJHATvTRVMqgWj consumed 23800 of 1000000 compute units",
          "Program FC81tbGt6JWRXidaWYFXxGnTk4VgobhJHATvTRVMqgWj success",
          "Program FC81tbGt6JWRXidaWYFXxGnTk4VgobhJHATvTRVMqgWj invoke [1]",
          "Program log: process_instruction: FC81tbGt6JWRXidaWYFXxGnTk4VgobhJHATvTRVMqgWj: 3 accounts, data=[12]",
          "Program log: Instruction: UpdateLendingPool",
          "Program log: current_borrow_rate: 82164236984041212",
          "Program FC81tbGt6JWRXidaWYFXxGnTk4VgobhJHATvTRVMqgWj consumed 28159 of 976200 compute units",
          "Program FC81tbGt6JWRXidaWYFXxGnTk4VgobhJHATvTRVMqgWj success",
          "Program 2nAAsYdXF3eTQzaeUQS3fr4o782dDg8L28mX39Wr5j8N invoke [1]",
          "Program log: Instruction: LiquidateUnstakeLp",
          "Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA invoke [2]",
          "Program log: Instruction: Transfer",
          "Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA consumed 4740 of 879873 compute units",
          "Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA success",
          "Program 2nAAsYdXF3eTQzaeUQS3fr4o782dDg8L28mX39Wr5j8N consumed 79765 of 948041 compute units",
          "Program 2nAAsYdXF3eTQzaeUQS3fr4o782dDg8L28mX39Wr5j8N success",
          "Program 2nAAsYdXF3eTQzaeUQS3fr4o782dDg8L28mX39Wr5j8N invoke [1]",
          "Program log: Instruction: RemoveLiquidity",
          "Program 2nAAsYdXF3eTQzaeUQS3fr4o782dDg8L28mX39Wr5j8N consumed 24767 of 868276 compute units",
          "Program 2nAAsYdXF3eTQzaeUQS3fr4o782dDg8L28mX39Wr5j8N success",
          "Program 2nAAsYdXF3eTQzaeUQS3fr4o782dDg8L28mX39Wr5j8N invoke [1]",
          "Program log: Instruction: SwapAndWithdraw",
          "Program log: withdraw_type: 2,\n            user_info.pending_repay_0: 0,\n            user_info.pending_repay_1: 0,\n            user_info.tkn_0: 0,\n            user_info.tkn_1: 0,\n            ",
          "Program log: swap_direction: 0,\n            amount_in: 0\n            ",
          "Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA invoke [2]",
          "Program log: Instruction: Transfer",
          "Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA consumed 4785 of 815778 compute units",
          "Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA success",
          "Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA invoke [2]",
          "Program log: Instruction: Transfer",
          "Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA consumed 4831 of 807689 compute units",
          "Program TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA success",
          "Program 2nAAsYdXF3eTQzaeUQS3fr4o782dDg8L28mX39Wr5j8N consumed 47497 of 843509 compute units",
          "Program 2nAAsYdXF3eTQzaeUQS3fr4o782dDg8L28mX39Wr5j8N success"
        ],
        "signature": "5UPB2AEWgUafVDEw2xTkup8CUedxCMNL4k7EMuxtcyi1WnYLmpXeYUfBANpnPnpSz6LRwwLnBQf7tViKSFT7ojiB"
      }
    },
    "subscription": 0
  }
}
```

--------------------------------

### Start Prometheus with Docker Compose

Source: https://docs.triton.one/project-yellowstone/vixen-parsing-framework

Command to start Prometheus locally using Docker Compose to collect Vixen metrics. After running, visit http://localhost:9090 to explore.

```bash
sudo docker-compose up
```

--------------------------------

### blockSubscribe stream data example

Source: https://docs.triton.one/project-yellowstone/whirligig-websockets

Example of a blockNotification message received after subscribing. Contains context with apiVersion and slot, and value with block details including blockHeight, blockTime, blockhash, parentSlot, and previousBlockhash.

```json
{
  "jsonrpc": "2.0",
  "method": "blockNotification",
  "params": {
    "result": {
      "context": {
        "apiVersion": "1.16.1",
        "slot": 206125999
      },
      "value": {
        "block": {
          "blockHeight": 188652385,
          "blockTime": 1689709529,
          "blockhash": "74iqy9xdFvenLkFizkoBkkLRWTyygEeCiiN3B8Z8ma2D",
          "parentSlot": 206125998,
          "previousBlockhash": "Cq5nfgu9Y5KF47J9qj5CTYmt8D5CxBpw8HCRqQZ7o7i9"
        },
        "err": null,
        "slot": 206125999
      }
    },
    "subscription": 0
  }
}
```

--------------------------------

### Rust example: Subscribe to deshred transactions with SubscribeDeshred

Source: https://docs.triton.one/project-yellowstone/dragons-mouth-grpc-subscriptions

Rust example using GeyserGrpcClient to subscribe to deshred transactions. It sets up a client with TLS and window sizes, sends a SubscribeDeshredRequest with filters, and processes incoming deshred updates. Requires the yellowstone-grpc-client and related crates.

```rust
use {
    futures::{sink::SinkExt, stream::StreamExt},
    solana_signature::Signature,
    std::collections::HashMap,
    tonic::transport::channel::ClientTlsConfig,
    yellowstone_grpc_client::GeyserGrpcClient,
    yellowstone_grpc_proto::prelude::{
        subscribe_update_deshred::UpdateOneof, SubscribeDeshredRequest,
        SubscribeRequestFilterDeshredTransactions, SubscribeRequestPing,
    },
};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let endpoint = std::env::var("ENDPOINT")
        .unwrap_or("https://<endpoint>".into());
    let x_token = std::env::var("X_TOKEN").ok();

    let mut client = GeyserGrpcClient::build_from_shared(endpoint)?
        .x_token(x_token)?
        .tls_config(ClientTlsConfig::new().with_native_roots())?
        .http2_adaptive_window(true)
        .initial_connection_window_size(8 * 1024 * 1024) // 8 MiB
        .initial_stream_window_size(4 * 1024 * 1024) // 4 MiB
        .connect()
        .await?;

    let request = SubscribeDeshredRequest {
        deshred_transactions: HashMap::from([(
            "deshred".into(),
            SubscribeRequestFilterDeshredTransactions {
                vote: Some(false),
                account_include: vec![],
                account_exclude: vec![],
                account_required: vec![],
            },
        )]),
        ping: None,
    };

    let (mut tx, mut stream) =
        client.subscribe_deshred_with_request(Some(request)).await?;

    while let Some(msg) = stream.next().await {
        match msg?.update_oneof {
            Some(UpdateOneof::DeshredTransaction(update)) => {
                let info = update.transaction.as_ref().unwrap();
                let sig = Signature::try_from(info.signature.as_slice())?;
                println!("slot={} sig={sig} vote={}", update.slot, info.is_vote);
            }
            Some(UpdateOneof::Ping(_)) => {
                tx.send(SubscribeDeshredRequest {
                    ping: Some(SubscribeRequestPing { id: 1 }),
                    ..Default::default()
                }).await?;
            }
            Some(UpdateOneof::Pong(_)) => {}
            None => break,
        }
    }

    Ok(())
}
```

--------------------------------

### getAssetProofs

Source: https://docs.triton.one/digital-assets-api/metaplex-digital-assets-api/get-asset-proofs

Get merkle proofs for compressed assets by their IDs.

```APIDOC
## getAssetProofs

### Description
Get merkle proofs for compressed assets by their IDs.

### Method
JSON-RPC

### Endpoint
`getAssetProofs`

### Parameters
#### Params
- **ids** (array of strings) - Required - A set of asset IDs used to retrieve proofs.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "id": "123",
  "method": "getAssetProofs",
  "params": {
    "ids": [
      "EZsmgudhX6EFVfrdxmShDiNj365E85x7kpLJCVvPLVSH",
      "Hhxb7pNvwi76WTSqFjMX5yXjSso1S3agEJ9kQZP9NQeJ"
    ]
  }
}
```
```

--------------------------------

### Unsubscribe response with true result

Source: https://docs.triton.one/project-yellowstone/whirligig-websockets

Example response to an unsubscribe request, showing result true when the subscription was active and removed.

```json
{
  "jsonrpc": "2.0",
  "result": true,
  "id": 1
}
```

--------------------------------

### Subscription response with id

Source: https://docs.triton.one/project-yellowstone/whirligig-websockets

Example response from a successful subscription request, returning the subscription id (42) that can be used for unsubscribing.

```json
{
  "jsonrpc": "2.0",
  "result": 42,
  "id": 1
}
```

--------------------------------

### accountSubscribe request

Source: https://docs.triton.one/project-yellowstone/whirligig-websockets

Example accountSubscribe request compatible with the Solana WebSocket API, subscribing to an account with base58 encoding and finalized commitment.

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "accountSubscribe",
  "params": [
    "SysvarC1ock11111111111111111111111111111111",
    {
      "encoding": "base58",
      "commitment": "finalized"
    }
  ]
}
```

--------------------------------

### accountNotification base58 stream data

Source: https://docs.triton.one/project-yellowstone/whirligig-websockets

Example accountNotification stream data for a base58-encoded account, showing the context and value fields.

```json
{
  "jsonrpc": "2.0",
  "method": "accountNotification",
  "params": {
    "result": {
      "context": {
        "apiVersion": "1.16.1",
        "slot": 206122916
      },
      "value": {
        "data": [
          "9AAG2zomYcUVKQfondw13yz193crQ5R5zmzdEojhMPXiyYEjD8viLrb",
          "base58"
        ],
        "executable": false,
        "lamports": 1169280,
        "owner": "Sysvar1111111111111111111111111111111111111",
        "rentEpoch": 361,
        "space": 40
      }
    },
    "subscription": 0
  }
}
```

--------------------------------

### slotUnsubscribe request

Source: https://docs.triton.one/project-yellowstone/whirligig-websockets

Example request to unsubscribe from a subscription using the id returned by the subscribe method. The result is true if the subscription was active and removed, false otherwise.

```json
{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "slotUnsubscribe",
  "params": [42]
}
```

--------------------------------

### GET /api/v1/rate_tiers response

Source: https://docs.triton.one/account-management/api-access/rate-tiers

Example response from the GET /api/v1/rate_tiers endpoint, listing all rate tier types that an Endpoint and Token can be created with.

```json
{
  "rate_tiers": [
    { "name": "free" },
    { "name": "tier1" },
    { "name": "tier2" },
    { "name": "tier3" },
    { "name": "dedi" }
  ]
} 
```

--------------------------------

### Get Account - Request

Source: https://docs.triton.one/account-management/api-access/accounts

Example curl request to retrieve a single account by its UUID. The 'account-uuid' parameter is required and must be provided in the URL path.

```bash
curl 'https://customers.triton.one/api/v1/accounts/c92a9cea-47cc-494b-b1b0-4230a2316ee5' -H "Authorization: secret-api-token" -H "Content-Type: application/json" -H "Accept:application/json" 
```

--------------------------------

### List Accounts - Basic Request

Source: https://docs.triton.one/account-management/api-access/accounts

Example curl request to list all accounts accessible with the current authentication token. Uses the endpoint GET /api/v1/accounts with no parameters.

```bash
curl 'https://customers.triton.one/api/v1/accounts' -H "Authorization: secret-api-token" -H "Content-Type: application/json" -H "Accept:application/json"
```

--------------------------------

### Create Subscription - Sample Response

Source: https://docs.triton.one/account-management/api-access/subscriptions

Example response for a newly created subscription. Note that 'endpoints', 'tokens', and 'deactivation_reasons' arrays are empty because the subscription is new.

```json
{
   "subscription": {
      "uuid": "5d8d4591-12cc-424a-8f39-32de0ba6acc3",
      "name":"Example App",
      "account_uuid": "4ad26b8a-a9a1-4f9b-b0fa-c13a682d64b1",
      "subscription_type": "mainnet-shared",
      "starts_at": null,
      "ends_at": null,
      "is_active": false,
      "account": {
         "uuid": "4ad26b8a-a9a1-4f9b-b0fa-c13a682d64b1",
         "name": "Tyler-qt65u8xzj2",
         "billing_address1": "420 Effertz Estates",
         "billing_address2": null,
         "billing_address3": null,
         "billing_city": "Padbergville",
         "billing_state_or_province": "Alabama",
         "billing_postal_code": "78007",
         "billing_country_code": "US",
         "telephone_country_code": "+61-8",
         "telephone": "870-800-5877",
         "last_time_activated": "02/05/2023",
         "is_active": true,
         "created_at": "2023-05-02T16:32:46Z",
         "updated_at": "2023-05-02T16:32:46Z",
         "users_count": 1,
         "tokens_count": 0,
         "endpoints_count": 1,
         "subscriptions_count": 2,
         "is_helio_pay_stream_active": false,
         "pay_stream_id": "639cbc90a989eacb2574a055",
         "metrics_enabled": false,
         "payment_method": "manual",
         "maximum_tokens": -1,
         "address_watch_lists": false,
         "allow_ip_ranges": false
      },
      "supported_rate_tiers": [
         {
            "uuid": "ca141949-a46f-446a-abee-a031e501fea0",
            "name": "developer",
            "active_tokens_count": 5,
            "active_endpoints_count": 4,
            "supported_subscription_type_uuids": [
               "413defdd-b011-4dda-8145-fa782524284c"
            ]
         }
      ],
      "endpoints_count": 0,
      "tokens_count": 0,
      "endpoints": [],
      "tokens": [],
      "deactivation_reasons": []
   }
}
```

--------------------------------

### Install Codama Dependencies for Parser Generation

Source: https://docs.triton.one/project-yellowstone/vixen-parsing-framework/generate-parsers-with-codama

Installs additional Codama packages required for the parser generation script.

```bash
pnpm install \
  @codama/nodes \
  @codama/nodes-from-anchor \
  @codama/renderers-core \
  @codama/visitors-core
```

--------------------------------

### Run preconfs-subscribe CLI for BAM region with instruction filter

Source: https://docs.triton.one/chains/solana/preconfirmations-grpc

Runs the preconfs-subscribe CLI to subscribe to BAM region 'bam:fra' filtering for transactions invoking the Meteora DBC 'create_config' instruction. Requires a TOKEN environment variable.

```bash
cargo run -p preconfs-example -- --x-token $TOKEN --region bam:fra \
    --instruction dbcij3LWUppWqq96dh6gJWwBifmcGfLSB5D4DuSMaqN:0:c9cff3724b6f2fbd

```

--------------------------------

### List Methods in LedgerService

Source: https://docs.triton.one/chains/sui/grpc

List all methods available in the sui.rpc.v2.LedgerService.

```bash
grpcurl \
  -H "X-Token: <your-token>" \
  XXX.sui.rpcpool.com:443 \
  list sui.rpc.v2.LedgerService
```

--------------------------------

### GET /api/v1/accounts/:account-uuid

Source: https://docs.triton.one/account-management/api-access/accounts

Get Account that the current authentication token has access to. The account UUID is required as a path parameter.

```APIDOC
## GET /api/v1/accounts/:account-uuid

### Description
Get Account that the current authentication token has access to.

### Method
GET

### Endpoint
/api/v1/accounts/:account-uuid

### Parameters
#### Path Parameters
- **account-uuid** (string) - Required - The UUID of the account to retrieve.

### Request Example
```
curl 'https://customers.triton.one/api/v1/accounts/c92a9cea-47cc-494b-b1b0-4230a2316ee5' -H "Authorization: secret-api-token" -H "Content-Type: application/json" -H "Accept:application/json"
```

### Response
#### Success Response (200)
Returns a hash with the `account` key containing an account object. The response data for the account object is the same as for `GET /api/v1/accounts`.

#### Response Example
```
{
   "account": {
      "uuid": "c92a9cea-47cc-494b-b1b0-4230a2316ee5",
      "name": "John Doe",
      "billing_address1": "1645 S Telegraph Rd",
      "billing_address2": null,
      "billing_address3": null,
      "billing_city": "Bloomfield Hills",
      "billing_state_or_province": "Michigan",
      "billing_postal_code": "48302",
      "billing_country_code": "US",
      "telephone_country_code": "US",
      "telephone": "(248) 858-2300",
      "last_time_activated":"28/06/2023",
      "is_active": true,
      "created_at": "2023-06-22T09:11:11Z",
      "updated_at": "2023-06-28T11:26:52Z",
      "users_count": 1,
      "tokens_count": 6,
      "endpoints_count": 4,
      "subscriptions_count": 2,
      "is_helio_pay_stream_active": true,
      "pay_stream_id": "639cbc90a989eacb2574a055",
      "metrics_enabled": false,
      "payment_method": "manual",
      "maximum_tokens": -1,
      "address_watch_lists": false,
      "allow_ip_ranges": false,
      "subscriptions": [
         {
            "uuid": "74ea9d9a-4b2a-4f01-af47-1c175f8a2af6",
            "name": "Mainnet Shared Subscription",
            "account_uuid": "c92a9cea-47cc-494b-b1b0-4230a2316ee5",
            "subscription_type": "mainnet-shared",
            "starts_at": null,
            "ends_at": null,
            "is_active": true,
            "endpoints_count": 2,
            "tokens_count": 4
            "supported_rate_tiers": [
               {
                  "uuid": "ca141949-a46f-446a-abee-a031e501fea0",
                  "name": "developer",
                  "active_tokens_count": 5,
                  "active_endpoints_count": 4,
                  "supported_subscription_type_uuids": [
                     "413defdd-b011-4dda-8145-fa782524284c"
                  ]
               }
            ]
         }
      ],
      "deactivation_reasons": [
         {
            "description": "Deactivation reason description",
            "created_at": "2023-06-26T20:16:05Z"
         }
      ]
   }
}
```
```

--------------------------------

### Prepare Policy Metadata JSON

Source: https://docs.triton.one/project-yellowstone/shield-transaction-policies

Example JSON metadata file for a policy, including name, symbol, description, image, external URL, and attributes.

```json
{
  "name": "My Validator Policy",
  "symbol": "MVP",
  "description": "Blocks validators known for sandwich attacks",
  "image": "https://your-image-url.com/image.png",
  "external_url": "https://your-website.com",
  "attributes": []
}
```

--------------------------------

### Basic accountSync configuration

Source: https://docs.triton.one/project-yellowstone/yellowstone-account-sync-beta

Shows the structure for accountSync settings under the Connection constructor. All account-sync settings belong under accountSync.

```javascript
const connection = new Connection(endpoint, {
  accountSync: {
    // Settings go here.
  },
});
```

--------------------------------

### Comparison object example

Source: https://docs.triton.one/chains/solana/gettransactionsforaddress

Example of a comparison object used for the slot and blockTime filters. Supports gte, gt, lte, lt, and eq operators.

```json
{
  "gte": 250000000,
  "lt": 260000000
}
```
Tokens:
Raw