Interface IPrivateApiClient

Private API client interface for creating an API to interact with a Massa Node.

interface IPrivateApiClient {
    nodeAddStakingSecretKeys(secretKeys): Promise<void>;
    nodeAddToPeersWhitelist(ipAddress): Promise<void>;
    nodeBanById(id): Promise<void>;
    nodeBanByIpAddress(ipAddress): Promise<void>;
    nodeGetStakingAddresses(): Promise<string[]>;
    nodeRemoveFromWhitelist(ipAddress): Promise<void>;
    nodeRemoveStakingAddresses(addresses): Promise<void>;
    nodeSignMessage(message): Promise<ISignedMessage>;
    nodeStop(): Promise<void>;
    nodeUnbanById(nodeId): Promise<void>;
    nodeUnbanByIpAddress(ipAddress): Promise<void>;
}

Implemented by

Methods

nodeAddStakingSecretKeys nodeAddToPeersWhitelist nodeBanById nodeBanByIpAddress nodeGetStakingAddresses nodeRemoveFromWhitelist nodeRemoveStakingAddresses nodeSignMessage nodeStop nodeUnbanById nodeUnbanByIpAddress

Methods

nodeAddStakingSecretKeys

  • nodeAddStakingSecretKeys(secretKeys): Promise<void>

  • Method to add staking addresses to the node.

    Parameters

    • secretKeys: string[]

      The array of the secret keys of addresses to add to the node.

    Returns Promise<void>

    • A promise so that the call can be asynchronous.

nodeAddToPeersWhitelist

  • nodeAddToPeersWhitelist(ipAddress): Promise<void>

  • Method to add a node to the whitelist.

    Parameters

    • ipAddress: string

      The IP address of the node to add to the whitelist.

    Returns Promise<void>

    • A promise so that the call can be asynchronous.

nodeBanById

nodeBanByIpAddress

nodeGetStakingAddresses

nodeRemoveFromWhitelist

  • nodeRemoveFromWhitelist(ipAddress): Promise<void>

  • Method to remove a node from the whitelist.

    Parameters

    • ipAddress: string

      The IP address of the node to remove from the whitelist.

    Returns Promise<void>

    • A promise so that the call can be asynchronous.

nodeRemoveStakingAddresses

  • nodeRemoveStakingAddresses(addresses): Promise<void>

  • Method to remove staking addresses from the node.

    Parameters

    • addresses: string[]

      The array of addresses to remove from the node.

    Returns Promise<void>

    • A promise so that the call can be asynchronous.

nodeSignMessage

nodeStop

nodeUnbanById

nodeUnbanByIpAddress

  • nodeUnbanByIpAddress(ipAddress): Promise<void>

  • Method to unban a node by its IP address.

    Parameters

    • ipAddress: string

      The IP address of the node to unban.

    Returns Promise<void>

    • A promise so that the call can be asynchronous.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc