thorest: {
    accounts: {
        get: {
            ACCOUNT_BYTECODE: ((address: string) => string);
            ACCOUNT_DETAIL: ((address: string) => string);
            STORAGE_AT: ((address: string, position: string) => string);
        };
        post: {
            SIMULATE_TRANSACTION: ((revision?: string) => string);
        };
    };
    blocks: {
        get: {
            BLOCK_DETAIL: ((revision: string | number) => string);
        };
    };
    debug: {
        post: {
            RETRIEVE_STORAGE_RANGE: (() => string);
            TRACE_CONTRACT_CALL: (() => string);
            TRACE_TRANSACTION_CLAUSE: (() => string);
        };
    };
    fees: {
        get: {
            FEES_HISTORY: ((blockCount: number, newestBlock: string | number, rewardPercentiles?: number[]) => string);
        };
    };
    logs: {
        post: {
            EVENT_LOGS: (() => string);
            TRANSFER_LOGS: (() => string);
        };
    };
    nodes: {
        get: {
            NODES: (() => string);
        };
    };
    subscriptions: {
        get: {
            BEAT: ((baseURL: string, position?: string) => string);
            BEAT_LEGACY: ((baseURL: string, position?: string) => string);
            BLOCK: ((baseURL: string, position?: string) => string);
            EVENT: ((baseURL: string, options?: EventOptions) => string);
            NEW_TRANSACTIONS: ((baseURL: string) => string);
            VET_TRANSFER: ((baseURL: string, options?: VetTransferOptions) => string);
        };
    };
    transactions: {
        get: {
            TRANSACTION: ((id: string) => string);
            TRANSACTION_RECEIPT: ((id: string) => string);
        };
        post: {
            TRANSACTION: (() => string);
        };
    };
} = ...

Endpoints for the REST API.

Type declaration

  • accounts: {
        get: {
            ACCOUNT_BYTECODE: ((address: string) => string);
            ACCOUNT_DETAIL: ((address: string) => string);
            STORAGE_AT: ((address: string, position: string) => string);
        };
        post: {
            SIMULATE_TRANSACTION: ((revision?: string) => string);
        };
    }

    Accounts related endpoints.

    • get: {
          ACCOUNT_BYTECODE: ((address: string) => string);
          ACCOUNT_DETAIL: ((address: string) => string);
          STORAGE_AT: ((address: string, position: string) => string);
      }
      • ACCOUNT_BYTECODE: ((address: string) => string)
          • (address): string
          • Parameters

            • address: string

            Returns string

      • ACCOUNT_DETAIL: ((address: string) => string)
          • (address): string
          • Parameters

            • address: string

            Returns string

      • STORAGE_AT: ((address: string, position: string) => string)
          • (address, position): string
          • Parameters

            • address: string
            • position: string

            Returns string

    • post: {
          SIMULATE_TRANSACTION: ((revision?: string) => string);
      }
      • SIMULATE_TRANSACTION: ((revision?: string) => string)
          • (revision?): string
          • Parameters

            • Optionalrevision: string

            Returns string

  • blocks: {
        get: {
            BLOCK_DETAIL: ((revision: string | number) => string);
        };
    }

    Blocks related endpoints.

    • get: {
          BLOCK_DETAIL: ((revision: string | number) => string);
      }
      • BLOCK_DETAIL: ((revision: string | number) => string)
          • (revision): string
          • Parameters

            • revision: string | number

            Returns string

  • debug: {
        post: {
            RETRIEVE_STORAGE_RANGE: (() => string);
            TRACE_CONTRACT_CALL: (() => string);
            TRACE_TRANSACTION_CLAUSE: (() => string);
        };
    }

    Debug related endpoints.

    • post: {
          RETRIEVE_STORAGE_RANGE: (() => string);
          TRACE_CONTRACT_CALL: (() => string);
          TRACE_TRANSACTION_CLAUSE: (() => string);
      }
      • RETRIEVE_STORAGE_RANGE: (() => string)
          • (): string
          • Returns string

      • TRACE_CONTRACT_CALL: (() => string)
          • (): string
          • Returns string

      • TRACE_TRANSACTION_CLAUSE: (() => string)
          • (): string
          • Returns string

  • fees: {
        get: {
            FEES_HISTORY: ((blockCount: number, newestBlock: string | number, rewardPercentiles?: number[]) => string);
        };
    }

    Fees related endpoints.

    • get: {
          FEES_HISTORY: ((blockCount: number, newestBlock: string | number, rewardPercentiles?: number[]) => string);
      }
      • FEES_HISTORY: ((blockCount: number, newestBlock: string | number, rewardPercentiles?: number[]) => string)
          • (blockCount, newestBlock, rewardPercentiles?): string
          • Parameters

            • blockCount: number
            • newestBlock: string | number
            • OptionalrewardPercentiles: number[]

            Returns string

  • logs: {
        post: {
            EVENT_LOGS: (() => string);
            TRANSFER_LOGS: (() => string);
        };
    }

    Logs related endpoints.

    • post: {
          EVENT_LOGS: (() => string);
          TRANSFER_LOGS: (() => string);
      }
      • EVENT_LOGS: (() => string)
          • (): string
          • Returns string

      • TRANSFER_LOGS: (() => string)
          • (): string
          • Returns string

  • nodes: {
        get: {
            NODES: (() => string);
        };
    }

    Nodes related endpoints.

    • get: {
          NODES: (() => string);
      }
      • NODES: (() => string)
          • (): string
          • Returns string

  • subscriptions: {
        get: {
            BEAT: ((baseURL: string, position?: string) => string);
            BEAT_LEGACY: ((baseURL: string, position?: string) => string);
            BLOCK: ((baseURL: string, position?: string) => string);
            EVENT: ((baseURL: string, options?: EventOptions) => string);
            NEW_TRANSACTIONS: ((baseURL: string) => string);
            VET_TRANSFER: ((baseURL: string, options?: VetTransferOptions) => string);
        };
    }

    Subscriptions related endpoints.

    • get: {
          BEAT: ((baseURL: string, position?: string) => string);
          BEAT_LEGACY: ((baseURL: string, position?: string) => string);
          BLOCK: ((baseURL: string, position?: string) => string);
          EVENT: ((baseURL: string, options?: EventOptions) => string);
          NEW_TRANSACTIONS: ((baseURL: string) => string);
          VET_TRANSFER: ((baseURL: string, options?: VetTransferOptions) => string);
      }
      • BEAT: ((baseURL: string, position?: string) => string)

        Subscribe to new beats. A beat is a notification that a new block has been added to the blockchain with a bloom filter which can be used to check if the block contains any relevant account.

          • (baseURL, position?): string
          • Parameters

            • baseURL: string

              The URL of the node to request the subscription from.

            • Optionalposition: string

              (optional) The block id to start from, defaults to the best block.

            Returns string

            The websocket subscription URL.

      • BEAT_LEGACY: ((baseURL: string, position?: string) => string)

        Subscribe to new legacy beats. A beat is a notification that a new block has been added to the blockchain with a bloom filter which can be used to check if the block contains any relevant account.

        This subscription has been improved with dynamic size bloom filter with the new BEAT subscription.

          • (baseURL, position?): string
          • Parameters

            • baseURL: string

              The URL of the node to request the subscription from.

            • Optionalposition: string

              (optional) The block id to start from, defaults to the best block.

            Returns string

            The websocket subscription URL.

      • BLOCK: ((baseURL: string, position?: string) => string)

        Subscribe to new blocks.

          • (baseURL, position?): string
          • Parameters

            • baseURL: string

              The URL of the node to request the subscription from.

            • Optionalposition: string

              (optional) The block id to start from, defaults to the best block.

            Returns string

            The websocket subscription URL.

      • EVENT: ((baseURL: string, options?: EventOptions) => string)

        Subscribe to new events.

          • (baseURL, options?): string
          • Parameters

            • baseURL: string

              The URL of the node to request the subscription from.

            • Optionaloptions: EventOptions

              (optional) The options for the subscription.

            Returns string

            The websocket subscription URL.

      • NEW_TRANSACTIONS: ((baseURL: string) => string)

        Subscribe to new transactions.

          • (baseURL): string
          • Parameters

            • baseURL: string

            Returns string

            The websocket subscription URL.

      • VET_TRANSFER: ((baseURL: string, options?: VetTransferOptions) => string)

        Subscribe to new VET transfers.

          • (baseURL, options?): string
          • Parameters

            • baseURL: string

              The URL of the node to request the subscription from.

            • Optionaloptions: VetTransferOptions

              (optional) The options for the subscription.

            Returns string

            The websocket subscription URL.

  • transactions: {
        get: {
            TRANSACTION: ((id: string) => string);
            TRANSACTION_RECEIPT: ((id: string) => string);
        };
        post: {
            TRANSACTION: (() => string);
        };
    }

    Transactions related endpoints.

    • get: {
          TRANSACTION: ((id: string) => string);
          TRANSACTION_RECEIPT: ((id: string) => string);
      }
      • TRANSACTION: ((id: string) => string)
          • (id): string
          • Parameters

            • id: string

            Returns string

      • TRANSACTION_RECEIPT: ((id: string) => string)
          • (id): string
          • Parameters

            • id: string

            Returns string

    • post: {
          TRANSACTION: (() => string);
      }
      • TRANSACTION: (() => string)
          • (): string
          • Returns string