# Polymesh

Main entry point of the Polymesh SDK

## Hierarchy

* **Polymesh**

## Index

### Properties

* [claims](#claims)
* [middleware](#middleware)
* [registerIdentity](#registeridentity)
* [reserveTicker](#reserveticker)
* [transferPolyX](#transferpolyx)

### Accessors

* [\_polkadotApi](#_polkadotapi)

### Methods

* [disconnect](#disconnect)
* [getAccount](#getaccount)
* [getAccountBalance](#getaccountbalance)
* [getCurrentIdentity](#getcurrentidentity)
* [getIdentity](#getidentity)
* [getLatestBlock](#getlatestblock)
* [getNetworkProperties](#getnetworkproperties)
* [getSecurityToken](#getsecuritytoken)
* [getSecurityTokens](#getsecuritytokens)
* [getTickerReservation](#gettickerreservation)
* [getTickerReservations](#gettickerreservations)
* [getTransactionFees](#gettransactionfees)
* [getTreasuryAccount](#gettreasuryaccount)
* [getTreasuryBalance](#gettreasurybalance)
* [isIdentityValid](#isidentityvalid)
* [isTickerAvailable](#istickeravailable)
* [onConnectionError](#onconnectionerror)
* [onDisconnect](#ondisconnect)
* [connect](#static-connect)

## Properties

### claims

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

*Defined in* [*src/Polymesh.ts:74*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L74)

### middleware

• **middleware**: [*Middleware*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/middleware)

*Defined in* [*src/Polymesh.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L75)

### registerIdentity

• **registerIdentity**: *ProcedureMethod‹*[*RegisterIdentityParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/registeridentityparams)*,* [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/identity)*›*

*Defined in* [*src/Polymesh.ts:639*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L639)

Register an Identity

**`note`** must be a CDD provider

**`note`** this may create [Authorization Requests](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/authorizationrequest) which have to be accepted by the corresponding [Accounts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/account) and/or [Identities](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/enums/scopetype#identity). An Account or Identity can fetch its pending Authorization Requests by calling `authorizations.getReceived`

**`note`** required role:

* Customer Due Diligence Provider

### reserveTicker

• **reserveTicker**: *ProcedureMethod‹*[*ReserveTickerParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/reservetickerparams)*,* [*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/tickerreservation)*›*

*Defined in* [*src/Polymesh.ts:330*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L330)

Reserve a ticker symbol to later use in the creation of a Security Token. The ticker will expire after a set amount of time, after which other users can reserve it

**`param`** ticker symbol to reserve

**`note`** required role:

* Ticker Owner

### transferPolyX

• **transferPolyX**: *ProcedureMethod‹*[*TransferPolyXParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/transferpolyxparams)*, void›*

*Defined in* [*src/Polymesh.ts:269*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L269)

Transfer an amount of POLYX to a specified Account

**`param`** account that will receive the POLYX

**`param`** amount of POLYX to be transferred

**`param`** identifier string to help differentiate transfers

## Accessors

### \_polkadotApi

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

*Defined in* [*src/Polymesh.ts:664*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L664)

Polkadot client

**Returns:** *ApiPromise*

## Methods

### disconnect

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

*Defined in* [*src/Polymesh.ts:655*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L655)

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](#static-connect)

**Returns:** *Promise‹void›*

### getAccount

▸ **getAccount**(): [*CurrentAccount*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/currentaccount)

*Defined in* [*src/Polymesh.ts:443*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L443)

Create an Account instance from an address. If no address is passed, the current Account is returned

**Returns:** [*CurrentAccount*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/currentaccount)

▸ **getAccount**(`args`: object): [*Account*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/account)

*Defined in* [*src/Polymesh.ts:444*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L444)

**Parameters:**

▪ **args**: *object*

| Name      | Type   |
| --------- | ------ |
| `address` | string |

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

### getAccountBalance

▸ **getAccountBalance**(`args?`: undefined | object): *Promise‹*[*AccountBalance*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#accountbalance)*›*

*Defined in* [*src/Polymesh.ts:278*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L278)

Get the free/locked POLYX balance of an Account

**`note`** can be subscribed to

**Parameters:**

| Name    | Type                |
| ------- | ------------------- |
| `args?` | undefined \| object |

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

▸ **getAccountBalance**(`callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹[AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#accountbalance)›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

*Defined in* [*src/Polymesh.ts:279*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L279)

**Parameters:**

| Name       | Type                                                                                                                                                                                                                       |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹[AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#accountbalance)› |

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

▸ **getAccountBalance**(`args`: object, `callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹[AccountBalance](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#accountbalance)›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

*Defined in* [*src/Polymesh.ts:280*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L280)

**Parameters:**

▪ **args**: *object*

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

▪ **callback**: [*SubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)*‹*[*AccountBalance*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#accountbalance)*›*

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

### getCurrentIdentity

▸ **getCurrentIdentity**(): *Promise‹*[*CurrentIdentity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/currentidentity) *| null›*

*Defined in* [*src/Polymesh.ts:436*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L436)

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

**Returns:** *Promise‹*[*CurrentIdentity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/currentidentity) *| null›*

### getIdentity

▸ **getIdentity**(`args`: object): [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/identity)

*Defined in* [*src/Polymesh.ts:429*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L429)

Create an Identity instance from a DID

**Parameters:**

▪ **args**: *object*

| Name  | Type   |
| ----- | ------ |
| `did` | string |

**Returns:** [*Identity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/identity)

### getLatestBlock

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

*Defined in* [*src/Polymesh.ts:644*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L644)

Retrieve the number of the latest block in the chain

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

### getNetworkProperties

▸ **getNetworkProperties**(): *Promise‹*[*NetworkProperties*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/networkproperties)*›*

*Defined in* [*src/Polymesh.ts:585*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L585)

Retrieve information for the current network

**Returns:** *Promise‹*[*NetworkProperties*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/networkproperties)*›*

### getSecurityToken

▸ **getSecurityToken**(`args`: object): *Promise‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/securitytoken)*›*

*Defined in* [*src/Polymesh.ts:559*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L559)

Retrieve a Security Token

**Parameters:**

▪ **args**: *object*

| Name     | Type   | Description           |
| -------- | ------ | --------------------- |
| `ticker` | string | Security Token ticker |

**Returns:** *Promise‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/securitytoken)*›*

### getSecurityTokens

▸ **getSecurityTokens**(`args?`: undefined | object): *Promise‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/securitytoken)*\[]›*

*Defined in* [*src/Polymesh.ts:527*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L527)

Retrieve all the Security Tokens owned by an Identity

**`note`** tokens with unreadable characters in their tickers will be left out

**Parameters:**

| Name    | Type                |
| ------- | ------------------- |
| `args?` | undefined \| object |

**Returns:** *Promise‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/securitytoken)*\[]›*

### getTickerReservation

▸ **getTickerReservation**(`args`: object): *Promise‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/tickerreservation)*›*

*Defined in* [*src/Polymesh.ts:403*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L403)

Retrieve a Ticker Reservation

**Parameters:**

▪ **args**: *object*

| Name     | Type   | Description           |
| -------- | ------ | --------------------- |
| `ticker` | string | Security Token ticker |

**Returns:** *Promise‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/tickerreservation)*›*

### getTickerReservations

▸ **getTickerReservations**(`args?`: undefined | object): *Promise‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/tickerreservation)*\[]›*

*Defined in* [*src/Polymesh.ts:369*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L369)

Retrieve all the ticker reservations currently owned by an Identity. This doesn't include tokens that have already been launched

**`note`** reservations with unreadable characters in their tickers will be left out

**Parameters:**

| Name    | Type                |
| ------- | ------------------- |
| `args?` | undefined \| object |

**Returns:** *Promise‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/tickerreservation)*\[]›*

### getTransactionFees

▸ **getTransactionFees**(`args`: object): *Promise‹BigNumber›*

*Defined in* [*src/Polymesh.ts:471*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L471)

Retrieve the protocol fees associated with running a specific transaction

**Parameters:**

▪ **args**: *object*

| Name  | Type  | Description                                                            |
| ----- | ----- | ---------------------------------------------------------------------- |
| `tag` | TxTag | transaction tag (i.e. TxTags.asset.CreateAsset or "asset.createAsset") |

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

### getTreasuryAccount

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

*Defined in* [*src/Polymesh.ts:478*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L478)

Get the treasury wallet address

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

### getTreasuryBalance

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

*Defined in* [*src/Polymesh.ts:609*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L609)

Get the Treasury POLYX balance

**`note`** can be subscribed to

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

▸ **getTreasuryBalance**(`callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹BigNumber›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

*Defined in* [*src/Polymesh.ts:610*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L610)

**Parameters:**

| Name       | Type                                                                                                                 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹BigNumber› |

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

### isIdentityValid

▸ **isIdentityValid**(`args`: object): *Promise‹boolean›*

*Defined in* [*src/Polymesh.ts:460*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L460)

Return whether the supplied Identity/DID exists

**Parameters:**

▪ **args**: *object*

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

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

### isTickerAvailable

▸ **isTickerAvailable**(`args`: object): *Promise‹boolean›*

*Defined in* [*src/Polymesh.ts:337*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L337)

Check if a ticker hasn't been reserved

**`note`** can be subscribed to

**Parameters:**

▪ **args**: *object*

| Name     | Type   |
| -------- | ------ |
| `ticker` | string |

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

▸ **isTickerAvailable**(`args`: object, `callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹boolean›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

*Defined in* [*src/Polymesh.ts:338*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L338)

**Parameters:**

▪ **args**: *object*

| Name     | Type   |
| -------- | ------ |
| `ticker` | string |

▪ **callback**: [*SubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)*‹boolean›*

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

### onConnectionError

▸ **onConnectionError**(`callback`: function): *function*

*Defined in* [*src/Polymesh.ts:491*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L491)

Handle connection errors

**Parameters:**

▪ **callback**: *function*

▸ (...`args`: unknown\[]): *unknown*

**Parameters:**

| Name      | Type       |
| --------- | ---------- |
| `...args` | unknown\[] |

**Returns:** *function*

an unsubscribe callback

▸ (): *void*

### onDisconnect

▸ **onDisconnect**(`callback`: function): *function*

*Defined in* [*src/Polymesh.ts:508*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L508)

Handle disconnection

**Parameters:**

▪ **callback**: *function*

▸ (...`args`: unknown\[]): *unknown*

**Parameters:**

| Name      | Type       |
| --------- | ---------- |
| `...args` | unknown\[] |

**Returns:** *function*

an unsubscribe callback

▸ (): *void*

### `Static` connect

▸ **connect**(`params`: [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase) & object): *Promise‹*[*Polymesh*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/polymesh)*›*

*Defined in* [*src/Polymesh.ts:114*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L114)

Create the instance and connect to the Polymesh node using an account seed

**Parameters:**

| Name     | Type                                                                                                                              |
| -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `params` | [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase) & object |

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

▸ **connect**(`params`: [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase) & object): *Promise‹*[*Polymesh*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/polymesh)*›*

*Defined in* [*src/Polymesh.ts:124*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L124)

Create the instance and connect to the Polymesh node using a keyring

**Parameters:**

| Name     | Type                                                                                                                              |
| -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `params` | [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase) & object |

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

▸ **connect**(`params`: [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase) & object): *Promise‹*[*Polymesh*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/polymesh)*›*

*Defined in* [*src/Polymesh.ts:138*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L138)

Create the instance and connect to the Polymesh node using an account URI

**Parameters:**

| Name     | Type                                                                                                                              |
| -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `params` | [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase) & object |

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

▸ **connect**(`params`: [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase) & object): *Promise‹*[*Polymesh*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/polymesh)*›*

*Defined in* [*src/Polymesh.ts:148*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L148)

Create the instance and connect to the Polymesh node using an account mnemonic

**Parameters:**

| Name     | Type                                                                                                                              |
| -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `params` | [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase) & object |

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

▸ **connect**(`params`: [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase)): *Promise‹*[*Polymesh*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/polymesh)*›*

*Defined in* [*src/Polymesh.ts:157*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/Polymesh.ts#L157)

Create the instance and connect to the Polymesh node without an account

**Parameters:**

| Name     | Type                                                                                                                     |
| -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `params` | [ConnectParamsBase](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/connectparamsbase) |

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