# api\_client\_Polymesh.Polymesh

[@polymeshassociation/polymesh-sdk](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes) / [Modules](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules) / [api/client/Polymesh](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_polymesh) / Polymesh

## Class: Polymesh

[api/client/Polymesh](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/modules-1/api_client_polymesh).Polymesh

Main entry point of the Polymesh SDK

### Table of contents

#### Properties

* [accountManagement](#accountmanagement)
* [assets](#assets)
* [claims](#claims)
* [identities](#identities)
* [network](#network)
* [settlements](#settlements)

#### Accessors

* [\_middlewareApi](#_middlewareapi)
* [\_polkadotApi](#_polkadotapi)
* [\_signingAddress](#_signingaddress)

#### Methods

* [disconnect](#disconnect)
* [getSigningIdentity](#getsigningidentity)
* [onConnectionError](#onconnectionerror)
* [onDisconnect](#ondisconnect)
* [setSigningAccount](#setsigningaccount)
* [setSigningManager](#setsigningmanager)
* [connect](#connect)

### Properties

#### accountManagement

• **accountManagement**: [`AccountManagement`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_client_accountmanagement.accountmanagement)

A set of methods for managing a Polymesh Identity's Accounts and their permissions

**Defined in**

[api/client/Polymesh.ts:53](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L53)

***

#### assets

• **assets**: [`Assets`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_client_assets.assets)

A set of methods for interacting with Assets

**Defined in**

[api/client/Polymesh.ts:61](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L61)

***

#### claims

• **claims**: [`Claims`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_client_claims.claims)

A set of methods to deal with Claims

**Defined in**

[api/client/Polymesh.ts:41](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L41)

***

#### identities

• **identities**: [`Identities`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_client_identities.identities)

A set of methods for interacting with Polymesh Identities.

**Defined in**

[api/client/Polymesh.ts:57](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L57)

***

#### network

• **network**: [`Network`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_client_network.network)

A set of methods to interact with the Polymesh network. This includes transferring POLYX, reading network properties and querying for historical events

**Defined in**

[api/client/Polymesh.ts:45](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L45)

***

#### settlements

• **settlements**: [`Settlements`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_client_settlements.settlements)

A set of methods for exchanging Assets

**Defined in**

[api/client/Polymesh.ts:49](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L49)

### Accessors

#### \_middlewareApi

• `get` **\_middlewareApi**(): `default`<`NormalizedCacheObject`>

Middleware client

**Returns**

`default`<`NormalizedCacheObject`>

**Defined in**

[api/client/Polymesh.ts:258](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L258)

***

#### \_polkadotApi

• `get` **\_polkadotApi**(): `ApiPromise`

Polkadot client

**Returns**

`ApiPromise`

**Defined in**

[api/client/Polymesh.ts:242](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L242)

***

#### \_signingAddress

• `get` **\_signingAddress**(): `string`

signing address (to manually submit transactions with the polkadot API)

**Returns**

`string`

**Defined in**

[api/client/Polymesh.ts:250](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L250)

### Methods

#### disconnect

▸ **disconnect**(): `Promise`<`void`>

Disconnect the client and close all open connections and subscriptions

**`note`** the SDK will become unusable after this operation. It will throw an error when attempting to access any chain or middleware data. If you wish to continue using the SDK, you must create a new instance by calling [connect](#connect)

**Returns**

`Promise`<`void`>

**Defined in**

[api/client/Polymesh.ts:217](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L217)

***

#### getSigningIdentity

▸ **getSigningIdentity**(): `Promise`<`null` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity)>

Retrieve the Identity associated to the signing Account (null if there is none)

**`throws`** if there is no signing Account associated to the SDK

**Returns**

`Promise`<`null` | [`Identity`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_entities_identity.identity)>

**Defined in**

[api/client/Polymesh.ts:172](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L172)

***

#### onConnectionError

▸ **onConnectionError**(`callback`): () => `void`

Handle connection errors

**Parameters**

| Name       | Type                                   |
| ---------- | -------------------------------------- |
| `callback` | (...`args`: `unknown`\[]) => `unknown` |

**Returns**

`fn`

an unsubscribe callback

▸ (): `void`

Handle connection errors

**Returns**

`void`

an unsubscribe callback

**Defined in**

[api/client/Polymesh.ts:181](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L181)

***

#### onDisconnect

▸ **onDisconnect**(`callback`): () => `void`

Handle disconnection

**Parameters**

| Name       | Type                                   |
| ---------- | -------------------------------------- |
| `callback` | (...`args`: `unknown`\[]) => `unknown` |

**Returns**

`fn`

an unsubscribe callback

▸ (): `void`

Handle disconnection

**Returns**

`void`

an unsubscribe callback

**Defined in**

[api/client/Polymesh.ts:198](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L198)

***

#### setSigningAccount

▸ **setSigningAccount**(`signer`): `Promise`<`void`>

Set the SDK's signing Account to the provided one

**`throws`** if the passed Account is not present in the Signing Manager (or there is no Signing Manager)

**Parameters**

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

**Returns**

`Promise`<`void`>

**Defined in**

[api/client/Polymesh.ts:226](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L226)

***

#### setSigningManager

▸ **setSigningManager**(`signingManager`): `Promise`<`void`>

Set the SDK's Signing Manager to the provided one

**Parameters**

| Name             | Type             |
| ---------------- | ---------------- |
| `signingManager` | `SigningManager` |

**Returns**

`Promise`<`void`>

**Defined in**

[api/client/Polymesh.ts:233](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L233)

***

#### connect

▸ `Static` **connect**(`params`): `Promise`<[`Polymesh`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_client_polymesh.polymesh)>

Create an SDK instance and connect to a Polymesh node

**Parameters**

| Name     | Type            |
| -------- | --------------- |
| `params` | `ConnectParams` |

**Returns**

`Promise`<[`Polymesh`](https://developers.polymath.network/polymesh-sdk-api-reference/docs-alpha/classes/api_client_polymesh.polymesh)>

**Defined in**

[api/client/Polymesh.ts:86](https://github.com/PolymathNetwork/polymesh-sdk/blob/31dfa0dc/src/api/client/Polymesh.ts#L86)