Class NttManagerAdminService

The stage's NTT managers, EVM and Solana, with both sides of each peering and what CFX can do to each. Writes start nttManagerMutationWorkflow; nothing here signs.

Index

Constructors

constructor

Methods

get pause search setInboundLimit setOutboundLimit setPeer unpause instance

Constructors

constructor

new NttManagerAdminService(
    __namedParameters: {
        evm: Pick<EvmNttClient, "read" | "readPeers">;
        roles: () => Promise<NttRoles>;
        solana: Pick<SolanaNttClient, "read" | "readPeers">;
        temporalClient: Pick<TemporalWorkflowClient<NttWorkflows>, "start">;
    },
): NttManagerAdminService
Parameters
- __namedParameters: {
      evm: Pick<EvmNttClient, "read" | "readPeers">;
      roles: () => Promise<NttRoles>;
      solana: Pick<SolanaNttClient, "read" | "readPeers">;
      temporalClient: Pick<TemporalWorkflowClient<NttWorkflows>, "start">;
  }
  - evm: Pick<EvmNttClient, "read" | "readPeers">
  - roles: () => Promise<NttRoles>
    
    The addresses of the roles CFX holds.
  - solana: Pick<SolanaNttClient, "read" | "readPeers">
  - temporalClient: Pick<TemporalWorkflowClient<NttWorkflows>, "start">
Returns NttManagerAdminService
- Defined in packages/ntt-services/src/NttManagerAdminService.ts:193

Methods

get

get(
    __namedParameters: {
        id: `evm:${number}` | "solana";
        permissions?: readonly string[];
        targetsOnly?: boolean;
    },
): Promise<NttManager | null>
Parameters
- __namedParameters: {
      id: `evm:${number}` | "solana";
      permissions?: readonly string[];
      targetsOnly?: boolean;
  }
Returns Promise<NttManager | null>
- Defined in packages/ntt-services/src/NttManagerAdminService.ts:266

pause

pause(
    args: {
        managerId: `evm:${number}` | "solana";
        permissions: readonly string[];
    },
): Promise<
    | { ok: true; value: { workflowId: string } }
    | { error: StartError; ok: false },
>
The incident action: no confirmation beyond the capability.
Parameters
- args: { managerId: `evm:${number}` | "solana"; permissions: readonly string[] }
Returns Promise<
| { ok: true; value: { workflowId: string } }
| { error: StartError; ok: false },
>
- Defined in packages/ntt-services/src/NttManagerAdminService.ts:285

search

search(
    __namedParameters?: {
        ids?: (`evm:${number}` | "solana")[];
        page?: number;
        pageSize?: number;
        permissions?: readonly string[];
        targetsOnly?: boolean;
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: NttManager[]; total: number };
    },
>
Solana first, then the chain file's order. Every manager is read, since peerings span them; one that cannot be read is READ_FAILED.
Parameters
- __namedParameters: {
      ids?: (`evm:${number}` | "solana")[];
      page?: number;
      pageSize?: number;
      permissions?: readonly string[];
      targetsOnly?: boolean;
  } = {}
  - Optionalids?: (`evm:${number}` | "solana")[]
  - Optionalpage?: number
  - OptionalpageSize?: number
  - Optionalpermissions?: readonly string[]
    
    The viewer's admin permissions; capabilities need ntt:w, and ntt/mainnet:w on mainnet.
  - OptionaltargetsOnly?: boolean
    
    Reads only ids, so another chain's outage cannot stall a write: each peering is UNKNOWN with no there.
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: NttManager[]; total: number };
    },
>
- Defined in packages/ntt-services/src/NttManagerAdminService.ts:212

setInboundLimit

setInboundLimit(
    __namedParameters: {
        limit: BigNumber;
        managerId: `evm:${number}` | "solana";
        peerChainId: number;
        permissions: readonly string[];
    },
): Promise<
    | {
        error: | StartError
        | ServiceError<"PEER_NOT_PINNED">
        | ServiceError<"INVALID_LIMIT">;
        ok: false;
    }
    | { ok: true; value: { workflowId: string } },
>
Parameters
- __namedParameters: {
      limit: BigNumber;
      managerId: `evm:${number}` | "solana";
      peerChainId: number;
      permissions: readonly string[];
  }
  - limit: BigNumber
    
    In this manager's token units; 0 stops transfers in from that peer.
  - managerId: `evm:${number}` | "solana"
  - peerChainId: number
  - permissions: readonly string[]
Returns Promise<
    | {
        error: | StartError
        | ServiceError<"PEER_NOT_PINNED">
        | ServiceError<"INVALID_LIMIT">;
        ok: false;
    }
    | { ok: true; value: { workflowId: string } },
>
- Defined in packages/ntt-services/src/NttManagerAdminService.ts:366

setOutboundLimit

setOutboundLimit(
    __namedParameters: {
        limit: BigNumber;
        managerId: `evm:${number}` | "solana";
        permissions: readonly string[];
    },
): Promise<
    | { ok: true; value: { workflowId: string } }
    | { error: StartError | ServiceError<"INVALID_LIMIT">; ok: false },
>
Parameters
- __namedParameters: {
      limit: BigNumber;
      managerId: `evm:${number}` | "solana";
      permissions: readonly string[];
  }
  - limit: BigNumber
    
    In this manager's token units; 0 stops transfers out.
  - managerId: `evm:${number}` | "solana"
  - permissions: readonly string[]
Returns Promise<
| { ok: true; value: { workflowId: string } }
| { error: StartError | ServiceError<"INVALID_LIMIT">; ok: false },
>
- Defined in packages/ntt-services/src/NttManagerAdminService.ts:344

setPeer

setPeer(
    __namedParameters: {
        inboundLimit: BigNumber;
        managerId: `evm:${number}` | "solana";
        peerChainId: number;
        permissions: readonly string[];
    },
): Promise<
    | { ok: true; value: { workflowId: string } }
    | {
        error:
            | StartError
            | ServiceError<"PEER_NOT_PINNED">
            | ServiceError<"INVALID_LIMIT">;
        ok: false;
    },
>
Sets a pinned peer; its address and decimals come from the chain file, never from here.
Parameters
- __namedParameters: {
      inboundLimit: BigNumber;
      managerId: `evm:${number}` | "solana";
      peerChainId: number;
      permissions: readonly string[];
  }
  - inboundLimit: BigNumber
    
    In this manager's token units.
  - managerId: `evm:${number}` | "solana"
  - peerChainId: number
    
    A Wormhole id the manager's pins name, else PEER_NOT_PINNED.
  - permissions: readonly string[]
Returns Promise<
    | { ok: true; value: { workflowId: string } }
    | {
        error:
            | StartError
            | ServiceError<"PEER_NOT_PINNED">
            | ServiceError<"INVALID_LIMIT">;
        ok: false;
    },
>
- Defined in packages/ntt-services/src/NttManagerAdminService.ts:300

unpause

unpause(
    args: {
        managerId: `evm:${number}` | "solana";
        permissions: readonly string[];
    },
): Promise<
    | { error: StartError; ok: false }
    | { ok: true; value: { workflowId: string } },
>
Parameters
- args: { managerId: `evm:${number}` | "solana"; permissions: readonly string[] }
Returns Promise<
| { error: StartError; ok: false }
| { ok: true; value: { workflowId: string } },
>
- Defined in packages/ntt-services/src/NttManagerAdminService.ts:292

`Static`instance

instance(): NttManagerAdminService
Returns NttManagerAdminService
- Defined in packages/ntt-services/src/NttManagerAdminService.ts:181

Class NttManagerAdminService

Index

Constructors

Methods

Constructors

constructor

Parameters

evm: Pick<EvmNttClient, "read" | "readPeers">

roles: () => Promise<NttRoles>

solana: Pick<SolanaNttClient, "read" | "readPeers">

temporalClient: Pick<TemporalWorkflowClient<NttWorkflows>, "start">

Returns NttManagerAdminService

Methods

get

Parameters

Returns Promise<NttManager | null>

pause

Parameters

Returns Promise< | { ok: true; value: { workflowId: string } } | { error: StartError; ok: false },>

search

Parameters

Optionalids?: (`evm:${number}` | "solana")[]

Optionalpage?: number

OptionalpageSize?: number

Optionalpermissions?: readonly string[]

OptionaltargetsOnly?: boolean

Returns Promise< { ok: true; value: { hasNext: boolean; items: NttManager[]; total: number }; },>

setInboundLimit

Parameters

limit: BigNumber

managerId: `evm:${number}` | "solana"

peerChainId: number

permissions: readonly string[]

Returns Promise< | { error: | StartError | ServiceError<"PEER_NOT_PINNED"> | ServiceError<"INVALID_LIMIT">; ok: false; } | { ok: true; value: { workflowId: string } },>

setOutboundLimit

Parameters

limit: BigNumber

managerId: `evm:${number}` | "solana"

permissions: readonly string[]

Returns Promise< | { ok: true; value: { workflowId: string } } | { error: StartError | ServiceError<"INVALID_LIMIT">; ok: false },>

setPeer

Parameters

inboundLimit: BigNumber

managerId: `evm:${number}` | "solana"

peerChainId: number

permissions: readonly string[]

Returns Promise< | { ok: true; value: { workflowId: string } } | { error: | StartError | ServiceError<"PEER_NOT_PINNED"> | ServiceError<"INVALID_LIMIT">; ok: false; },>

unpause

Parameters

Returns Promise< | { error: StartError; ok: false } | { ok: true; value: { workflowId: string } },>

Staticinstance

Returns NttManagerAdminService

Settings

On This Page

Returns Promise<
| { ok: true; value: { workflowId: string } }
| { error: StartError; ok: false },
>

`Optional`ids?: (`evm:${number}` | "solana")[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`permissions?: readonly string[]

`Optional`targetsOnly?: boolean

Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: NttManager[]; total: number };
},
>

Returns Promise<
| {
error: | StartError
| ServiceError<"PEER_NOT_PINNED">
| ServiceError<"INVALID_LIMIT">;
ok: false;
}
| { ok: true; value: { workflowId: string } },
>

Returns Promise<
| { ok: true; value: { workflowId: string } }
| { error: StartError | ServiceError<"INVALID_LIMIT">; ok: false },
>

Returns Promise<
| { ok: true; value: { workflowId: string } }
| {
error:
| StartError
| ServiceError<"PEER_NOT_PINNED">
| ServiceError<"INVALID_LIMIT">;
ok: false;
},
>

Returns Promise<
| { error: StartError; ok: false }
| { ok: true; value: { workflowId: string } },
>

`Static`instance