# Session · FT4 TypeScript client · Chromia Docs (concept)

> An object which allows the user to interact with an account
by both querying and submitting signed transactions. interface Session { account : Authenticate

Source: https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Session/

Interface

# Session

On this page

* [Properties](#properties)
* [account](#account)
* [blockchainRid](#blockchainrid)
* [call](#call)
* [callWithoutNop](#callwithoutnop)
* [client](#client)
* [getAccountAuthDescriptorsFiltered](#getaccountauthdescriptorsfiltered)
* [getAccountById](#getaccountbyid)
* [getAccountCreationTransfersFiltered](#getaccountcreationtransfersfiltered)
* [getAccountLinksFiltered](#getaccountlinksfiltered)
* [getAccountsByAuthDescriptorId](#getaccountsbyauthdescriptorid)
* [getAccountsBySigner](#getaccountsbysigner)
* [getAccountsByType](#getaccountsbytype)
* [getAccountsFiltered](#getaccountsfiltered)
* [getAllAssets](#getallassets)
* [getApiVersion](#getapiversion)
* [getAppliedTransfersFiltered](#getappliedtransfersfiltered)
* [getAssetById](#getassetbyid)
* [getAssetOriginFiltered](#getassetoriginfiltered)
* [getAssetsByName](#getassetsbyname)
* [getAssetsBySymbol](#getassetsbysymbol)
* [getAssetsByType](#getassetsbytype)
* [getAssetsFiltered](#getassetsfiltered)
* [getAuthDescriptorSignersFiltered](#getauthdescriptorsignersfiltered)
* [getAuthDescriptorValidator](#getauthdescriptorvalidator)
* [getBalancesFiltered](#getbalancesfiltered)
* [getBlockHeight](#getblockheight)
* [getCanceledTransfersFiltered](#getcanceledtransfersfiltered)
* [getConfig](#getconfig)
* [getCrosschainTransferHistoryEntriesFiltered](#getcrosschaintransferhistoryentriesfiltered)
* [getEnabledRegistrationStrategies](#getenabledregistrationstrategies)
* [getMainAuthDescriptorsFiltered](#getmainauthdescriptorsfiltered)
* [getPendingTransfersFiltered](#getpendingtransfersfiltered)
* [getRecalledTransfersFiltered](#getrecalledtransfersfiltered)
* [getRevertedTransfersFiltered](#getrevertedtransfersfiltered)
* [getRlStatesFiltered](#getrlstatesfiltered)
* [getSubscriptionsFiltered](#getsubscriptionsfiltered)
* [getTransferDetails](#gettransferdetails)
* [getTransferDetailsByAsset](#gettransferdetailsbyasset)
* [getTransferHistoryEntriesFiltered](#gettransferhistoryentriesfiltered)
* [getUnappliedTransfersFiltered](#getunappliedtransfersfiltered)
* [getVersion](#getversion)
* [sign](#sign)
* [signAndSend](#signandsend)
* [transactionBuilder](#transactionbuilder)

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

```signature
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](https://docs.chromia.com/pages/ft4-ts-client/hierarchy/#ft-session.Session))

* [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/)
  + Session

## Properties

### account

```signature
account: AuthenticatedAccount
```

### blockchainRid

```signature
blockchainRid: Buffer
```

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[blockchainRid](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#blockchainrid)

### call

```signature
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](#callwithoutnop) instead.

#### Type Declaration

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

  + #### Parameters

    - ...operations: Operation[]

      the operations to include in the transaction

    #### Returns Web3PromiEvent<     [TransactionWithReceipt](https://docs.chromia.com/pages/ft4-ts-client/types/transaction-builder.TransactionWithReceipt/),     { built: SignedTransaction; sent: Buffer }, >

### callWithoutNop

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

Same as [call](#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

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

  + #### Parameters

    - ...operations: Operation[]

      the operations to include in the transaction

    #### Returns Web3PromiEvent<     [TransactionWithReceipt](https://docs.chromia.com/pages/ft4-ts-client/types/transaction-builder.TransactionWithReceipt/),     { built: SignedTransaction; sent: Buffer }, >

### client

```signature
client: IClient
```

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[client](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#client)

### getAccountAuthDescriptorsFiltered

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

Fetches all AccountAuthDescriptors with satisfy the accountAuthDescriptor filter, paginated

#### Type Declaration

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

  + #### Parameters

    - `Optional`accountAuthDescriptorFilter: [AccountAuthDescriptorFilter](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AccountAuthDescriptorFilter/)

      the accountAuthDescriptor filter
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[AnyAuthDescriptor](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AnyAuthDescriptor/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAccountAuthDescriptorsFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getaccountauthdescriptorsfiltered)

### getAccountById

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

Fetches the account with the specified id

#### Type Declaration

* ```signature
  (accountId: BufferId): Promise<Account | null>
  ```

  + #### Parameters

    - accountId: BufferId

      the id of the account to fetch

    #### Returns Promise<[Account](https://docs.chromia.com/pages/ft4-ts-client/interfaces/accounts.Account/) | null>

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

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAccountById](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getaccountbyid)

### getAccountCreationTransfersFiltered

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

Fetches all AccountCreationTransfers with satisfy the accountCreationTransferFilter filter, paginated

#### Type Declaration

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

  + #### Parameters

    - `Optional`accountCreationTransferFilter: [AccountCreationTransferFilter](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AccountCreationTransferFilter/)

      the accountCreationTransfer filter
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[AccountCreationTransfer](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AccountCreationTransfer/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAccountCreationTransfersFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getaccountcreationtransfersfiltered)

### getAccountLinksFiltered

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

Fetches all AccountLinks with satisfy the accountLinkFilter filter, paginated

#### Type Declaration

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

  + #### Parameters

    - `Optional`accountLinkFilter: [AccountLinkFilter](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AccountLinkFilter/)

      the accountLink filter
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<{ account: [Account](https://docs.chromia.com/pages/ft4-ts-client/interfaces/accounts.Account/); secondary: [Account](https://docs.chromia.com/pages/ft4-ts-client/interfaces/accounts.Account/) }>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAccountLinksFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getaccountlinksfiltered)

### getAccountsByAuthDescriptorId

```signature
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

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

  + #### Parameters

    - id: BufferId

      id of the auth descriptor
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Account](https://docs.chromia.com/pages/ft4-ts-client/interfaces/accounts.Account/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAccountsByAuthDescriptorId](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getaccountsbyauthdescriptorid)

### getAccountsBySigner

```signature
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

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

  + #### Parameters

    - signer: BufferId

      the pubkey of the signer
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Account](https://docs.chromia.com/pages/ft4-ts-client/interfaces/accounts.Account/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAccountsBySigner](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getaccountsbysigner)

### getAccountsByType

```signature
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

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

  + #### Parameters

    - type: string

      the type of account to get
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Account](https://docs.chromia.com/pages/ft4-ts-client/interfaces/accounts.Account/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAccountsByType](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getaccountsbytype)

### getAccountsFiltered

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

Fetches all accounts with satisfy the account filter, paginated

#### Type Declaration

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

  + #### Parameters

    - `Optional`accountFilter: [AccountFilter](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AccountFilter/)

      the account filter
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Account](https://docs.chromia.com/pages/ft4-ts-client/interfaces/accounts.Account/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAccountsFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getaccountsfiltered)

### getAllAssets

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

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

#### Type Declaration

* ```signature
  (limit?: number, cursor?: OptionalPageCursor): Promise<PaginatedEntity<Asset>>
  ```

  + #### Parameters

    - `Optional`limit: number

      maximum page size
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Asset](https://docs.chromia.com/pages/ft4-ts-client/types/asset.Asset/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAllAssets](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getallassets)

### getApiVersion

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

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

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getApiVersion](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getapiversion)

### getAppliedTransfersFiltered

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

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

#### Type Declaration

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

  + #### Parameters

    - `Optional`appliedTransferFilter: [TransferFilter](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.TransferFilter/)

      The applied transfer filter (array of initTxRids and initOpIndex)
      that can be applied to the query results
    - `Optional`limit: number

      maximum page size
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[AppliedTransfer](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.AppliedTransfer/)>>

#### Returns

paginated results of applied transfers based on the filter selection

Available since ApiVersion 1

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAppliedTransfersFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getappliedtransfersfiltered)

### getAssetById

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

Retrieves asset information using its id

#### Type Declaration

* ```signature
  (assetId: BufferId): Promise<Asset | null>
  ```

  + #### Parameters

    - assetId: BufferId

      the id of the asset to fetch

    #### Returns Promise<[Asset](https://docs.chromia.com/pages/ft4-ts-client/types/asset.Asset/) | null>

#### Returns

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

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAssetById](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getassetbyid)

### getAssetOriginFiltered

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

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

#### Type Declaration

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

  + #### Parameters

    - `Optional`assetOriginFilter: [AssetOriginFilter](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.AssetOriginFilter/)

      The asset origin filter (array of assetIds) that can be applied to the query results
    - `Optional`limit: number

      maximum page size
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[AssetOrigin](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.AssetOrigin/)>>

#### Returns

paginated results of assets origin based on the filter selection

Available since ApiVersion 1

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAssetOriginFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getassetoriginfiltered)

### getAssetsByName

```signature
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

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

  + #### Parameters

    - name: string

      the name of the asset to fetch
    - `Optional`limit: number

      maximum page size
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Asset](https://docs.chromia.com/pages/ft4-ts-client/types/asset.Asset/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAssetsByName](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getassetsbyname)

### getAssetsBySymbol

```signature
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

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

  + #### Parameters

    - symbol: string

      the symbol of the asset to fetch
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Asset](https://docs.chromia.com/pages/ft4-ts-client/types/asset.Asset/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAssetsBySymbol](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getassetsbysymbol)

### getAssetsByType

```signature
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

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

  + #### Parameters

    - type: string

      the type of assets to return
    - `Optional`limit: number

      maximum page size
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Asset](https://docs.chromia.com/pages/ft4-ts-client/types/asset.Asset/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAssetsByType](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getassetsbytype)

### getAssetsFiltered

```signature
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

* ```signature
  (
      assetFilter?: AssetFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Asset>>
  ```

  + #### Parameters

    - `Optional`assetFilter: [AssetFilter](https://docs.chromia.com/pages/ft4-ts-client/types/asset.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](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Asset](https://docs.chromia.com/pages/ft4-ts-client/types/asset.Asset/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAssetsFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getassetsfiltered)

### getAuthDescriptorSignersFiltered

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

Fetches all AuthDescriptorSigners with satisfy the authDescriptorSigner filter, paginated

#### Type Declaration

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

  + #### Parameters

    - `Optional`authDescriptorSignerFilter: [AuthDescriptorSignerFilter](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AuthDescriptorSignerFilter/)

      the authDescriptorSigner filter
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[AuthDescriptorSigner](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AuthDescriptorSigner/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAuthDescriptorSignersFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getauthdescriptorsignersfiltered)

### getAuthDescriptorValidator

```signature
getAuthDescriptorValidator: (useCache: boolean) => AuthDescriptorValidator
```

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

#### Type Declaration

* ```signature
  (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](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AuthDescriptorValidator/)

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getAuthDescriptorValidator](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getauthdescriptorvalidator)

### getBalancesFiltered

```signature
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

* ```signature
  (
      balanceFilter?: BalanceFilter,
      limit?: number,
      cursor?: OptionalPageCursor,
  ): Promise<PaginatedEntity<Balance>>
  ```

  + #### Parameters

    - `Optional`balanceFilter: [BalanceFilter](https://docs.chromia.com/pages/ft4-ts-client/types/asset.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](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Balance](https://docs.chromia.com/pages/ft4-ts-client/types/asset.Balance/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getBalancesFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getbalancesfiltered)

### getBlockHeight

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

Returns the current block height of the underlying chain

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getBlockHeight](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getblockheight)

### getCanceledTransfersFiltered

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

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

#### Type Declaration

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

  + #### Parameters

    - `Optional`canceledTransferFilter: [TransferFilter](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.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](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Transfer](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.Transfer/)>>

#### Returns

paginated results of canceled transfers based on the filter selection

Available since ApiVersion 1

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getCanceledTransfersFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getcanceledtransfersfiltered)

### getConfig

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

Returns the ft config that is currently in effect

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getConfig](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getconfig)

### getCrosschainTransferHistoryEntriesFiltered

```signature
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

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

  + #### Parameters

    - `Optional`crosschainTransferHistoryEntryFilter: [CrosschainTransferHistoryEntryFilter](https://docs.chromia.com/pages/ft4-ts-client/types/asset.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
    - `Optional`limit: number

      maximum page size
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[CrosschainTransferHistoryEntry](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.CrosschainTransferHistoryEntry/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getCrosschainTransferHistoryEntriesFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getcrosschaintransferhistoryentriesfiltered)

### getEnabledRegistrationStrategies

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

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

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getEnabledRegistrationStrategies](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getenabledregistrationstrategies)

### getMainAuthDescriptorsFiltered

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

Fetches all MainAuthDescriptors with satisfy the mainAccountAuthDescriptor filter, paginated

#### Type Declaration

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

  + #### Parameters

    - `Optional`mainAccountAuthDescriptorFilter: [MainAccountAuthDescriptorFilter](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.MainAccountAuthDescriptorFilter/)

      the mainAccountAuthDescriptor filter
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[AnyAuthDescriptor](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.AnyAuthDescriptor/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getMainAuthDescriptorsFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getmainauthdescriptorsfiltered)

### getPendingTransfersFiltered

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

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

#### Type Declaration

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

  + #### Parameters

    - `Optional`pendingTransferFilter: [PendingTransferFilter](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.PendingTransferFilter/)

      The pending transfer filter (array of transactionIds, initOpIndex and senderAccountId)
      that can be applied to the query results
    - `Optional`limit: number

      maximum page size
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[PendingTransfer](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.PendingTransfer/)>>

#### Returns

paginated results of pending transfers based on the filter selection

Available since ApiVersion 1

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getPendingTransfersFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getpendingtransfersfiltered)

### getRecalledTransfersFiltered

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

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

#### Type Declaration

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

  + #### Parameters

    - `Optional`recalledTransferFilter: [TransferFilter](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.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](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Transfer](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.Transfer/)>>

#### Returns

paginated results of recalled transfers based on the filter selection

Available since ApiVersion 1

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getRecalledTransfersFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getrecalledtransfersfiltered)

### getRevertedTransfersFiltered

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

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

#### Type Declaration

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

  + #### Parameters

    - `Optional`revertedTransferFilter: [TransferFilter](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.TransferFilter/)

      The reverted transfer filter (array of initTxRids and initOpIndex)
      that can be applied to the query results
    - `Optional`limit: number

      maximum page size
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Transfer](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.Transfer/)>>

#### Returns

paginated results of reverted transfers based on the filter selection

Available since ApiVersion 1

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getRevertedTransfersFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getrevertedtransfersfiltered)

### getRlStatesFiltered

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

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

#### Type Declaration

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

  + #### Parameters

    - `Optional`rlStateFilter: [RlStateFilter](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.RlStateFilter/)

      the rlState filter
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[RlState](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.RlState/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getRlStatesFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getrlstatesfiltered)

### getSubscriptionsFiltered

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

Fetches all Subscriptions with satisfy the subscriptionFilter filter, paginated

#### Type Declaration

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

  + #### Parameters

    - `Optional`subscriptionFilter: [SubscriptionFilter](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.SubscriptionFilter/)

      the subscriptionFilter filter
    - `Optional`limit: number

      maximum size of the returned page
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      at what entry the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Subscription](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.Subscription/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getSubscriptionsFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getsubscriptionsfiltered)

### getTransferDetails

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

Retrieves the details of a transfer

#### Type Declaration

* ```signature
  (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](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.TransferDetail/)[]>

#### Returns

Details about the transfer

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getTransferDetails](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#gettransferdetails)

### getTransferDetailsByAsset

```signature
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

* ```signature
  (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](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.TransferDetail/)[]>

#### Returns

The transfer details

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getTransferDetailsByAsset](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#gettransferdetailsbyasset)

### getTransferHistoryEntriesFiltered

```signature
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

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

  + #### Parameters

    - `Optional`transferHistoryEntryFilter: [TransferHistoryEntryFilter](https://docs.chromia.com/pages/ft4-ts-client/types/asset.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
    - `Optional`limit: number

      maximum page size
    - `Optional`cursor: [OptionalPageCursor](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[TransferHistoryEntry](https://docs.chromia.com/pages/ft4-ts-client/types/accounts.TransferHistoryEntry/)>>

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getTransferHistoryEntriesFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#gettransferhistoryentriesfiltered)

### getUnappliedTransfersFiltered

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

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

#### Type Declaration

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

  + #### Parameters

    - `Optional`unappliedTransferFilter: [TransferFilter](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.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](https://docs.chromia.com/pages/ft4-ts-client/types/ft-session.OptionalPageCursor/)

      where the page should start

      Available since ApiVersion 1

    #### Returns Promise<[PaginatedEntity](https://docs.chromia.com/pages/ft4-ts-client/types/utils.PaginatedEntity/)<[Transfer](https://docs.chromia.com/pages/ft4-ts-client/types/crosschain.Transfer/)>>

#### Returns

paginated results of unapplied transfers based on the filter selection

Available since ApiVersion 1

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getUnappliedTransfersFiltered](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getunappliedtransfersfiltered)

### getVersion

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

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

Inherited from [Connection](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/).[getVersion](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Connection/#getversion)

### sign

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

Signs a transaction using an available key

#### Type Declaration

* ```signature
  (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

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

Same as [sign](#sign) but it also submits the resulting transaction to the blockchain.

#### Type Declaration

* ```signature
  (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

```signature
transactionBuilder: () => TransactionBuilder
```

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

[View this page on docs.chromia.com](https://docs.chromia.com/pages/ft4-ts-client/interfaces/ft-session.Session.html)Generated API reference, mirrored from the live docs