Class SolanaNttClient

Reads the Solana NTT manager and builds its admin instructions. Holds no key.

Index

Constructors

Methods

read readPeers setLimitInstruction setPausedInstruction setPeerInstruction instance

Constructors

constructor

new SolanaNttClient(
    __namedParameters: {
        rpc: () => Promise<Pick<HeliusRpcClient, "getMultipleAccountData">>;
    },
): SolanaNttClient
Parameters
- __namedParameters: { rpc: () => Promise<Pick<HeliusRpcClient, "getMultipleAccountData">> }
Returns SolanaNttClient
- Defined in packages/ntt-services/src/clients/solana/SolanaNttClient.ts:99

Methods

read

read(
__namedParameters: { programId: string },
): Promise<SolanaNttManagerRead | null>
The manager's config, or null when the program has no config account.
Parameters
- __namedParameters: { programId: string }
Returns Promise<SolanaNttManagerRead | null>
- Defined in packages/ntt-services/src/clients/solana/SolanaNttClient.ts:120

readPeers

readPeers(
__namedParameters: { peerChainIds: number[]; programId: string },
): Promise<Record<string, SolanaNttPeerRead>>
Each id with a peer account; an unset peer is left out.
Parameters
- __namedParameters: { peerChainIds: number[]; programId: string }
Returns Promise<Record<string, SolanaNttPeerRead>>
- Defined in packages/ntt-services/src/clients/solana/SolanaNttClient.ts:158

setLimitInstruction

setLimitInstruction(
    __namedParameters: {
        limit: bigint;
        owner: Address;
        peerChainId?: number;
        programId: string;
    },
): Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >,
>
setOutboundLimit, or setInboundLimit with peerChainId.
Parameters
- __namedParameters: { limit: bigint; owner: Address; peerChainId?: number; programId: string }
  - limit: bigint
    
    In this manager's base units.
  - owner: Address
  - OptionalpeerChainId?: number
  - programId: string
Returns Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >,
>
- Defined in packages/ntt-services/src/clients/solana/SolanaNttClient.ts:266

setPausedInstruction

setPausedInstruction(
    __namedParameters: { owner: Address; pause: boolean; programId: string },
): Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >,
>
setPaused, signed by the owner.
Parameters
- __namedParameters: { owner: Address; pause: boolean; programId: string }
Returns Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >,
>
- Defined in packages/ntt-services/src/clients/solana/SolanaNttClient.ts:198

setPeerInstruction

setPeerInstruction(
    __namedParameters: {
        inboundLimit: bigint;
        owner: Address;
        payer: Address;
        peerAddress: `0x${string}`;
        peerChainId: number;
        peerDecimals: number;
        programId: string;
    },
): Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >,
>
setPeer, which creates the peer and its inbox limit: 2.0.0 cannot replace one.
Parameters
- __namedParameters: {
      inboundLimit: bigint;
      owner: Address;
      payer: Address;
      peerAddress: `0x${string}`;
      peerChainId: number;
      peerDecimals: number;
      programId: string;
  }
  - inboundLimit: bigint
    
    In this manager's base units.
  - owner: Address
  - payer: Address
  - peerAddress: `0x${string}`
  - peerChainId: number
  - peerDecimals: number
  - programId: string
Returns Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >,
>
- Defined in packages/ntt-services/src/clients/solana/SolanaNttClient.ts:220

`Static`instance

instance(): SolanaNttClient
Returns SolanaNttClient
- Defined in packages/ntt-services/src/clients/solana/SolanaNttClient.ts:89