Class PublicAPI

constructor

• new PublicAPI(url, options?): PublicAPI

• Parameters

  • url: string
  • options: Partial<ClientOptions> = {}

  Returns PublicAPI

connector

lastStatus

options

url

deferredCallQuote

• deferredCallQuote(quoteRequests): Promise<DeferredCallsQuoteResponse[]>

• Parameters

  • quoteRequests: DeferredCallsQuoteRequest[]

  Returns Promise<DeferredCallsQuoteResponse[]>

deferredCallsBySlot

• deferredCallsBySlot(slots): Promise<DeferredCallsSlotResponse[]>

• Parameters

  • slots: Slot[]

  Returns Promise<DeferredCallsSlotResponse[]>

deferredCallsInfo

• deferredCallsInfo(deferredCallsIds): Promise<DeferredCallResponse[]>

• Parameters

  • deferredCallsIds: string[]

  Returns Promise<DeferredCallResponse[]>

executeMultipleGetAddressesBytecode

• executeMultipleGetAddressesBytecode(addressFilters): Promise<Uint8Array[]>

• Parameters

  • addressFilters: AddressFilter[]

  Returns Promise<Uint8Array[]>

executeMultipleReadOnlyBytecode

• executeMultipleReadOnlyBytecode(executeReadonlyParams): Promise<ExecuteSCReadOnlyResult[]>

• Parameters

  • executeReadonlyParams: ExecuteSCReadOnlyParams[]

  Returns Promise<ExecuteSCReadOnlyResult[]>

executeMultipleReadOnlyCall

• executeMultipleReadOnlyCall(readOnlyCalls): Promise<ReadOnlyCallResult[]>

• Parameters

  • readOnlyCalls: ReadOnlyParams[]

  Returns Promise<ReadOnlyCallResult[]>

executeReadOnlyBytecode

• executeReadOnlyBytecode(params): Promise<ExecuteSCReadOnlyResult>

• Parameters

  • params: ExecuteSCReadOnlyParams

  Returns Promise<ExecuteSCReadOnlyResult>

executeReadOnlyCall

• executeReadOnlyCall(params): Promise<ReadOnlyCallResult>

• Parameters

  • params: ReadOnlyParams

  Returns Promise<ReadOnlyCallResult>

fetchPeriod

• fetchPeriod(): Promise<number>

• Returns Promise<number>

getAddressInfo

• getAddressInfo(address): Promise<AddressInfo>

• Parameters

  • address: string

  Returns Promise<AddressInfo>

getAddressesBytecode

• getAddressesBytecode(addressFilter): Promise<Uint8Array>

• Parameters

  • addressFilter: AddressFilter

  Returns Promise<Uint8Array>

getAddressesDatastoreKeys

• getAddressesDatastoreKeys(params): Promise<AddressDatastoreKeys[]>

• Parameters

  • params: DatastoreKeysRequest[]

  Returns Promise<AddressDatastoreKeys[]>

getBalance

• getBalance(address, final?): Promise<bigint>

• Parameters

  • address: string
  • final: boolean = true

  Returns Promise<bigint>

getBlock

• getBlock(blockId): Promise<BlockInfo>

• Parameters

  • blockId: string

  Returns Promise<BlockInfo>

getBlockcliqueBlock

• getBlockcliqueBlock(slot): Promise<Block>

• Parameters

  • slot: Slot

  Returns Promise<Block>

getChainId

• getChainId(): Promise<bigint>

• Returns Promise<bigint>

getCliques

• getCliques(): Promise<Clique[]>

• Returns Promise<Clique[]>

getCurrentSlot

• getCurrentSlot(): Promise<Slot>

• Returns Promise<Slot>

getDataStoreKeys

• getDataStoreKeys(contract, filter?, final?): Promise<Uint8Array[]>

• Retrieves the datastore keys of a contract from get_addresses.

  Parameters

  • contract: string

    The contract address
  • filter: Uint8Array = ...

    Only keys starting with these bytes are returned
  • final: boolean = true

    Whether to read the final or the candidate keys

  Returns Promise<Uint8Array[]>

  The keys starting with filter

  Deprecated

  get_addresses returns at most max_datastore_keys_query keys per address (500 by default), with no way to page, and the filter is applied after that cap: keys can be missing without error. Use JsonRpcPublicProvider.getStorageKeys or getMultipleAddressesDatastoreKeys, which page through get_addresses_datastore_keys with the prefix applied by the node.

getDatastoreEntries

• getDatastoreEntries(inputs, final?): Promise<(null | Uint8Array)[]>

• Parameters

  • inputs: DatastoreEntry[]
  • final: boolean = true

  Returns Promise<(null | Uint8Array)[]>

getDatastoreEntry

• getDatastoreEntry(key, address, final?): Promise<null | Uint8Array>

• Parameters

  • key: string | Uint8Array
  • address: string
  • final: boolean = true

  Returns Promise<null | Uint8Array>

getDatastoreKeysPageSize

• getDatastoreKeysPageSize(): Promise<number>

• Returns the number of keys to request per datastore keys query.

  Returns Promise<number>

  Remarks

  This is MAX_DATASTORE_KEYS_QUERY, lowered to the node's max_datastore_keys_query when the node reports a smaller limit: asking for more keys than this limit makes the query fail.

getEndorsement

• getEndorsement(endorsementId): Promise<EndorsementInfo>

• Parameters

  • endorsementId: string

  Returns Promise<EndorsementInfo>

getEvents

• getEvents(filter): Promise<SCOutputEvent[]>

• Parameters

  • filter: EventFilter

  Returns Promise<SCOutputEvent[]>

getGraphInterval

• getGraphInterval(start?, end?): Promise<GraphInterval[]>

• Parameters

  • Optional start: number
  • Optional end: number

  Returns Promise<GraphInterval[]>

getMinimalFee

• getMinimalFee(): Promise<bigint>

• Returns Promise<bigint>

getMultipleAddressInfo

• getMultipleAddressInfo(addresses): Promise<AddressInfo[]>

• Parameters

  • addresses: string[]

  Returns Promise<AddressInfo[]>

getMultipleBlocks

• getMultipleBlocks(blockIds): Promise<BlockInfo[]>

• Parameters

  • blockIds: string[]

  Returns Promise<BlockInfo[]>

getMultipleEndorsements

• getMultipleEndorsements(endorsementIds): Promise<EndorsementInfo[]>

• Parameters

  • endorsementIds: string[]

  Returns Promise<EndorsementInfo[]>

getMultipleSlotTransfers

• getMultipleSlotTransfers(slots): Promise<TransferReceipt[][]>

• Parameters

  • slots: Slot[]

  Returns Promise<TransferReceipt[][]>

getOperation

• getOperation(operationId): Promise<undefined | OperationInfo>

• Parameters

  • operationId: string

  Returns Promise<undefined | OperationInfo>

getOperationStatus

• getOperationStatus(operationId): Promise<OperationStatus>

• Returns the execution status of an operation.

  Parameters

  • operationId: string

  Returns Promise<OperationStatus>

  Remarks

  in_pool is not used to compute the status: since MAIN.5.1, nodes keep speculatively executed operations in their pool until their execution is final, so an operation can be both in the pool and executed.

getOperations

• getOperations(operationIds): Promise<OperationInfo[]>

• Retrieves operations by id.

  Parameters

  • operationIds: string[]

  Returns Promise<OperationInfo[]>

  Remarks

  The node rejects requests with more than max_arguments ids (128 by default), so the ids are sent in batches of DEFAULT_MAX_ARGUMENT_ARRAY_SIZE.

getSlotTransfers

• getSlotTransfers(slot): Promise<TransferReceipt[]>

• Parameters

  • slot: Slot

  Returns Promise<TransferReceipt[]>

getStakers

• getStakers(pagination): Promise<Staker[]>

• Parameters

  • pagination: Pagination

  Returns Promise<Staker[]>

sendMultipleOperations

• sendMultipleOperations(data): Promise<string[]>

• Parameters

  • data: OperationInput[]

  Returns Promise<string[]>

sendOperation

• sendOperation(data): Promise<string>

• Parameters

  • data: SendOperationInput

  Returns Promise<string>

sendOperations

• sendOperations(data): Promise<string[]>

• Parameters

  • data: SendOperationInput[]

  Returns Promise<string[]>

status

• status(): Promise<NodeStatus>

• Returns Promise<NodeStatus>

Static fromProvider

• fromProvider(provider): Promise<PublicAPI>

• Parameters

  • provider: PublicProvider | Provider

  Returns Promise<PublicAPI>