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: Operation[],
    ) => Web3PromiEvent<
        TransactionWithReceipt,
        { built: SignedTransaction; sent: Buffer },
    >;
    callWithoutNop: (
        ...operations: Operation[],
    ) => Web3PromiEvent<
        TransactionWithReceipt,
        { built: SignedTransaction; sent: Buffer },
    >;
    client: IClient;
    getAccountAuthDescriptorsFiltered: (
        accountAuthDescriptorFilter?: AccountAuthDescriptorFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<AnyAuthDescriptor>>;
    getAccountById: (accountId: BufferId) => Promise<Account | null>;
    getAccountCreationTransfersFiltered: (
        accountCreationTransferFilter?: AccountCreationTransferFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<AccountCreationTransfer>>;
    getAccountLinksFiltered: (
        accountLinkFilter?: AccountLinkFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<{ account: Account; secondary: Account }>>;
    getAccountsByAuthDescriptorId: (
        id: BufferId,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Account>>;
    getAccountsBySigner: (
        signer: BufferId,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Account>>;
    getAccountsByType: (
        type: string,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Account>>;
    getAccountsFiltered: (
        accountFilter?: AccountFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Account>>;
    getAllAssets: (
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Asset>>;
    getApiVersion: () => Promise<number>;
    getAppliedTransfersFiltered: (
        appliedTransferFilter?: TransferFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<AppliedTransfer>>;
    getAssetById: (assetId: BufferId) => Promise<Asset | null>;
    getAssetOriginFiltered: (
        assetOriginFilter?: AssetOriginFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<AssetOrigin>>;
    getAssetsByName: (
        name: string,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Asset>>;
    getAssetsBySymbol: (
        symbol: string,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Asset>>;
    getAssetsByType: (
        type: string,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Asset>>;
    getAssetsFiltered: (
        assetFilter?: AssetFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Asset>>;
    getAuthDescriptorSignersFiltered: (
        authDescriptorSignerFilter?: AuthDescriptorSignerFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<AuthDescriptorSigner>>;
    getAuthDescriptorValidator: (useCache: boolean) => AuthDescriptorValidator;
    getBalancesFiltered: (
        balanceFilter?: BalanceFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Balance>>;
    getBlockHeight: () => Promise<number>;
    getCanceledTransfersFiltered: (
        canceledTransferFilter?: TransferFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Transfer>>;
    getConfig: () => Promise<Config>;
    getCrosschainTransferHistoryEntriesFiltered: (
        crosschainTransferHistoryEntryFilter?: CrosschainTransferHistoryEntryFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<CrosschainTransferHistoryEntry>>;
    getEnabledRegistrationStrategies: () => Promise<string[]>;
    getMainAuthDescriptorsFiltered: (
        mainAccountAuthDescriptorFilter?: MainAccountAuthDescriptorFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<AnyAuthDescriptor>>;
    getPendingTransfersFiltered: (
        pendingTransferFilter?: PendingTransferFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<PendingTransfer>>;
    getRecalledTransfersFiltered: (
        recalledTransferFilter?: TransferFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Transfer>>;
    getRevertedTransfersFiltered: (
        revertedTransferFilter?: TransferFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Transfer>>;
    getRlStatesFiltered: (
        rlStateFilter?: RlStateFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<RlState>>;
    getSubscriptionsFiltered: (
        subscriptionFilter?: SubscriptionFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Subscription>>;
    getTransferDetails: (
        txRid: BufferId,
        opIndex: number,
    ) => Promise<TransferDetail[]>;
    getTransferDetailsByAsset: (
        txRid: BufferId,
        opIndex: number,
        assetId: BufferId,
    ) => Promise<TransferDetail[]>;
    getTransferHistoryEntriesFiltered: (
        transferHistoryEntryFilter?: TransferHistoryEntryFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<TransferHistoryEntry>>;
    getUnappliedTransfersFiltered: (
        unappliedTransferFilter?: TransferFilter,
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<Transfer>>;
    getVersion: () => Promise<string>;
    sign: (tx: RawGtx | GTX | SignedTransaction) => Promise<SignedTransaction>;
    signAndSend: (
        tx: RawGtx | GTX | SignedTransaction,
    ) => Promise<TransactionReceipt>;
    transactionBuilder: () => TransactionBuilder;
}

Hierarchy (View Summary)

• Connection
  • Session

Properties

account

account: AuthenticatedAccount

blockchainRid

blockchainRid: Buffer

Inherited from Connection.blockchainRid

call

call: (
    ...operations: Operation[],
) => Web3PromiEvent<
    TransactionWithReceipt,
    { built: SignedTransaction; 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

• (
      ...operations: Operation[],
  ): Web3PromiEvent<
      TransactionWithReceipt,
      { built: SignedTransaction; sent: Buffer },
  >

  • Parameters

    • ...operations: Operation[]

      the operations to include in the transaction

    Returns Web3PromiEvent<
        TransactionWithReceipt,
        { built: SignedTransaction; sent: Buffer },
    >

callWithoutNop

callWithoutNop: (
    ...operations: Operation[],
) => Web3PromiEvent<
    TransactionWithReceipt,
    { built: SignedTransaction; 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

• (
      ...operations: Operation[],
  ): Web3PromiEvent<
      TransactionWithReceipt,
      { built: SignedTransaction; sent: Buffer },
  >

  • Parameters

    • ...operations: Operation[]

      the operations to include in the transaction

    Returns Web3PromiEvent<
        TransactionWithReceipt,
        { built: SignedTransaction; sent: Buffer },
    >

client

client: IClient

Inherited from Connection.client

getAccountAuthDescriptorsFiltered

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

Fetches all AccountAuthDescriptors with satisfy the accountAuthDescriptor filter, paginated

Type Declaration

• (
      accountAuthDescriptorFilter?: AccountAuthDescriptorFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<AnyAuthDescriptor>>

  • Parameters

    • OptionalaccountAuthDescriptorFilter: AccountAuthDescriptorFilter

      the accountAuthDescriptor filter

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<AnyAuthDescriptor>>

Inherited from Connection.getAccountAuthDescriptorsFiltered

getAccountById

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

Fetches the account with the specified id

Type Declaration

• (accountId: BufferId): Promise<Account | null>

  • Parameters

    • accountId: BufferId

      the id of the account to fetch

    Returns Promise<Account | null>

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

Inherited from Connection.getAccountById

getAccountCreationTransfersFiltered

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

Fetches all AccountCreationTransfers with satisfy the accountCreationTransferFilter filter, paginated

Type Declaration

• (
      accountCreationTransferFilter?: AccountCreationTransferFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<AccountCreationTransfer>>

  • Parameters

    • OptionalaccountCreationTransferFilter: AccountCreationTransferFilter

      the accountCreationTransfer filter

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<AccountCreationTransfer>>

Inherited from Connection.getAccountCreationTransfersFiltered

getAccountLinksFiltered

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

Fetches all AccountLinks with satisfy the accountLinkFilter filter, paginated

Type Declaration

• (
      accountLinkFilter?: AccountLinkFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<{ account: Account; secondary: Account }>>

  • Parameters

    • OptionalaccountLinkFilter: AccountLinkFilter

      the accountLink filter

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<{ account: Account; secondary: Account }>>

Inherited from Connection.getAccountLinksFiltered

getAccountsByAuthDescriptorId

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

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

Type Declaration

• (
      id: BufferId,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Account>>

  • Parameters

    • id: BufferId

      id of the auth descriptor

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

    Returns Promise<PaginatedEntity<Account>>

Inherited from Connection.getAccountsByAuthDescriptorId

getAccountsBySigner

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

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

Type Declaration

• (
      signer: BufferId,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Account>>

  • Parameters

    • signer: BufferId

      the pubkey of the signer

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

    Returns Promise<PaginatedEntity<Account>>

Inherited from Connection.getAccountsBySigner

getAccountsByType

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

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

Type Declaration

• (
      type: string,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Account>>

  • Parameters

    • type: string

      the type of account to get

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

    Returns Promise<PaginatedEntity<Account>>

Inherited from Connection.getAccountsByType

getAccountsFiltered

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

Fetches all accounts with satisfy the account filter, paginated

Type Declaration

• (
      accountFilter?: AccountFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Account>>

  • Parameters

    • OptionalaccountFilter: AccountFilter

      the account filter

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<Account>>

Inherited from Connection.getAccountsFiltered

getAllAssets

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

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

Type Declaration

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

  • Parameters

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

    Returns Promise<PaginatedEntity<Asset>>

Inherited from Connection.getAllAssets

getApiVersion

getApiVersion: () => Promise<number>

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

Inherited from Connection.getApiVersion

getAppliedTransfersFiltered

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

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

Type Declaration

• (
      appliedTransferFilter?: TransferFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<AppliedTransfer>>

  • Parameters

    • OptionalappliedTransferFilter: TransferFilter

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

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<AppliedTransfer>>

Returns

paginated results of applied transfers based on the filter selection

Available since ApiVersion 1

Inherited from Connection.getAppliedTransfersFiltered

getAssetById

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

Retrieves asset information using its id

Type Declaration

• (assetId: BufferId): Promise<Asset | null>

  • Parameters

    • assetId: BufferId

      the id of the asset to fetch

    Returns Promise<Asset | null>

Returns

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

Inherited from Connection.getAssetById

getAssetOriginFiltered

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

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

Type Declaration

• (
      assetOriginFilter?: AssetOriginFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<AssetOrigin>>

  • Parameters

    • OptionalassetOriginFilter: AssetOriginFilter

      The asset origin filter (array of assetIds) that can be applied to the query results

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<AssetOrigin>>

Returns

paginated results of assets origin based on the filter selection

Available since ApiVersion 1

Inherited from Connection.getAssetOriginFiltered

getAssetsByName

getAssetsByName: (
    name: string,
    limit?: number,
    cursor?: OptionalPageCursor,
) => 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

• (
      name: string,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Asset>>

  • Parameters

    • name: string

      the name of the asset to fetch

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

    Returns Promise<PaginatedEntity<Asset>>

Inherited from Connection.getAssetsByName

getAssetsBySymbol

getAssetsBySymbol: (
    symbol: string,
    limit?: number,
    cursor?: OptionalPageCursor,
) => 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

• (
      symbol: string,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Asset>>

  • Parameters

    • symbol: string

      the symbol of the asset to fetch

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

    Returns Promise<PaginatedEntity<Asset>>

Inherited from Connection.getAssetsBySymbol

getAssetsByType

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

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

Type Declaration

• (
      type: string,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Asset>>

  • Parameters

    • type: string

      the type of assets to return

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

    Returns Promise<PaginatedEntity<Asset>>

Inherited from Connection.getAssetsByType

getAssetsFiltered

getAssetsFiltered: (
    assetFilter?: AssetFilter,
    limit?: number,
    cursor?: OptionalPageCursor,
) => 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?: AssetFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Asset>>

  • Parameters

    • OptionalassetFilter: AssetFilter

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

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<Asset>>

Inherited from Connection.getAssetsFiltered

getAuthDescriptorSignersFiltered

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

Fetches all AuthDescriptorSigners with satisfy the authDescriptorSigner filter, paginated

Type Declaration

• (
      authDescriptorSignerFilter?: AuthDescriptorSignerFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<AuthDescriptorSigner>>

  • Parameters

    • OptionalauthDescriptorSignerFilter: AuthDescriptorSignerFilter

      the authDescriptorSigner filter

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<AuthDescriptorSigner>>

Inherited from Connection.getAuthDescriptorSignersFiltered

getAuthDescriptorValidator

getAuthDescriptorValidator: (useCache: boolean) => AuthDescriptorValidator

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

Type Declaration

• (useCache: boolean): AuthDescriptorValidator

  • Parameters

    • useCache: boolean

      whether the returned validator should cache validation results or make new backend request for each function call

    Returns AuthDescriptorValidator

Inherited from Connection.getAuthDescriptorValidator

getBalancesFiltered

getBalancesFiltered: (
    balanceFilter?: BalanceFilter,
    limit?: number,
    cursor?: OptionalPageCursor,
) => 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?: BalanceFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Balance>>

  • Parameters

    • OptionalbalanceFilter: BalanceFilter

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

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<Balance>>

Inherited from Connection.getBalancesFiltered

getBlockHeight

getBlockHeight: () => Promise<number>

Returns the current block height of the underlying chain

Inherited from Connection.getBlockHeight

getCanceledTransfersFiltered

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

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

Type Declaration

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

  • Parameters

    • OptionalcanceledTransferFilter: TransferFilter

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

    • Optionallimit: number

      maximum page size

    • Optionalcursor: 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

Inherited from Connection.getCanceledTransfersFiltered

getConfig

getConfig: () => Promise<Config>

Returns the ft config that is currently in effect

Inherited from Connection.getConfig

getCrosschainTransferHistoryEntriesFiltered

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

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

Type Declaration

• (
      crosschainTransferHistoryEntryFilter?: CrosschainTransferHistoryEntryFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<CrosschainTransferHistoryEntry>>

  • Parameters

    • OptionalcrosschainTransferHistoryEntryFilter: CrosschainTransferHistoryEntryFilter

      The crosschain transfer history entry filter (list of account_ids, list of asset_ids, list of transaction_rids and op_index) that can be applied to the query results

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<CrosschainTransferHistoryEntry>>

Inherited from Connection.getCrosschainTransferHistoryEntriesFiltered

getEnabledRegistrationStrategies

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

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

Inherited from Connection.getEnabledRegistrationStrategies

getMainAuthDescriptorsFiltered

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

Fetches all MainAuthDescriptors with satisfy the mainAccountAuthDescriptor filter, paginated

Type Declaration

• (
      mainAccountAuthDescriptorFilter?: MainAccountAuthDescriptorFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<AnyAuthDescriptor>>

  • Parameters

    • OptionalmainAccountAuthDescriptorFilter: MainAccountAuthDescriptorFilter

      the mainAccountAuthDescriptor filter

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<AnyAuthDescriptor>>

Inherited from Connection.getMainAuthDescriptorsFiltered

getPendingTransfersFiltered

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

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

Type Declaration

• (
      pendingTransferFilter?: PendingTransferFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<PendingTransfer>>

  • Parameters

    • OptionalpendingTransferFilter: PendingTransferFilter

      The pending transfer filter (array of transactionIds, initOpIndex and senderAccountId) that can be applied to the query results

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<PendingTransfer>>

Returns

paginated results of pending transfers based on the filter selection

Available since ApiVersion 1

Inherited from Connection.getPendingTransfersFiltered

getRecalledTransfersFiltered

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

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

Type Declaration

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

  • Parameters

    • OptionalrecalledTransferFilter: TransferFilter

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

    • Optionallimit: number

      maximum page size

    • Optionalcursor: 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

Inherited from Connection.getRecalledTransfersFiltered

getRevertedTransfersFiltered

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

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

Type Declaration

• (
      revertedTransferFilter?: TransferFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Transfer>>

  • Parameters

    • OptionalrevertedTransferFilter: TransferFilter

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

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<Transfer>>

Returns

paginated results of reverted transfers based on the filter selection

Available since ApiVersion 1

Inherited from Connection.getRevertedTransfersFiltered

getRlStatesFiltered

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

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

Type Declaration

• (
      rlStateFilter?: RlStateFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<RlState>>

  • Parameters

    • OptionalrlStateFilter: RlStateFilter

      the rlState filter

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<RlState>>

Inherited from Connection.getRlStatesFiltered

getSubscriptionsFiltered

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

Fetches all Subscriptions with satisfy the subscriptionFilter filter, paginated

Type Declaration

• (
      subscriptionFilter?: SubscriptionFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Subscription>>

  • Parameters

    • OptionalsubscriptionFilter: SubscriptionFilter

      the subscriptionFilter filter

    • Optionallimit: number

      maximum size of the returned page

    • Optionalcursor: OptionalPageCursor

      at what entry the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<Subscription>>

Inherited from Connection.getSubscriptionsFiltered

getTransferDetails

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

Retrieves the details of a transfer

Type Declaration

• (txRid: BufferId, opIndex: number): 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

Inherited from Connection.getTransferDetails

getTransferDetailsByAsset

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

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

Type Declaration

• (txRid: BufferId, opIndex: number, assetId: BufferId): 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

Inherited from Connection.getTransferDetailsByAsset

getTransferHistoryEntriesFiltered

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

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

Type Declaration

• (
      transferHistoryEntryFilter?: TransferHistoryEntryFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<TransferHistoryEntry>>

  • Parameters

    • OptionaltransferHistoryEntryFilter: TransferHistoryEntryFilter

      The transfer history entry filter (list of account_ids, list of asset_ids, list of transaction_rids and op_index) that can be applied to the query results

    • Optionallimit: number

      maximum page size

    • Optionalcursor: OptionalPageCursor

      where the page should start

      Available since ApiVersion 1

    Returns Promise<PaginatedEntity<TransferHistoryEntry>>

Inherited from Connection.getTransferHistoryEntriesFiltered

getUnappliedTransfersFiltered

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

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

Type Declaration

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

  • Parameters

    • OptionalunappliedTransferFilter: TransferFilter

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

    • Optionallimit: number

      maximum page size

    • Optionalcursor: 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

Inherited from Connection.getUnappliedTransfersFiltered

getVersion

getVersion: () => Promise<string>

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

Inherited from Connection.getVersion

sign

sign: (tx: RawGtx | GTX | SignedTransaction) => Promise<SignedTransaction>

Signs a transaction using an available key

Type Declaration

• (tx: RawGtx | GTX | SignedTransaction): Promise<SignedTransaction>

  • Parameters

    • tx: RawGtx | GTX | SignedTransaction

      the transaction to sign

    Returns Promise<SignedTransaction>

    the original transaction with the appropriate signatures added

signAndSend

signAndSend: (
    tx: RawGtx | GTX | SignedTransaction,
) => Promise<TransactionReceipt>

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

Type Declaration

• (tx: RawGtx | GTX | SignedTransaction): Promise<TransactionReceipt>

  • Parameters

    • tx: RawGtx | GTX | SignedTransaction

      the transaction to sign and send

    Returns Promise<TransactionReceipt>

    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.