Class RPC

constructor

• new RPC(options: Options, fetchOptions?: RequestOptions): RPC

  Parameters

  • options: Options
  • OptionalfetchOptions: RequestOptions

  Returns RPC

api

fetch

fetchOptions

headers

network

balance

• balance(
      address: string,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

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

  Parameters

  • address: string
  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

  See

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

call

• call<R>(
      rpcOptions: RpcOptions,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<R, RequestErrors | JsonRpcError>>

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

  Type Parameters

  • R

  Parameters

  • rpcOptions: RpcOptions
  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<R, RequestErrors | JsonRpcError>>

chainHead

• chainHead(
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<TipSet, RequestErrors | JsonRpcError>>

  The current head of the chain.

  Parameters

  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<TipSet, RequestErrors | JsonRpcError>>

  See

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

filecoinAddressToEthAddress

• filecoinAddressToEthAddress(
      params: FilecoinAddressToEthAddressParams,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

  Converts any Filecoin address to an EthAddress.

  Parameters

  • params: FilecoinAddressToEthAddressParams
  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

  See

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

gasEstimate

• gasEstimate(
      params: GasEstimateParams,
      fetchOptions?: RequestOptions,
  ): Promise<
      MaybeResult<
          LotusMessage,
          RequestErrors
          | JsonRpcError
          | RpcError
          | ValidationRpcError,
      >,
  >

  GasEstimateMessageGas estimates gas values for unset message gas fields

  Parameters

  • params: GasEstimateParams
  • OptionalfetchOptions: RequestOptions

  Returns Promise<
      MaybeResult<
          LotusMessage,
          RequestErrors
          | JsonRpcError
          | RpcError
          | ValidationRpcError,
      >,
  >

  See

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

getIDAddress

• getIDAddress(
      params: { address: string; safety?: Safety },
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

  Get the ID address for an address with different safety guarantees

  Parameters

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

  Returns Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

getTipSetByHeight

• getTipSetByHeight(
      params: ChainGetTipSetByHeightParams,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<TipSet, RequestErrors | JsonRpcError>>

  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<MaybeResult<TipSet, RequestErrors | JsonRpcError>>

  See

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

lookBackTipSet

• lookBackTipSet(
      lookback: number,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<TipSet, RequestErrors | JsonRpcError | RpcError>>

  Looks back from latest height for a tipset

  Parameters

  • lookback: number

    Chain epoch to look back to
  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<TipSet, RequestErrors | JsonRpcError | RpcError>>

networkName

• networkName(
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<Network, RequestErrors | JsonRpcError>>

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

  Parameters

  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<Network, RequestErrors | JsonRpcError>>

nonce

• nonce(
      address: string,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<number, RequestErrors | JsonRpcError | RpcError>>

  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<MaybeResult<number, RequestErrors | JsonRpcError | RpcError>>

  See

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

pushMessage

• pushMessage(
      params: PushMessageParams,
      fetchOptions?: RequestOptions,
  ): Promise<
      MaybeResult<
          CID,
          RequestErrors
          | JsonRpcError
          | RpcError
          | ValidationRpcError,
      >,
  >

  MpoolPush pushes a signed message to mempool.

  Parameters

  • params: PushMessageParams
  • OptionalfetchOptions: RequestOptions

  Returns Promise<
      MaybeResult<
          CID,
          RequestErrors
          | JsonRpcError
          | RpcError
          | ValidationRpcError,
      >,
  >

  See

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

stateAccountKey

• stateAccountKey(
      params: StateAccountKeyParams,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

  Public key address of the given ID address.

  Parameters

  • params: StateAccountKeyParams
  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

  See

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

stateLookupID

• stateLookupID(
      params: StateAccountKeyParams,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<string, RequestErrors | JsonRpcError>>

  Retrieves the ID address of the given address for a tipset. If you dont have a specific tipset in mind, better to use getIDAddress.

  Parameters

  • params: StateAccountKeyParams
  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<string, RequestErrors | JsonRpcError>>

  See

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

stateLookupRobustAddress

• stateLookupRobustAddress(
      params: StateAccountKeyParams,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

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

  Parameters

  • params: StateAccountKeyParams
  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<string, RequestErrors | JsonRpcError | RpcError>>

  See

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

version

• version(
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<VersionResponse, RequestErrors | JsonRpcError>>

  Version returns the version of the Filecoin node.

  Parameters

  • OptionalfetchOptions: RequestOptions

  Returns Promise<MaybeResult<VersionResponse, RequestErrors | JsonRpcError>>

waitMsg

• waitMsg(
      params: waitMsgParams,
      fetchOptions?: RequestOptions,
  ): Promise<MaybeResult<CID, RequestErrors | JsonRpcError>>

  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<MaybeResult<CID, RequestErrors | JsonRpcError>>

  See

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