Interface Session

An object which allows the user to interact with an account by both querying and submitting signed transactions.

interface Session {
    account: AuthenticatedAccount;
    blockchainRid: Buffer;
    call: ((...operations) => Web3CustomPromiEvent<TransactionWithReceipt, {
        built: Buffer;
        sent: Buffer;
    }>);
    callWithoutNop: ((...operations) => Web3CustomPromiEvent<TransactionWithReceipt, {
        built: Buffer;
        sent: Buffer;
    }>);
    client: IClient;
    getAccountAuthDescriptorsFiltered: ((accountAuthDescriptorFilter?, limit?, cursor?) => Promise<PaginatedEntity<AnyAuthDescriptor>>);
    getAccountById: ((accountId) => Promise<null | Account>);
    getAccountCreationTransfersFiltered: ((accountCreationTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<AccountCreationTransfer>>);
    getAccountLinksFiltered: ((accountLinkFilter?, limit?, cursor?) => Promise<PaginatedEntity<{
        account: Account;
        secondary: Account;
    }>>);
    getAccountsByAuthDescriptorId: ((id, limit?, cursor?) => Promise<PaginatedEntity<Account>>);
    getAccountsBySigner: ((signer, limit?, cursor?) => Promise<PaginatedEntity<Account>>);
    getAccountsByType: ((type, limit?, cursor?) => Promise<PaginatedEntity<Account>>);
    getAccountsFiltered: ((accountFilter?, limit?, cursor?) => Promise<PaginatedEntity<Account>>);
    getAllAssets: ((limit?, cursor?) => Promise<PaginatedEntity<Asset>>);
    getApiVersion: (() => Promise<number>);
    getAppliedTransfersFiltered: ((appliedTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<AppliedTransfer>>);
    getAssetById: ((assetId) => Promise<null | Asset>);
    getAssetOriginFiltered: ((assetOriginFilter?, limit?, cursor?) => Promise<PaginatedEntity<AssetOrigin>>);
    getAssetsByName: ((name, limit?, cursor?) => Promise<PaginatedEntity<Asset>>);
    getAssetsBySymbol: ((symbol, limit?, cursor?) => Promise<PaginatedEntity<Asset>>);
    getAssetsByType: ((type, limit?, cursor?) => Promise<PaginatedEntity<Asset>>);
    getAssetsFiltered: ((assetFilter?, limit?, cursor?) => Promise<PaginatedEntity<Asset>>);
    getAuthDescriptorSignersFiltered: ((authDescriptorSignerFilter?, limit?, cursor?) => Promise<PaginatedEntity<AuthDescriptorSigner>>);
    getAuthDescriptorValidator: ((useCache) => AuthDescriptorValidator);
    getBalancesFiltered: ((balanceFilter?, limit?, cursor?) => Promise<PaginatedEntity<Balance>>);
    getBlockHeight: (() => Promise<number>);
    getCanceledTransfersFiltered: ((canceledTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<Transfer>>);
    getConfig: (() => Promise<Config>);
    getCrosschainTransferHistoryEntriesFiltered: ((crosschainTransferHistoryEntryFilter?, limit?, cursor?) => Promise<PaginatedEntity<CrosschainTransferHistoryEntry>>);
    getEnabledRegistrationStrategies: (() => Promise<string[]>);
    getMainAuthDescriptorsFiltered: ((mainAccountAuthDescriptorFilter?, limit?, cursor?) => Promise<PaginatedEntity<AnyAuthDescriptor>>);
    getPendingTransfersFiltered: ((pendingTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<PendingTransfer>>);
    getRecalledTransfersFiltered: ((recalledTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<Transfer>>);
    getRevertedTransfersFiltered: ((revertedTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<Transfer>>);
    getRlStatesFiltered: ((rlStateFilter?, limit?, cursor?) => Promise<PaginatedEntity<RlState>>);
    getSubscriptionsFiltered: ((subscriptionFilter?, limit?, cursor?) => Promise<PaginatedEntity<Subscription>>);
    getTransferDetails: ((txRid, opIndex) => Promise<TransferDetail[]>);
    getTransferDetailsByAsset: ((txRid, opIndex, assetId) => Promise<TransferDetail[]>);
    getTransferHistoryEntriesFiltered: ((transferHistoryEntryFilter?, limit?, cursor?) => Promise<PaginatedEntity<TransferHistoryEntry>>);
    getUnappliedTransfersFiltered: ((unappliedTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<Transfer>>);
    getVersion: (() => Promise<string>);
    sign: ((tx) => Promise<Buffer>);
    signAndSend: ((tx) => Promise<TransactionReceipt>);
    transactionBuilder: (() => TransactionBuilder);
}

Hierarchy (view full)

Properties

account blockchainRid call callWithoutNop client getAccountAuthDescriptorsFiltered getAccountById getAccountCreationTransfersFiltered getAccountLinksFiltered getAccountsByAuthDescriptorId getAccountsBySigner getAccountsByType getAccountsFiltered getAllAssets getApiVersion getAppliedTransfersFiltered getAssetById getAssetOriginFiltered getAssetsByName getAssetsBySymbol getAssetsByType getAssetsFiltered getAuthDescriptorSignersFiltered getAuthDescriptorValidator getBalancesFiltered getBlockHeight getCanceledTransfersFiltered getConfig getCrosschainTransferHistoryEntriesFiltered getEnabledRegistrationStrategies getMainAuthDescriptorsFiltered getPendingTransfersFiltered getRecalledTransfersFiltered getRevertedTransfersFiltered getRlStatesFiltered getSubscriptionsFiltered getTransferDetails getTransferDetailsByAsset getTransferHistoryEntriesFiltered getUnappliedTransfersFiltered getVersion sign signAndSend transactionBuilder

Properties

account

account: AuthenticatedAccount

blockchainRid

blockchainRid: Buffer

call

call: ((...operations) => Web3CustomPromiEvent<TransactionWithReceipt, {
    built: Buffer;
    sent: Buffer;
}>)

Builds and sends a transaction containing the specified operations. This method will also make sure to perform the appropriate authentication and signing of each operation, as well as inserting a nop operation at the end to make each transaction unique. If you don't want the tx to include a nop use callWithoutNop instead.

Type declaration

callWithoutNop

callWithoutNop: ((...operations) => Web3CustomPromiEvent<TransactionWithReceipt, {
    built: Buffer;
    sent: Buffer;
}>)

Same as call but it does not include a nop at the end. Meaning that subsequent calls to this function with the same arguments is likely to be rejected.

Type declaration

client

client: IClient

getAccountAuthDescriptorsFiltered

getAccountAuthDescriptorsFiltered: ((accountAuthDescriptorFilter?, limit?, cursor?) => Promise<PaginatedEntity<AnyAuthDescriptor>>)

Fetches all AccountAuthDescriptors with satisfy the accountAuthDescriptor filter, paginated

Type declaration

getAccountById

getAccountById: ((accountId) => Promise<null | Account>)

Fetches the account with the specified id

Type declaration

    • (accountId): Promise<null | Account>

    • Parameters

      • accountId: BufferId

        the id of the account to fetch

      Returns Promise<null | Account>

Returns

the account with the specified id, or null if no account with that id exists

getAccountCreationTransfersFiltered

getAccountCreationTransfersFiltered: ((accountCreationTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<AccountCreationTransfer>>)

Fetches all AccountCreationTransfers with satisfy the accountCreationTransferFilter filter, paginated

Type declaration

getAccountLinksFiltered

getAccountLinksFiltered: ((accountLinkFilter?, limit?, cursor?) => Promise<PaginatedEntity<{
    account: Account;
    secondary: Account;
}>>)

Fetches all AccountLinks with satisfy the accountLinkFilter filter, paginated

Type declaration

getAccountsByAuthDescriptorId

getAccountsByAuthDescriptorId: ((id, limit?, cursor?) => Promise<PaginatedEntity<Account>>)

Fetches all accounts with which the auth descriptor with the specified id is associated

Type declaration

getAccountsBySigner

getAccountsBySigner: ((signer, limit?, cursor?) => Promise<PaginatedEntity<Account>>)

Fetches all accounts with which the provided signer has at least one associated auth descriptor

Type declaration

getAccountsByType

getAccountsByType: ((type, limit?, cursor?) => Promise<PaginatedEntity<Account>>)

Returns all accounts of the specified type that is registered on the blockchain as a paginated entity

Type declaration

getAccountsFiltered

getAccountsFiltered: ((accountFilter?, limit?, cursor?) => Promise<PaginatedEntity<Account>>)

Fetches all accounts with satisfy the account filter, paginated

Type declaration

getAllAssets

getAllAssets: ((limit?, cursor?) => Promise<PaginatedEntity<Asset>>)

Retrieves all assets that are registered on a blockchain as a paginated entity

Type declaration

getApiVersion

getApiVersion: (() => Promise<number>)

Returns the API version of ft library installed on the blockchain. It will be an integer.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

getAppliedTransfersFiltered

getAppliedTransfersFiltered: ((appliedTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<AppliedTransfer>>)

Retrieves applied transfers based on the selected filter of TransferFilter, paginated

Type declaration

Returns

paginated results of applied transfers based on the filter selection

Available since ApiVersion 1

getAssetById

getAssetById: ((assetId) => Promise<null | Asset>)

Retrieves asset information using its id

Type declaration

    • (assetId): Promise<null | Asset>

    • Parameters

      • assetId: BufferId

        the id of the asset to fetch

      Returns Promise<null | Asset>

Returns

The asset details, or null if no asset with the specified id was found

getAssetOriginFiltered

getAssetOriginFiltered: ((assetOriginFilter?, limit?, cursor?) => Promise<PaginatedEntity<AssetOrigin>>)

Retrieves assets origin based on the selected filter of AssetOriginFilter, paginated

Type declaration

Returns

paginated results of assets origin based on the filter selection

Available since ApiVersion 1

getAssetsByName

getAssetsByName: ((name, limit?, cursor?) => Promise<PaginatedEntity<Asset>>)

Retrieves asset information using its name. As there can be multiple assets with the same name, the information is returned as a paginated entity.

Type declaration

getAssetsBySymbol

getAssetsBySymbol: ((symbol, limit?, cursor?) => Promise<PaginatedEntity<Asset>>)

Retrieves asset information using its symbol. As there can be multiple assets with the same symbol, the information is returned as a paginated entity.

Type declaration

getAssetsByType

getAssetsByType: ((type, limit?, cursor?) => Promise<PaginatedEntity<Asset>>)

Retrieves all assets of a specific type, e.g., "ft4", as a paginated entity

Type declaration

getAssetsFiltered

getAssetsFiltered: ((assetFilter?, limit?, cursor?) => Promise<PaginatedEntity<Asset>>)

Retrieves all assets based on the filtering options provided in AssetFilter and that are registered on a blockchain as a paginated entity

Type declaration

    • (assetFilter?, limit?, cursor?): Promise<PaginatedEntity<Asset>>

    • Parameters

      • Optional assetFilter: AssetFilter

        The asset filter (list of ids, name, symbol and type) that can be applied to the query results

      • Optional limit: number

        maximum page size

      • Optional cursor: OptionalPageCursor

        where the page should start

        Available since ApiVersion 1

      Returns Promise<PaginatedEntity<Asset>>

getAuthDescriptorSignersFiltered

getAuthDescriptorSignersFiltered: ((authDescriptorSignerFilter?, limit?, cursor?) => Promise<PaginatedEntity<AuthDescriptorSigner>>)

Fetches all AuthDescriptorSigners with satisfy the authDescriptorSigner filter, paginated

Type declaration

getAuthDescriptorValidator

getAuthDescriptorValidator: ((useCache) => AuthDescriptorValidator)

Gets a validator instance that can be used to validate if an auth descriptor is valid or not

Type declaration

getBalancesFiltered

getBalancesFiltered: ((balanceFilter?, limit?, cursor?) => Promise<PaginatedEntity<Balance>>)

Retrieves all balances based on the filtering options provided in BalanceFilter and that are registered on a blockchain as a paginated entity

Type declaration

    • (balanceFilter?, limit?, cursor?): Promise<PaginatedEntity<Balance>>

    • Parameters

      • Optional balanceFilter: BalanceFilter

        The balance filter (list of account_ids and list of asset_ids) that can be applied to the query results

      • Optional limit: number

        maximum page size

      • Optional cursor: OptionalPageCursor

        where the page should start

        Available since ApiVersion 1

      Returns Promise<PaginatedEntity<Balance>>

getBlockHeight

getBlockHeight: (() => Promise<number>)

Returns the current block height of the underlying chain

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

getCanceledTransfersFiltered

getCanceledTransfersFiltered: ((canceledTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<Transfer>>)

Retrieves canceled transfers based on the selected filter of in TransferFilter, paginated

Type declaration

    • (canceledTransferFilter?, limit?, cursor?): Promise<PaginatedEntity<Transfer>>

    • Parameters

      • Optional canceledTransferFilter: TransferFilter

        The canceled transfer filter (array of initTxRids and initOpIndex) that can be applied to the query results

      • Optional limit: number

        maximum page size

      • Optional cursor: OptionalPageCursor

        where the page should start

        Available since ApiVersion 1

      Returns Promise<PaginatedEntity<Transfer>>

Returns

paginated results of canceled transfers based on the filter selection

Available since ApiVersion 1

getConfig

getConfig: (() => Promise<Config>)

Returns the ft config that is currently in effect

Type declaration

getCrosschainTransferHistoryEntriesFiltered

getCrosschainTransferHistoryEntriesFiltered: ((crosschainTransferHistoryEntryFilter?, limit?, cursor?) => Promise<PaginatedEntity<CrosschainTransferHistoryEntry>>)

Retrieves all crosschain transfer history entries based on the filtering options provided in CrosschainTransferHistoryEntryFilter as a paginated entity

Type declaration

getEnabledRegistrationStrategies

getEnabledRegistrationStrategies: (() => Promise<string[]>)

Returns a list containing the name of all of the enabled strategies

Type declaration

    • (): Promise<string[]>

    • Returns Promise<string[]>

getMainAuthDescriptorsFiltered

getMainAuthDescriptorsFiltered: ((mainAccountAuthDescriptorFilter?, limit?, cursor?) => Promise<PaginatedEntity<AnyAuthDescriptor>>)

Fetches all MainAuthDescriptors with satisfy the mainAccountAuthDescriptor filter, paginated

Type declaration

getPendingTransfersFiltered

getPendingTransfersFiltered: ((pendingTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<PendingTransfer>>)

Retrieves pending transfers based on the selected filter of PendingTransferFilter, paginated

Type declaration

Returns

paginated results of pending transfers based on the filter selection

Available since ApiVersion 1

getRecalledTransfersFiltered

getRecalledTransfersFiltered: ((recalledTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<Transfer>>)

Retrieves recalled transfers based on the selected filter of TransferFilter, paginated

Type declaration

    • (recalledTransferFilter?, limit?, cursor?): Promise<PaginatedEntity<Transfer>>

    • Parameters

      • Optional recalledTransferFilter: TransferFilter

        The recalled transfer filter (array of initTxRids and initOpIndex) that can be applied to the query results

      • Optional limit: number

        maximum page size

      • Optional cursor: OptionalPageCursor

        where the page should start

        Available since ApiVersion 1

      Returns Promise<PaginatedEntity<Transfer>>

Returns

paginated results of recalled transfers based on the filter selection

Available since ApiVersion 1

getRevertedTransfersFiltered

getRevertedTransfersFiltered: ((revertedTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<Transfer>>)

Retrieves reverted transfers based on the selected filter of TransferFilter, paginated

Type declaration

Returns

paginated results of reverted transfers based on the filter selection

Available since ApiVersion 1

getRlStatesFiltered

getRlStatesFiltered: ((rlStateFilter?, limit?, cursor?) => Promise<PaginatedEntity<RlState>>)

Fetches all Rate limit states with satisfy the rlState filter, paginated

Type declaration

getSubscriptionsFiltered

getSubscriptionsFiltered: ((subscriptionFilter?, limit?, cursor?) => Promise<PaginatedEntity<Subscription>>)

Fetches all Subscriptions with satisfy the subscriptionFilter filter, paginated

Type declaration

getTransferDetails

getTransferDetails: ((txRid, opIndex) => Promise<TransferDetail[]>)

Retrieves the details of a transfer

Type declaration

    • (txRid, opIndex): Promise<TransferDetail[]>

    • Parameters

      • txRid: BufferId

        the id of the transaction in which the transfer was made

      • opIndex: number

        the index of the transfer operation within the transaction

      Returns Promise<TransferDetail[]>

Returns

Details about the transfer

getTransferDetailsByAsset

getTransferDetailsByAsset: ((txRid, opIndex, assetId) => Promise<TransferDetail[]>)

Retrieves details of a transfer but only the details that was made with a specific asset

Type declaration

    • (txRid, opIndex, assetId): Promise<TransferDetail[]>

    • Parameters

      • txRid: BufferId

        the id of the transaction in which the transfer was made

      • opIndex: number

        the index of the transfer operation within the transaction

      • assetId: BufferId

        the asset id for which to return details

      Returns Promise<TransferDetail[]>

Returns

The transfer details

getTransferHistoryEntriesFiltered

getTransferHistoryEntriesFiltered: ((transferHistoryEntryFilter?, limit?, cursor?) => Promise<PaginatedEntity<TransferHistoryEntry>>)

Retrieves all transfer history entries based on the filtering options provided in TransferHistoryEntryFilter as a paginated entity

Type declaration

getUnappliedTransfersFiltered

getUnappliedTransfersFiltered: ((unappliedTransferFilter?, limit?, cursor?) => Promise<PaginatedEntity<Transfer>>)

Retrieves unapplied transfers based on the selected filter of TransferFilter, paginated

Type declaration

    • (unappliedTransferFilter?, limit?, cursor?): Promise<PaginatedEntity<Transfer>>

    • Parameters

      • Optional unappliedTransferFilter: TransferFilter

        The unapplied transfer filter (array of initTxRids and initOpIndex) that can be applied to the query results

      • Optional limit: number

        maximum page size

      • Optional cursor: OptionalPageCursor

        where the page should start

        Available since ApiVersion 1

      Returns Promise<PaginatedEntity<Transfer>>

Returns

paginated results of unapplied transfers based on the filter selection

Available since ApiVersion 1

getVersion

getVersion: (() => Promise<string>)

Returns the version of ft library installed on the blockchain with the format ..

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

sign

sign: ((tx) => Promise<Buffer>)

Signs a transaction using an available key

Type declaration

    • (tx): Promise<Buffer>

    • Parameters

      • tx: Buffer | RawGtx | GTX

        the transaction to sign

      Returns Promise<Buffer>

Returns

the original transaction with the appropriate signatures added

signAndSend

signAndSend: ((tx) => Promise<TransactionReceipt>)

Same as sign but it also submits the resulting transaction to the blockchain.

Type declaration

    • (tx): Promise<TransactionReceipt>

    • Parameters

      • tx: Buffer | RawGtx | GTX

        the transaction to sign and send

      Returns Promise<TransactionReceipt>

Returns

a receipt with the result of submitting the transaction

transactionBuilder

transactionBuilder: (() => TransactionBuilder)

Returns a TransactionBuilder instance configured to use the same keys as enclosed in this Session instance.

Type declaration

Settings

Member Visibility

Theme

On This Page

accountblockchainRidcallcallWithoutNopclientgetAccountAuthDescriptorsFilteredgetAccountByIdgetAccountCreationTransfersFilteredgetAccountLinksFilteredgetAccountsByAuthDescriptorIdgetAccountsBySignergetAccountsByTypegetAccountsFilteredgetAllAssetsgetApiVersiongetAppliedTransfersFilteredgetAssetByIdgetAssetOriginFilteredgetAssetsByNamegetAssetsBySymbolgetAssetsByTypegetAssetsFilteredgetAuthDescriptorSignersFilteredgetAuthDescriptorValidatorgetBalancesFilteredgetBlockHeightgetCanceledTransfersFilteredgetConfiggetCrosschainTransferHistoryEntriesFilteredgetEnabledRegistrationStrategiesgetMainAuthDescriptorsFilteredgetPendingTransfersFilteredgetRecalledTransfersFilteredgetRevertedTransfersFilteredgetRlStatesFilteredgetSubscriptionsFilteredgetTransferDetailsgetTransferDetailsByAssetgetTransferHistoryEntriesFilteredgetUnappliedTransfersFilteredgetVersionsignsignAndSendtransactionBuilder