# Context Context in which the SDK is being used * Holds the current low level API * Holds the current keyring pair * Holds the current Identity ## Hierarchy * **Context** ## Index ### Properties * [currentPair](#optional-currentpair) * [isArchiveNode](#isarchivenode) * [polymeshApi](#polymeshapi) * [ss58Format](#ss58format) ### Accessors * [middlewareApi](#middlewareapi) ### Methods * [accountBalance](#accountbalance) * [addPair](#addpair) * [clone](#clone) * [disconnect](#disconnect) * [getAccounts](#getaccounts) * [getCurrentAccount](#getcurrentaccount) * [getCurrentIdentity](#getcurrentidentity) * [getCurrentPair](#getcurrentpair) * [getInvalidDids](#getinvaliddids) * [getLatestBlock](#getlatestblock) * [getSigner](#getsigner) * [getTransactionArguments](#gettransactionarguments) * [getTransactionFees](#gettransactionfees) * [isMiddlewareAvailable](#ismiddlewareavailable) * [isMiddlewareEnabled](#ismiddlewareenabled) * [issuedClaims](#issuedclaims) * [queryMiddleware](#querymiddleware) * [setPair](#setpair) * [create](#static-create) ## Properties ### `Optional` currentPair • **currentPair**? : [*KeyringPair*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/keyringpair) *Defined in* [*src/base/Context.ts:114*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L114) ### isArchiveNode • **isArchiveNode**: *boolean* = false *Defined in* [*src/base/Context.ts:119*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L119) Whether the current node is an archive node (contains a full history from genesis onward) or not ### polymeshApi • **polymeshApi**: *ApiPromise* *Defined in* [*src/base/Context.ts:112*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L112) ### ss58Format • **ss58Format**: *number* *Defined in* [*src/base/Context.ts:121*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L121) ## Accessors ### middlewareApi • **get middlewareApi**(): *ApolloClient‹NormalizedCacheObject›* *Defined in* [*src/base/Context.ts:953*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L953) Retrieve the middleware client **`throws`** if the middleware is not enabled **Returns:** *ApolloClient‹NormalizedCacheObject›* ## Methods ### accountBalance ▸ **accountBalance**(`account?`: string | [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/account)): *Promise‹*[*AccountBalance*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#accountbalance)*›* *Defined in* [*src/base/Context.ts:344*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L344) Retrieve the account level POLYX balance **`note`** can be subscribed to **Parameters:** | Name | Type | | ---------- | ----------------------------------------------------------------------------------------------------------- | | `account?` | string \| [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/account) | **Returns:** *Promise‹*[*AccountBalance*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#accountbalance)*›* ▸ **accountBalance**(`account`: string | [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/account) | undefined, `callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#subcallback)‹[AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#accountbalance)›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#unsubcallback)*›* *Defined in* [*src/base/Context.ts:345*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L345) Retrieve the account level POLYX balance **`note`** can be subscribed to **Parameters:** | Name | Type | | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `account` | string \| [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/account) \| undefined | | `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#subcallback)‹[AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#accountbalance)› | **Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#unsubcallback)*›* ### addPair ▸ **addPair**(`params`: [AddPairParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#addpairparams)): [*KeyringPair*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/keyringpair) *Defined in* [*src/base/Context.ts:284*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L284) Add a signing pair to the Keyring **Parameters:** | Name | Type | | -------- | ------------------------------------------------------------------------------------------------------------- | | `params` | [AddPairParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#addpairparams) | **Returns:** [*KeyringPair*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/keyringpair) ### clone ▸ **clone**(): [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/context) *Defined in* [*src/base/Context.ts:1041*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L1041) Returns a (shallow) clone of this instance. Useful for providing a separate Context to Procedures with different signers **Returns:** [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/context) ### disconnect ▸ **disconnect**(): *Promise‹void›* *Defined in* [*src/base/Context.ts:1023*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L1023) Disconnect the Polkadot API, middleware, and render this instance unusable **`note`** after disconnecting, trying to access any property in this objecct will result in an error **Returns:** *Promise‹void›* ### getAccounts ▸ **getAccounts**(): *\[]* *Defined in* [*src/base/Context.ts:261*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L261) Retrieve a list of Accounts that can act as signers **Returns:** *\[]* ### getCurrentAccount ▸ **getCurrentAccount**(): [*CurrentAccount*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/currentaccount) *Defined in* [*src/base/Context.ts:406*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L406) Retrieve current Account **`throws`** if there is no current account associated to the SDK instance **Returns:** [*CurrentAccount*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/currentaccount) ### getCurrentIdentity ▸ **getCurrentIdentity**(): *Promise‹*[*CurrentIdentity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/currentidentity)*›* *Defined in* [*src/base/Context.ts:426*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L426) Retrieve current Identity **`throws`** if there is no Identity associated to the current Account (or there is no current Account associated to the SDK instance) **Returns:** *Promise‹*[*CurrentIdentity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/currentidentity)*›* ### getCurrentPair ▸ **getCurrentPair**(): [*KeyringPair*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/keyringpair) *Defined in* [*src/base/Context.ts:446*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L446) Retrieve current Keyring Pair **`throws`** if there is no Account associated to the SDK instance **Returns:** [*KeyringPair*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/keyringpair) ### getInvalidDids ▸ **getInvalidDids**(`identities`: (string | [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/identity)‹›)\[]): *Promise‹string\[]›* *Defined in* [*src/base/Context.ts:475*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L475) Check whether Identities exist **Parameters:** | Name | Type | | ------------ | -------------------------------------------------------------------------------------------------------------------- | | `identities` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/identity)‹›)\[] | **Returns:** *Promise‹string\[]›* ### getLatestBlock ▸ **getLatestBlock**(): *Promise‹BigNumber›* *Defined in* [*src/base/Context.ts:1011*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L1011) Retrieve the latest block number **Returns:** *Promise‹BigNumber›* ### getSigner ▸ **getSigner**(): *AddressOrPair* *Defined in* [*src/base/Context.ts:462*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L462) Retrieve the signer address (or keyring pair) **Returns:** *AddressOrPair* ### getTransactionArguments ▸ **getTransactionArguments**(`args`: object): [*TransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#transactionargument)*\[]* *Defined in* [*src/base/Context.ts:525*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L525) Retrieve the types of arguments that a certain transaction requires to be run **Parameters:** ▪ **args**: *object* | Name | Type | Description | | ----- | ----- | -------------------------------------------------------------------------------- | | `tag` | TxTag | tag associated with the transaction that will be executed if the proposal passes | **Returns:** [*TransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#transactionargument)*\[]* ### getTransactionFees ▸ **getTransactionFees**(`tag`: TxTag): *Promise‹BigNumber›* *Defined in* [*src/base/Context.ts:498*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L498) Retrieve the protocol fees associated with running a specific transaction **Parameters:** | Name | Type | Description | | ----- | ----- | ---------------------------------------------------------------------- | | `tag` | TxTag | transaction tag (i.e. TxTags.asset.CreateAsset or "asset.createAsset") | **Returns:** *Promise‹BigNumber›* ### isMiddlewareAvailable ▸ **isMiddlewareAvailable**(): *Promise‹boolean›* *Defined in* [*src/base/Context.ts:998*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L998) Return whether the middleware is enabled and online **Returns:** *Promise‹boolean›* ### isMiddlewareEnabled ▸ **isMiddlewareEnabled**(): *boolean* *Defined in* [*src/base/Context.ts:991*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L991) Return whether the middleware was enabled at startup **Returns:** *boolean* ### issuedClaims ▸ **issuedClaims**(`opts`: object): *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/claimdata)*››* *Defined in* [*src/base/Context.ts:902*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L902) Retrieve a list of claims. Can be filtered using parameters **`note`** uses the middleware (optional) **Parameters:** ▪`Default value` **opts**: *object*= {} | Name | Type | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- | | `claimTypes?` | [Exclude](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/enums/targettreatment#exclude)‹[ClaimType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/enums/claimtype), [InvestorUniquenessV2](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/enums/claimtype#investoruniquenessv2)›\[] | types of the claims to fetch. Defaults to any type | | `includeExpired?` | undefined \| false \| true | whether to include expired claims. Defaults to true | | `size?` | undefined \| number | page size | | `start?` | undefined \| number | page offset | | `targets?` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/identity)‹›)\[] | identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets | | `trustedClaimIssuers?` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/identity)‹›)\[] | identity IDs of claim issuers. Defaults to all claim issuers | **Returns:** *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/claimdata)*››* ### queryMiddleware ▸ **queryMiddleware**‹**Result**›(`query`: GraphqlQuery‹unknown›): *Promise‹ApolloQueryResult‹Result››* *Defined in* [*src/base/Context.ts:969*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L969) Make a query to the middleware server using the apollo client **Type parameters:** ▪ **Result**: *Partial‹Query›* **Parameters:** | Name | Type | | ------- | --------------------- | | `query` | GraphqlQuery‹unknown› | **Returns:** *Promise‹ApolloQueryResult‹Result››* ### setPair ▸ **setPair**(`address`: string): *void* *Defined in* [*src/base/Context.ts:326*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L326) Set a pair as the current Account keyring pair **Parameters:** | Name | Type | | --------- | ------ | | `address` | string | **Returns:** *void* ### `Static` create ▸ **create**(`params`: object): *Promise‹*[*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/context)*›* *Defined in* [*src/base/Context.ts:182*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/base/Context.ts#L182) Create the Context instance **Parameters:** ▪ **params**: *object* | Name | Type | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountMnemonic?` | undefined \| string | | `accountSeed?` | undefined \| string | | `accountUri?` | undefined \| string | | `keyring?` | [CommonKeyring](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/globals#commonkeyring) \| [UiKeyring](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/interfaces/uikeyring) | | `middlewareApi` | ApolloClient‹NormalizedCacheObject› \| null | | `polymeshApi` | ApiPromise | **Returns:** *Promise‹*[*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/context)*›*