Active grants

const response = await client.request({
  id: ctx.id,
  epoch: ctx.epoch,
  expiresAt: ctx.expiresAt,
  command: {
    kind: 'read',
    query: { family: 'grants', limit: 32 },
  },
});

({
  kind: 'page',
  family: 'grants',
  revision: snapshotRevision,
  next: new Uint8Array(40),
  evaluatedAt: observedAt,
  rows: [
    {
      kind: 'grant',
      grant: {
        key: ctx.agentPublicKey, methods: READ | TRADE | CANCEL,
        market: ctx.market, maximumLots: 2n, maximumFee: 1n,
        maximumOrders: 10n, expiresAt: ctx.agentExpiresAt,
      },
      usedOrders: 1n,
    },
  ],
})

({ kind: 'error', code: 'conflict' })

const response = await client.request({
  id: ctx.id,
  epoch: ctx.epoch,
  expiresAt: ctx.expiresAt,
  command: {
    kind: 'read',
    query: { family: 'grants', limit: 32 },
  },
});

({
  kind: 'page',
  family: 'grants',
  revision: snapshotRevision,
  next: new Uint8Array(40),
  evaluatedAt: observedAt,
  rows: [
    {
      kind: 'grant',
      grant: {
        key: ctx.agentPublicKey, methods: READ | TRADE | CANCEL,
        market: ctx.market, maximumLots: 2n, maximumFee: 1n,
        maximumOrders: 10n, expiresAt: ctx.agentExpiresAt,
      },
      usedOrders: 1n,
    },
  ],
})

({ kind: 'error', code: 'conflict' })

Carrier: POST /v1/exchange (encrypted binary). Read family: grants · Permission: owner or current READ agent. Current Cinder agent terms and accepted-order budget usage. Results are private to the bound account. The same query is available over HTTP and WebSocket, including subscriptions.

These are signed SDK fields and decoded results, not a plaintext JSON HTTP body. The shared carrier accepts encrypted application/octet-stream.

const response = await client.request({
  id: ctx.id,
  epoch: ctx.epoch,
  expiresAt: ctx.expiresAt,
  command: {
    kind: 'read',
    query: { family: 'grants', limit: 32 },
  },
});

({
  kind: 'page',
  family: 'grants',
  revision: snapshotRevision,
  next: new Uint8Array(40),
  evaluatedAt: observedAt,
  rows: [
    {
      kind: 'grant',
      grant: {
        key: ctx.agentPublicKey, methods: READ | TRADE | CANCEL,
        market: ctx.market, maximumLots: 2n, maximumFee: 1n,
        maximumOrders: 10n, expiresAt: ctx.agentExpiresAt,
      },
      usedOrders: 1n,
    },
  ],
})

({ kind: 'error', code: 'conflict' })

Request fields

Use the configured client and envelope. Each request supplies id, current epoch and authentication expiresAt, as shown in the example.

"read"

required

Read-command discriminator.

"grants"

required

Selects this exact private projection.

number

required

Integer from 1 to 64 rows. The example requests 32.

Uint8Array (40 bytes)

Omit or use all-zero bytes to start. For another page, use the prior page’s next under the same snapshot revision.

Response fields

Illustrative decoded SDK values are shown at the right; absent optional fields mean unavailable, not zero. Empty rows is valid.

"page"

required

Paged-response discriminator.

"grants"

required

The requested family.

Uint8Array (32 bytes)

required

Commitment to the permitted snapshot and query identity, not a global activity counter.

Uint8Array (40 bytes)

required

Next cursor; all-zero means no more retained rows.

bigint (u64)

required

Qualified Cinder evaluation time, in milliseconds.

ReadRow[]

required

At most the requested limit.

Show Active grants row fields

"grant"

required

Grant-row discriminator.

Grant

required

Active current-epoch agent terms.

Show grant fields

Uint8Array (32 bytes)

required

Agent Ed25519 public key.

number

required

Permission mask: READ=1, TRADE=2, CANCEL=4.

Uint8Array (32 bytes)

required

One permitted market.

bigint (u64)

required

Maximum absolute lots per accepted order.

bigint (i128)

required

Maximum fee per lot, in quote atoms.

bigint (u64)

required

Lifetime accepted-order budget for this epoch.

bigint (u64)

required

Agent expiry in milliseconds.

bigint (u64)

required

Accepted-order budget consumed; exact retries do not consume another unit.

Behavior

The owner sees active grants; a READ agent sees only its own. Expired or revoked grants and other-agent directories are excluded. These terms are Cinder permissions, not native venue credentials.

Paging and errors

Read queries do not change financial state or consume order budgets. Permissions filter rows before paging. Changed permitted rows return encrypted conflict; restart at zero instead of combining revisions. End-of-pages covers retained rows, not complete external venue history. See paging, errors, limits and availability. A disconnected subscription needs fresh attestation, current authority and a replacement snapshot.

Overview

Commands

Private reads

WebSocket

Request fields

Response fields

Behavior

Paging and errors

​Request fields

​Response fields

​Behavior

​Paging and errors

Request fields

Response fields

Behavior

Paging and errors