Class RPC

constructor

• new RPC(options, fetchOptions?): RPC

• Parameters

  • options: Options
  • OptionalfetchOptions: RequestOptions = {}

  Returns RPC

api

fetch

fetchOptions

headers

network

balance

• balance(address, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

• WalletBalance returns the balance of the given address at the current head of the chain.

  Parameters

  • address: string
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

  See

  https://lotus.filecoin.io/reference/lotus/wallet/#walletbalance

call

• call<R>(rpcOptions, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: R;
  }>

• Generic method to call any method on the lotus rpc api.

  Type Parameters

  • R

  Parameters

  • rpcOptions: RpcOptions
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: R;
  }>

chainHead

• chainHead(fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: TipSet;
  }>

• The current head of the chain.

  Parameters

  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: TipSet;
  }>

  See

  https://github.com/filecoin-project/filecoin-docs/blob/main/reference/json-rpc/chain.md#chainhead

filecoinAddressToEthAddress

• filecoinAddressToEthAddress(params, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

• Converts any Filecoin address to an EthAddress.

  Parameters

  • params: FilecoinAddressToEthAddressParams
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

  See

  https://github.com/filecoin-project/lotus/blob/471819bf1ef8a4d5c7c0476a38ce9f5e23c59bfc/api/api_full.go#L743-L768

gasEstimate

• gasEstimate(params, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: LotusMessage;
  }>

• GasEstimateMessageGas estimates gas values for unset message gas fields

  Parameters

  • params: GasEstimateParams
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: LotusMessage;
  }>

  See

  https://lotus.filecoin.io/reference/lotus/gas/#gasestimatemessagegas

getIDAddress

• getIDAddress(params, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

• Get the ID address for an address with different safety guarantees

  Parameters

  • params: {
        address: string;
        safety?: Safety;
    }

    • address: string

    • Optionalsafety?: Safety

  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

getTipSetByHeight

• getTipSetByHeight(params, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: TipSet;
  }>

• Get tipset at the specified epoch (height). If there are no blocks at the specified epoch, a tipset at an earlier epoch will be returned.

  Parameters

  • params: ChainGetTipSetByHeightParams
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: TipSet;
  }>

  See

  https://github.com/filecoin-project/filecoin-docs/blob/main/reference/json-rpc/chain.md#chaingettipsetbyheight

lookBackTipSet

• lookBackTipSet(lookback, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: TipSet;
  }>

• Looks back from latest height for a tipset

  Parameters

  • lookback: number

    Chain epoch to look back to
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: TipSet;
  }>

networkName

• networkName(fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: Network;
  }>

• NetworkName returns the name of the network the node is synced to.

  Parameters

  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: Network;
  }>

nonce

• nonce(address, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: number;
  }>

• MpoolGetNonce gets next nonce for the specified sender. Note that this method may not be atomic. Use MpoolPushMessage instead.

  Parameters

  • address: string
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: number;
  }>

  See

  https://lotus.filecoin.io/reference/lotus/mpool/#mpoolgetnonce

pushMessage

• pushMessage(params, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: CID;
  }>

• MpoolPush pushes a signed message to mempool.

  Parameters

  • params: PushMessageParams
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: CID;
  }>

  See

  https://lotus.filecoin.io/reference/lotus/mpool/#mpoolpush

stateAccountKey

• stateAccountKey(params, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

• Public key address of the given ID address.

  Parameters

  • params: StateAccountKeyParams
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

  See

  https://github.com/filecoin-project/lotus/blob/master/documentation/en/api-v0-methods.md#StateAccountKey

stateLookupID

• stateLookupID(params, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

• Retrieves the ID address of the given address

  Parameters

  • params: StateAccountKeyParams
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

  See

  https://github.com/filecoin-project/lotus/blob/master/documentation/en/api-v0-methods.md#statelookupid

stateLookupRobustAddress

• stateLookupRobustAddress(params, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

• Public key address of the given non-account ID address.

  Parameters

  • params: StateAccountKeyParams
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: string;
  }>

  See

  https://github.com/filecoin-project/lotus/blob/master/documentation/en/api-v0-methods.md#StateLookupRobustAddress

version

• version(fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: VersionResponse;
  }>

• Version returns the version of the Filecoin node.

  Parameters

  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: VersionResponse;
  }>

waitMsg

• waitMsg(params, fetchOptions?): Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: CID;
  }>

• StateWaitMsg looks back in the chain for a message. If not found, it blocks until the message arrives on chain, and gets to the indicated confidence depth.

  Timeout is increased to 60s instead of the default 5s.

  Parameters

  • params: waitMsgParams
  • OptionalfetchOptions: RequestOptions = {}

  Returns Promise<{
      error: {
          code: number;
          message: string;
      };
      result: undefined;
  } | {
      error: undefined;
      result: CID;
  }>

  See

  https://lotus.filecoin.io/reference/lotus/state/#statewaitmsg