@cfxlabsinc/b2b-services
    Preparing search index...

    Type Alias NttManager

    One NTT manager on this stage, read live on every call.

    type NttManager = {
        address: NttRegistryEntry["address"];
        capabilities: Record<NttCapabilityName, NttCapability>;
        chainId: NttRegistryEntry["chainId"];
        id: NttRegistryEntry["id"];
        live:
            | {
                mode: "LOCKING"
                | "BURNING";
                outboundLimit: BigNumber | null;
                owner: string;
                paused: boolean;
                pauser: string | null;
                tokenDecimals: number;
                version: string | null;
                wormholeChainId: number;
            }
            | null;
        name: NttRegistryEntry["name"];
        network: EvmNetwork;
        peerings: NttPeering[];
        pinnedPeers: {
            address: string;
            bytes32: Hex;
            decimals: number;
            peerChainId: number;
            setPeerBlocked: string
            | null;
        }[];
        platform: NttRegistryEntry["platform"];
        readError: string
        | null;
        signable: NttRegistryEntry["signable"];
        state: "NOT_CONFIGURED" | "READ_FAILED" | "NOT_DEPLOYED" | "LIVE";
    }
    Index
    address capabilities chainId id live name network peerings pinnedPeers platform readError signable state
    address: NttRegistryEntry["address"]

    null while no manager is configured, which is read-only and not an error.

    capabilities: Record<NttCapabilityName, NttCapability>
    chainId: NttRegistryEntry["chainId"]
    id: NttRegistryEntry["id"]

    evm:<chainId> or solana.

    live:
        | {
            mode: "LOCKING"
            | "BURNING";
            outboundLimit: BigNumber | null;
            owner: string;
            paused: boolean;
            pauser: string | null;
            tokenDecimals: number;
            version: string | null;
            wormholeChainId: number;
        }
        | null

    Type Declaration

    • {
          mode: "LOCKING" | "BURNING";
          outboundLimit: BigNumber | null;
          owner: string;
          paused: boolean;
          pauser: string | null;
          tokenDecimals: number;
          version: string | null;
          wormholeChainId: number;
      }
      • mode: "LOCKING" | "BURNING"
      • outboundLimit: BigNumber | null

        null when Solana has no outbox account: unknown, not a limit of zero.

      • owner: string
      • paused: boolean
      • pauser: string | null

        EVM only: Solana has no pauser, the owner pauses.

      • tokenDecimals: number
      • version: string | null

        EVM's NTT_MANAGER_VERSION; null on Solana, which is not read yet.

      • wormholeChainId: number
    • null
    name: NttRegistryEntry["name"]
    network: EvmNetwork
    peerings: NttPeering[]
    pinnedPeers: {
        address: string;
        bytes32: Hex;
        decimals: number;
        peerChainId: number;
        setPeerBlocked: string | null;
    }[]

    The reviewed peers setPeer may set: the only ones offered.

    Type Declaration

    • address: string
    • bytes32: Hex
    • decimals: number
    • peerChainId: number
    • setPeerBlocked: string | null

      Why setPeer cannot write this pin; null when it can.

    platform: NttRegistryEntry["platform"]
    readError: string | null

    Why the read failed, with no endpoint in it; null unless READ_FAILED.

    signable: NttRegistryEntry["signable"]

    Whether CFX has a signing path to this manager at all.

    state: "NOT_CONFIGURED" | "READ_FAILED" | "NOT_DEPLOYED" | "LIVE"

    READ_FAILED is this manager alone: live is null and readError says why.

    Settings
    Member Visibility

    On This Page
    Properties