Endpoints

loadNimbusSdk starts from the mainnet preset. The preset holds the programs, the supported tokens, every service's endpoint and the proving keys. So your app passes only where it serves the SDK's files.

Any endpoint you pass replaces the preset's, one at a time. sdk.settings.endpoints shows every endpoint after your options are applied.

The mainnet endpointsCopy Anchor Link

The mainnet preset supports 57 tokens. These are its endpoints, read from the SDK when this site was built:

"Gateway" marks the services that need the gateway token.

Use your own RPCCopy Anchor Link

The preset's RPC is https://api.mainnet-beta.solana.com, Solana's public endpoint. It limits how often one client may call it, and syncing calls it often. Pass your provider's endpoint instead:

import { loadNimbusSdk } from "@umbra/nimbus-solana-web";

const sdk = await loadNimbusSdk(
  { cluster: "mainnet" },
  {
    assetsBaseUrl: "/nimbus/",
    endpoints: { rpc: "https://mainnet.your-rpc-provider.example" },
  },
);

Use your own servicesCopy Anchor Link

The same endpoints option replaces any service, such as a relayer you run yourself:

import { loadNimbusSdk } from "@umbra/nimbus-solana-web";

const sdk = await loadNimbusSdk(
  { cluster: "mainnet" },
  {
    assetsBaseUrl: "/nimbus/",
    endpoints: { relayer: "https://relayer.your-app.example" },
  },
);

The guardians, screeners and data endorsers are lists of nodes, each with its nodeIndex. Guardian nodes are numbered from 1. Screener and data endorser nodes are numbered from 0.

A service the gateway fronts still receives the gateway token at its new address. The one exception is an address that shares its origin with a service reached directly, such as the RPC. That service gets no token, and its requests fail unauthorized.

Route through the coordinatorCopy Anchor Link

By default, the browser asks each service itself. With route: "coordinator", one service makes those requests for it, beside the other services. The requests a payment makes at one step go to it together, in one exchange.

import { loadNimbusSdk } from "@umbra/nimbus-solana-web";

const sdk = await loadNimbusSdk(
  { cluster: "mainnet" },
  { assetsBaseUrl: "/nimbus/", route: "coordinator" },
);

A busy service that turns a request away is asked again, up to three times in all.

Registration, the relayer's policy, following a payment, the RPC, the indexer and the prover stay direct on both routes. The mainnet preset configures the coordinator.

NextCopy Anchor Link