Spray Client

​

Installation

docker pull subsquid/spray:latest
docker run -p 3000:3000 -v $(pwd)/config.yaml:/config.yaml subsquid/spray:latest /config.yaml

​

Configuration

sources:
  mainnet:
    url: grpc://your-geyser-endpoint:10000
    x_token: your-token  # optional
    x_access_token: your-access-token  # optional

port: 3000  # optional, defaults to 3000

​

Subscription API

​

Subscribe to Data

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "spraySubscribe",
  "params": [{
    "includeAllBlocks": false,
    "fields": {
      "block": {
        "number": true,
        "hash": true,
        "timestamp": true
      },
      "transaction": {
        "transactionIndex": true,
        "signatures": true,
        "err": true,
        "fee": true
      },
      "instruction": {
        "programId": true,
        "accounts": true,
        "data": true
      }
    },
    "transactions": [{
      "feePayer": ["address1", "address2"]
    }],
    "instructions": [{
      "programId": ["program1", "program2"],
      "d8": ["0x0102030405060708"],
      "a0": ["account1"]
    }],
    "balances": [{
      "account": ["address1"]
    }],
    "tokenBalances": [{
      "preMint": ["mint1"],
      "postMint": ["mint2"]
    }]
  }]
}

​

Query Parameters

• includeAllBlocks (boolean) - Include all block headers, not just blocks with matching transactions
• fields (object) - Specify which fields to include in responses

• transactions - Array of transaction filters
• instructions - Array of instruction filters
• balances - Array of balance change filters
• tokenBalances - Array of token balance change filters

• feePayer - Filter by fee payer addresses
• mentionsAccount - Filter by any mentioned account
• instructions - Include all instructions
• logs - Include transaction logs
• balances - Include balance changes
• tokenBalances - Include token balance changes

• programId - Filter by program ID
• discriminator - Filter by instruction discriminator (variable length)
• d1, d2, d4, d8 - Filter by fixed-length discriminators (1, 2, 4, 8 bytes)
• mentionsAccount - Filter by any account in instruction
• a0 through a15 - Filter by specific account positions
• isCommitted - Filter by commitment status
• transaction - Include parent transaction
• transactionInstructions - Include all instructions from transaction
• innerInstructions - Include inner instructions
• parentInstructions - Include parent instructions

• account - Filter by account address
• transaction - Include parent transaction
• transactionInstructions - Include transaction instructions

• account - Filter by account address
• preMint, postMint - Filter by token mint (before/after)
• preProgramId, postProgramId - Filter by token program
• preOwner, postOwner - Filter by token owner
• transaction - Include parent transaction
• transactionInstructions - Include transaction instructions

​

Response Format

{
  "type": "block",
  "slot": 123456789,
  "header": {
    "number": 123456789,
    "hash": "...",
    "timestamp": 1234567890
  }
}

{
  "type": "transaction",
  "slot": 123456789,
  "transactionIndex": 42,
  "transaction": {
    "signatures": ["..."],
    "fee": "5000"
  },
  "instructions": [...],
  "balances": [...],
  "tokenBalances": [...]
}

​

Unsubscribe

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "sprayUnsubscribe",
  "params": ["subscription_id"]
}

​

Metrics

• spray_blocks_published - Number of blocks pushed to subscriptions
• spray_transactions_published - Number of transactions pushed to subscriptions
• spray_last_block - Last published block number
• spray_active_subscriptions - Number of active client subscriptions
• spray_data_source_errors - Number of data source connection errors
• spray_mapping_errors - Number of data mapping errors

​

Source Code