# 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)
* [accountSubsidy](#accountsubsidy)
* [addPair](#addpair)
* [clone](#clone)
* [disconnect](#disconnect)
* [getAccounts](#getaccounts)
* [getCurrentAccount](#getcurrentaccount)
* [getCurrentIdentity](#getcurrentidentity)
* [getCurrentPair](#getcurrentpair)
* [getInvalidDids](#getinvaliddids)
* [getLatestBlock](#getlatestblock)
* [getNetworkVersion](#getnetworkversion)
* [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-v10/interfaces/keyringpair)

*Defined in* [*src/base/Context.ts:111*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L111)

### isArchiveNode

• **isArchiveNode**: *boolean* = false

*Defined in* [*src/base/Context.ts:116*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/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/959efb76/src/base/Context.ts#L109)

### ss58Format

• **ss58Format**: *number*

*Defined in* [*src/base/Context.ts:118*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L118)

## Accessors

### middlewareApi

• **get middlewareApi**(): *ApolloClient‹NormalizedCacheObject›*

*Defined in* [*src/base/Context.ts:1003*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L1003)

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-v10/classes/account)): *Promise‹*[*AccountBalance*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#accountbalance)*›*

*Defined in* [*src/base/Context.ts:342*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L342)

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-v10/classes/account) |

**Returns:** *Promise‹*[*AccountBalance*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#accountbalance)*›*

▸ **accountBalance**(`account`: string | [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account) | undefined, `callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#subcallback)‹[AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#accountbalance)›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#unsubcallback)*›*

*Defined in* [*src/base/Context.ts:343*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L343)

**Parameters:**

| Name       | Type                                                                                                                                                                                                                         |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `account`  | string \| [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account) \| undefined                                                                                                    |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#subcallback)‹[AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#accountbalance)› |

**Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#unsubcallback)*›*

### accountSubsidy

▸ **accountSubsidy**(`account?`: string | [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account)): *Promise‹Omit‹*[*Subsidy*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/subsidy)*, "beneficiary"› | null›*

*Defined in* [*src/base/Context.ts:396*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L396)

Retrieve the account level subsidizer relationship. If there is no such relationship, return null

**`note`** can be subscribed to

**Parameters:**

| Name       | Type                                                                                                         |
| ---------- | ------------------------------------------------------------------------------------------------------------ |
| `account?` | string \| [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account) |

**Returns:** *Promise‹Omit‹*[*Subsidy*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/subsidy)*, "beneficiary"› | null›*

▸ **accountSubsidy**(`account`: string | [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account) | undefined, `callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#subcallback)‹Omit‹[Subsidy](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/subsidy), "beneficiary"› | null›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#unsubcallback)*›*

*Defined in* [*src/base/Context.ts:397*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L397)

**Parameters:**

| Name       | Type                                                                                                                                                                                                                                           |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `account`  | string \| [Account](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account) \| undefined                                                                                                                      |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#subcallback)‹Omit‹[Subsidy](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/subsidy), "beneficiary"› \| null› |

**Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#unsubcallback)*›*

### addPair

▸ **addPair**(`params`: [AddPairParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#addpairparams)): [*KeyringPair*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/keyringpair)

*Defined in* [*src/base/Context.ts:277*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L277)

Add a signing pair to the Keyring

**Parameters:**

| Name     | Type                                                                                                           |
| -------- | -------------------------------------------------------------------------------------------------------------- |
| `params` | [AddPairParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#addpairparams) |

**Returns:** [*KeyringPair*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/keyringpair)

### clone

▸ **clone**(): [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/context)

*Defined in* [*src/base/Context.ts:1100*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L1100)

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-v10/classes/context)

### disconnect

▸ **disconnect**(): *Promise‹void›*

*Defined in* [*src/base/Context.ts:1082*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L1082)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account)*\[]*

*Defined in* [*src/base/Context.ts:254*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L254)

Retrieve a list of Accounts that can act as signers. The first Account in the array is the current Account (default signer)

**Returns:** [*Account*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account)*\[]*

### getCurrentAccount

▸ **getCurrentAccount**(): [*Account*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account)

*Defined in* [*src/base/Context.ts:452*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L452)

Retrieve current Account

**`throws`** if there is no current account associated to the SDK instance

**Returns:** [*Account*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/account)

### getCurrentIdentity

▸ **getCurrentIdentity**(): *Promise‹*[*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/identity)*›*

*Defined in* [*src/base/Context.ts:463*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L463)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/identity)*›*

### getCurrentPair

▸ **getCurrentPair**(): [*KeyringPair*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/keyringpair)

*Defined in* [*src/base/Context.ts:483*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L483)

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-v10/interfaces/keyringpair)

### getInvalidDids

▸ **getInvalidDids**(`identities`: (string | [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/identity)‹›)\[]): *Promise‹string\[]›*

*Defined in* [*src/base/Context.ts:512*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L512)

Check whether Identities exist

**Parameters:**

| Name         | Type                                                                                                                  |
| ------------ | --------------------------------------------------------------------------------------------------------------------- |
| `identities` | (string \| [Identity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/identity)‹›)\[] |

**Returns:** *Promise‹string\[]›*

### getLatestBlock

▸ **getLatestBlock**(): *Promise‹BigNumber›*

*Defined in* [*src/base/Context.ts:1061*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L1061)

Retrieve the latest block number

**Returns:** *Promise‹BigNumber›*

### getNetworkVersion

▸ **getNetworkVersion**(): *Promise‹string›*

*Defined in* [*src/base/Context.ts:1070*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L1070)

Retrieve the network version

**Returns:** *Promise‹string›*

### getSigner

▸ **getSigner**(): *AddressOrPair*

*Defined in* [*src/base/Context.ts:499*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L499)

Retrieve the signer address (or keyring pair)

**Returns:** *AddressOrPair*

### getTransactionArguments

▸ **getTransactionArguments**(`args`: object): [*TransactionArgument*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/globals#transactionargument)*\[]*

*Defined in* [*src/base/Context.ts:562*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L562)

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-v10/globals#transactionargument)*\[]*

### getTransactionFees

▸ **getTransactionFees**(`tag`: TxTag): *Promise‹BigNumber›*

*Defined in* [*src/base/Context.ts:535*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L535)

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:1048*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L1048)

Return whether the middleware is enabled and online

**Returns:** *Promise‹boolean›*

### isMiddlewareEnabled

▸ **isMiddlewareEnabled**(): *boolean*

*Defined in* [*src/base/Context.ts:1041*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L1041)

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-v10/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/claimdata)*››*

*Defined in* [*src/base/Context.ts:952*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L952)

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-v10/enums/targettreatment#exclude)‹[ClaimType](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/enums/claimtype), [InvestorUniquenessV2](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/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-v10/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-v10/classes/identity)‹›)\[]                                                                                                                                                                                                                                           | identity IDs of claim issuers. Defaults to all claim issuers                              |

**Returns:** *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/resultset)*‹*[*ClaimData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/claimdata)*››*

### queryMiddleware

▸ **queryMiddleware**‹**Result**›(`query`: GraphqlQuery‹unknown›): *Promise‹ApolloQueryResult‹Result››*

*Defined in* [*src/base/Context.ts:1019*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L1019)

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:319*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L319)

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-v10/classes/context)*›*

*Defined in* [*src/base/Context.ts:179*](https://github.com/PolymathNetwork/polymesh-sdk/blob/959efb76/src/base/Context.ts#L179)

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-v10/globals#commonkeyring) \| [UiKeyring](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/interfaces/uikeyring) |
| `middlewareApi`    | ApolloClient‹NormalizedCacheObject› \| null                                                                                                                                                                                 |
| `polymeshApi`      | ApiPromise                                                                                                                                                                                                                  |

**Returns:** *Promise‹*[*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v10/classes/context)*›*