# 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) * [disconnect](#disconnect) * [getAccounts](#getaccounts) * [getCurrentAccount](#getcurrentaccount) * [getCurrentIdentity](#getcurrentidentity) * [getCurrentPair](#getcurrentpair) * [getInvalidDids](#getinvaliddids) * [getLatestBlock](#getlatestblock) * [getSecondaryKeys](#getsecondarykeys) * [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-v6/interfaces/keyringpair) *Defined in* [*src/base/Context.ts:111*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L111) ### isArchiveNode • **isArchiveNode**: *boolean* = false *Defined in* [*src/base/Context.ts:116*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L116) 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:109*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L109) ### ss58Format • **ss58Format**: *number* = DEFAULT\_SS58\_FORMAT *Defined in* [*src/base/Context.ts:118*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L118) ## Accessors ### middlewareApi • **get middlewareApi**(): *ApolloClient‹NormalizedCacheObject›* *Defined in* [*src/base/Context.ts:936*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/account)): *Promise‹*[*AccountBalance*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#accountbalance)*›* *Defined in* [*src/base/Context.ts:293*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L293) 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-v6/classes/account) | **Returns:** *Promise‹*[*AccountBalance*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#accountbalance)*›* ▸ **accountBalance**(`account`: string | [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/account) | undefined, `callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#subcallback)‹[AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#accountbalance)›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#unsubcallback)*›* *Defined in* [*src/base/Context.ts:294*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L294) 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-v6/classes/account) \| undefined | | `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#subcallback)‹[AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#accountbalance)› | **Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#unsubcallback)*›* ### disconnect ▸ **disconnect**(): *Promise‹void›* *Defined in* [*src/base/Context.ts:1006*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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**(): *Array‹*[*AccountData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/accountdata)*›* *Defined in* [*src/base/Context.ts:265*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L265) Retrieve a list of addresses associated with the account **Returns:** *Array‹*[*AccountData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/accountdata)*›* ### getCurrentAccount ▸ **getCurrentAccount**(): [*CurrentAccount*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/currentaccount) *Defined in* [*src/base/Context.ts:355*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L355) 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-v6/classes/currentaccount) ### getCurrentIdentity ▸ **getCurrentIdentity**(): *Promise‹*[*CurrentIdentity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/currentidentity)*›* *Defined in* [*src/base/Context.ts:375*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L375) 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-v6/classes/currentidentity)*›* ### getCurrentPair ▸ **getCurrentPair**(): [*KeyringPair*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/keyringpair) *Defined in* [*src/base/Context.ts:395*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L395) 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-v6/interfaces/keyringpair) ### getInvalidDids ▸ **getInvalidDids**(`identities`: (string | [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/identity)‹›)\[]): *Promise‹string\[]›* *Defined in* [*src/base/Context.ts:423*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L423) Check whether Identities exist **Parameters:** | Name | Type | | ------------ | -------------------------------------------------------------------------------------------------------------------- | | `identities` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/identity)‹›)\[] | **Returns:** *Promise‹string\[]›* ### getLatestBlock ▸ **getLatestBlock**(): *Promise‹BigNumber›* *Defined in* [*src/base/Context.ts:994*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L994) Retrieve the latest block number **Returns:** *Promise‹BigNumber›* ### getSecondaryKeys ▸ **getSecondaryKeys**(): *Promise‹*[*SecondaryKey*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/secondarykey)*\[]›* *Defined in* [*src/base/Context.ts:621*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L621) Retrieve the list of secondary keys related to the Account **`note`** can be subscribed to **Returns:** *Promise‹*[*SecondaryKey*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/secondarykey)*\[]›* ▸ **getSecondaryKeys**(`callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#subcallback)‹[SecondaryKey](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/secondarykey)\[]›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#unsubcallback)*›* *Defined in* [*src/base/Context.ts:622*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L622) **Parameters:** | Name | Type | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#subcallback)‹[SecondaryKey](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/secondarykey)\[]› | **Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#unsubcallback)*›* ### getSigner ▸ **getSigner**(): *AddressOrPair* *Defined in* [*src/base/Context.ts:410*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L410) Retrieve the signer address (or keyring pair) **Returns:** *AddressOrPair* ### getTransactionArguments ▸ **getTransactionArguments**(`args`: object): [*TransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/globals#transactionargument)*\[]* *Defined in* [*src/base/Context.ts:473*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L473) 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-v6/globals#transactionargument)*\[]* ### getTransactionFees ▸ **getTransactionFees**(`tag`: TxTag): *Promise‹BigNumber›* *Defined in* [*src/base/Context.ts:446*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L446) 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/23062de4/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/23062de4/src/base/Context.ts#L974) 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-v6/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimdata)*››* *Defined in* [*src/base/Context.ts:885*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/targettreatment#exclude)‹[ClaimType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/claimtype), [InvestorUniquenessV2](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/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-v6/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-v6/classes/identity)‹›)\[] | identity IDs of claim issuers. Defaults to all claim issuers | **Returns:** *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/claimdata)*››* ### queryMiddleware ▸ **queryMiddleware**‹**Result**›(`query`: GraphqlQuery‹unknown›): *Promise‹ApolloQueryResult‹Result››* *Defined in* [*src/base/Context.ts:952*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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): *Promise‹void›* *Defined in* [*src/base/Context.ts:275*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L275) Set a pair as the current account keyring pair **Parameters:** | Name | Type | | --------- | ------ | | `address` | string | **Returns:** *Promise‹void›* ### `Static` create ▸ **create**(`params`: object): *Promise‹*[*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context)*›* *Defined in* [*src/base/Context.ts:166*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/base/Context.ts#L166) 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-v6/globals#commonkeyring) \| [UiKeyring](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/uikeyring) | | `middlewareApi` | ApolloClient‹NormalizedCacheObject› \| null | | `polymeshApi` | ApiPromise | **Returns:** *Promise‹*[*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context)*›*