> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/context.md). # 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](/polymesh-sdk-api-reference/docs-v9/classes/context.md#optional-currentpair) * [isArchiveNode](/polymesh-sdk-api-reference/docs-v9/classes/context.md#isarchivenode) * [polymeshApi](/polymesh-sdk-api-reference/docs-v9/classes/context.md#polymeshapi) * [ss58Format](/polymesh-sdk-api-reference/docs-v9/classes/context.md#ss58format) ### Accessors * [middlewareApi](/polymesh-sdk-api-reference/docs-v9/classes/context.md#middlewareapi) ### Methods * [accountBalance](/polymesh-sdk-api-reference/docs-v9/classes/context.md#accountbalance) * [addPair](/polymesh-sdk-api-reference/docs-v9/classes/context.md#addpair) * [clone](/polymesh-sdk-api-reference/docs-v9/classes/context.md#clone) * [disconnect](/polymesh-sdk-api-reference/docs-v9/classes/context.md#disconnect) * [getAccounts](/polymesh-sdk-api-reference/docs-v9/classes/context.md#getaccounts) * [getCurrentAccount](/polymesh-sdk-api-reference/docs-v9/classes/context.md#getcurrentaccount) * [getCurrentIdentity](/polymesh-sdk-api-reference/docs-v9/classes/context.md#getcurrentidentity) * [getCurrentPair](/polymesh-sdk-api-reference/docs-v9/classes/context.md#getcurrentpair) * [getInvalidDids](/polymesh-sdk-api-reference/docs-v9/classes/context.md#getinvaliddids) * [getLatestBlock](/polymesh-sdk-api-reference/docs-v9/classes/context.md#getlatestblock) * [getSigner](/polymesh-sdk-api-reference/docs-v9/classes/context.md#getsigner) * [getTransactionArguments](/polymesh-sdk-api-reference/docs-v9/classes/context.md#gettransactionarguments) * [getTransactionFees](/polymesh-sdk-api-reference/docs-v9/classes/context.md#gettransactionfees) * [isMiddlewareAvailable](/polymesh-sdk-api-reference/docs-v9/classes/context.md#ismiddlewareavailable) * [isMiddlewareEnabled](/polymesh-sdk-api-reference/docs-v9/classes/context.md#ismiddlewareenabled) * [issuedClaims](/polymesh-sdk-api-reference/docs-v9/classes/context.md#issuedclaims) * [queryMiddleware](/polymesh-sdk-api-reference/docs-v9/classes/context.md#querymiddleware) * [setPair](/polymesh-sdk-api-reference/docs-v9/classes/context.md#setpair) * [create](/polymesh-sdk-api-reference/docs-v9/classes/context.md#static-create) ## Properties ### `Optional` currentPair • **currentPair**? : [*KeyringPair*](/polymesh-sdk-api-reference/docs-v9/interfaces/keyringpair.md) *Defined in* [*src/base/Context.ts:101*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L101) ### isArchiveNode • **isArchiveNode**: *boolean* = false *Defined in* [*src/base/Context.ts:106*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L106) 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:99*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L99) ### ss58Format • **ss58Format**: *number* *Defined in* [*src/base/Context.ts:108*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L108) ## Accessors ### middlewareApi • **get middlewareApi**(): *ApolloClient‹NormalizedCacheObject›* *Defined in* [*src/base/Context.ts:936*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L936) Retrieve the middleware client **`throws`** if the middleware is not enabled **Returns:** *ApolloClient‹NormalizedCacheObject›* ## Methods ### accountBalance ▸ **accountBalance**(`account?`: string | [Account](/polymesh-sdk-api-reference/docs-v9/classes/account.md)): *Promise‹*[*AccountBalance*](/polymesh-sdk-api-reference/docs-v9/globals.md#accountbalance)*›* *Defined in* [*src/base/Context.ts:327*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L327) Retrieve the account level POLYX balance **`note`** can be subscribed to **Parameters:** | Name | Type | | ---------- | --------------------------------------------------------------------------- | | `account?` | string \| [Account](/polymesh-sdk-api-reference/docs-v9/classes/account.md) | **Returns:** *Promise‹*[*AccountBalance*](/polymesh-sdk-api-reference/docs-v9/globals.md#accountbalance)*›* ▸ **accountBalance**(`account`: string | [Account](/polymesh-sdk-api-reference/docs-v9/classes/account.md) | undefined, `callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹[AccountBalance](/polymesh-sdk-api-reference/docs-v9/globals.md#accountbalance)›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›* *Defined in* [*src/base/Context.ts:328*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L328) Retrieve the account level POLYX balance **`note`** can be subscribed to **Parameters:** | Name | Type | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `account` | string \| [Account](/polymesh-sdk-api-reference/docs-v9/classes/account.md) \| undefined | | `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹[AccountBalance](/polymesh-sdk-api-reference/docs-v9/globals.md#accountbalance)› | **Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›* ### addPair ▸ **addPair**(`params`: [AddPairParams](/polymesh-sdk-api-reference/docs-v9/globals.md#addpairparams)): [*KeyringPair*](/polymesh-sdk-api-reference/docs-v9/interfaces/keyringpair.md) *Defined in* [*src/base/Context.ts:267*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L267) Add a signing pair to the Keyring **Parameters:** | Name | Type | | -------- | ----------------------------------------------------------------------------- | | `params` | [AddPairParams](/polymesh-sdk-api-reference/docs-v9/globals.md#addpairparams) | **Returns:** [*KeyringPair*](/polymesh-sdk-api-reference/docs-v9/interfaces/keyringpair.md) ### clone ▸ **clone**(): [*Context*](/polymesh-sdk-api-reference/docs-v9/classes/context.md) *Defined in* [*src/base/Context.ts:1024*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L1024) Returns a (shallow) clone of this instance. Useful for providing a separate Context to Procedures with different signers **Returns:** [*Context*](/polymesh-sdk-api-reference/docs-v9/classes/context.md) ### disconnect ▸ **disconnect**(): *Promise‹void›* *Defined in* [*src/base/Context.ts:1006*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L1006) 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**(): [*Account*](/polymesh-sdk-api-reference/docs-v9/classes/account.md)*\[]* *Defined in* [*src/base/Context.ts:244*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L244) Retrieve a list of Accounts that can act as signers. The first Account in the array is the current Account (default signer) **Returns:** [*Account*](/polymesh-sdk-api-reference/docs-v9/classes/account.md)*\[]* ### getCurrentAccount ▸ **getCurrentAccount**(): [*Account*](/polymesh-sdk-api-reference/docs-v9/classes/account.md) *Defined in* [*src/base/Context.ts:389*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L389) Retrieve current Account **`throws`** if there is no current account associated to the SDK instance **Returns:** [*Account*](/polymesh-sdk-api-reference/docs-v9/classes/account.md) ### getCurrentIdentity ▸ **getCurrentIdentity**(): *Promise‹*[*Identity*](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)*›* *Defined in* [*src/base/Context.ts:409*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L409) 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‹*[*Identity*](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)*›* ### getCurrentPair ▸ **getCurrentPair**(): [*KeyringPair*](/polymesh-sdk-api-reference/docs-v9/interfaces/keyringpair.md) *Defined in* [*src/base/Context.ts:429*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L429) Retrieve current Keyring Pair **`throws`** if there is no Account associated to the SDK instance **Returns:** [*KeyringPair*](/polymesh-sdk-api-reference/docs-v9/interfaces/keyringpair.md) ### getInvalidDids ▸ **getInvalidDids**(`identities`: (string | [Identity](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)‹›)\[]): *Promise‹string\[]›* *Defined in* [*src/base/Context.ts:458*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L458) Check whether Identities exist **Parameters:** | Name | Type | | ------------ | ------------------------------------------------------------------------------------ | | `identities` | (string \| [Identity](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)‹›)\[] | **Returns:** *Promise‹string\[]›* ### getLatestBlock ▸ **getLatestBlock**(): *Promise‹BigNumber›* *Defined in* [*src/base/Context.ts:994*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L994) Retrieve the latest block number **Returns:** *Promise‹BigNumber›* ### getSigner ▸ **getSigner**(): *AddressOrPair* *Defined in* [*src/base/Context.ts:445*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L445) Retrieve the signer address (or keyring pair) **Returns:** *AddressOrPair* ### getTransactionArguments ▸ **getTransactionArguments**(`args`: object): [*TransactionArgument*](/polymesh-sdk-api-reference/docs-v9/globals.md#transactionargument)*\[]* *Defined in* [*src/base/Context.ts:508*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L508) 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*](/polymesh-sdk-api-reference/docs-v9/globals.md#transactionargument)*\[]* ### getTransactionFees ▸ **getTransactionFees**(`tag`: TxTag): *Promise‹BigNumber›* *Defined in* [*src/base/Context.ts:481*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L481) 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:981*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L981) Return whether the middleware is enabled and online **Returns:** *Promise‹boolean›* ### isMiddlewareEnabled ▸ **isMiddlewareEnabled**(): *boolean* *Defined in* [*src/base/Context.ts:974*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L974) Return whether the middleware was enabled at startup **Returns:** *boolean* ### issuedClaims ▸ **issuedClaims**(`opts`: object): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*ClaimData*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimdata.md)*››* *Defined in* [*src/base/Context.ts:885*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L885) 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](/polymesh-sdk-api-reference/docs-v9/enums/targettreatment.md#exclude)‹[ClaimType](/polymesh-sdk-api-reference/docs-v9/enums/claimtype.md), [InvestorUniquenessV2](/polymesh-sdk-api-reference/docs-v9/enums/claimtype.md#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](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)‹›)\[] | identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets | | `trustedClaimIssuers?` | (string \| [Identity](/polymesh-sdk-api-reference/docs-v9/classes/identity.md)‹›)\[] | identity IDs of claim issuers. Defaults to all claim issuers | **Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v9/interfaces/resultset.md)*‹*[*ClaimData*](/polymesh-sdk-api-reference/docs-v9/interfaces/claimdata.md)*››* ### queryMiddleware ▸ **queryMiddleware**‹**Result**›(`query`: GraphqlQuery‹unknown›): *Promise‹ApolloQueryResult‹Result››* *Defined in* [*src/base/Context.ts:952*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L952) 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:309*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L309) Set a pair as the current Account keyring pair **Parameters:** | Name | Type | | --------- | ------ | | `address` | string | **Returns:** *void* ### `Static` create ▸ **create**(`params`: object): *Promise‹*[*Context*](/polymesh-sdk-api-reference/docs-v9/classes/context.md)*›* *Defined in* [*src/base/Context.ts:169*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/base/Context.ts#L169) Create the Context instance **Parameters:** ▪ **params**: *object* | Name | Type | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accountMnemonic?` | undefined \| string | | `accountSeed?` | undefined \| string | | `accountUri?` | undefined \| string | | `keyring?` | [CommonKeyring](/polymesh-sdk-api-reference/docs-v9/globals.md#commonkeyring) \| [UiKeyring](/polymesh-sdk-api-reference/docs-v9/interfaces/uikeyring.md) | | `middlewareApi` | ApolloClient‹NormalizedCacheObject› \| null | | `polymeshApi` | ApiPromise | **Returns:** *Promise‹*[*Context*](/polymesh-sdk-api-reference/docs-v9/classes/context.md)*›*