> 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-v2/classes/polymesh.md).

# Polymesh

Main entry point of the Polymesh SDK

## Hierarchy

* **Polymesh**

## Index

### Properties

* [claims](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#claims)
* [middleware](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#middleware)

### Accessors

* [\_polkadotApi](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#_polkadotapi)

### Methods

* [getAccount](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#getaccount)
* [getAccountBalance](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#getaccountbalance)
* [getCurrentIdentity](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#getcurrentidentity)
* [getIdentity](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#getidentity)
* [getLatestBlock](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#getlatestblock)
* [getNetworkProperties](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#getnetworkproperties)
* [getSecurityToken](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#getsecuritytoken)
* [getSecurityTokens](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#getsecuritytokens)
* [getTickerReservation](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#gettickerreservation)
* [getTickerReservations](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#gettickerreservations)
* [getTransactionFees](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#gettransactionfees)
* [getTreasuryAccount](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#gettreasuryaccount)
* [getTreasuryBalance](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#gettreasurybalance)
* [isIdentityValid](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#isidentityvalid)
* [isTickerAvailable](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#istickeravailable)
* [onConnectionError](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#onconnectionerror)
* [onDisconnect](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#ondisconnect)
* [registerIdentity](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#registeridentity)
* [reserveTicker](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#reserveticker)
* [transferPolyX](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#transferpolyx)
* [connect](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md#static-connect)

## Properties

### claims

• **claims**: [*Claims*](/polymesh-sdk-api-reference/docs-v2/classes/claims.md)

*Defined in* [*src/Polymesh.ts:78*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L78)

### middleware

• **middleware**: [*Middleware*](/polymesh-sdk-api-reference/docs-v2/classes/middleware.md)

*Defined in* [*src/Polymesh.ts:79*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L79)

## Accessors

### \_polkadotApi

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

*Defined in* [*src/Polymesh.ts:651*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L651)

Polkadot client

**Returns:** *ApiPromise*

## Methods

### getAccount

▸ **getAccount**(): [*CurrentAccount*](/polymesh-sdk-api-reference/docs-v2/classes/currentaccount.md)

*Defined in* [*src/Polymesh.ts:441*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L441)

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

**Returns:** [*CurrentAccount*](/polymesh-sdk-api-reference/docs-v2/classes/currentaccount.md)

▸ **getAccount**(`args`: object): [*Account*](/polymesh-sdk-api-reference/docs-v2/classes/account.md)

*Defined in* [*src/Polymesh.ts:442*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L442)

**Parameters:**

▪ **args**: *object*

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

**Returns:** [*Account*](/polymesh-sdk-api-reference/docs-v2/classes/account.md)

### getAccountBalance

▸ **getAccountBalance**(`args?`: undefined | object): *Promise‹*[*AccountBalance*](/polymesh-sdk-api-reference/docs-v2/interfaces/accountbalance.md)*›*

*Defined in* [*src/Polymesh.ts:272*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L272)

Get the free/locked POLYX balance of an Account

**`note`** can be subscribed to

**Parameters:**

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

**Returns:** *Promise‹*[*AccountBalance*](/polymesh-sdk-api-reference/docs-v2/interfaces/accountbalance.md)*›*

▸ **getAccountBalance**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹[AccountBalance](/polymesh-sdk-api-reference/docs-v2/interfaces/accountbalance.md)›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

*Defined in* [*src/Polymesh.ts:273*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L273)

**Parameters:**

| Name       | Type                                                                                                                                                          |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹[AccountBalance](/polymesh-sdk-api-reference/docs-v2/interfaces/accountbalance.md)› |

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

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

*Defined in* [*src/Polymesh.ts:274*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L274)

**Parameters:**

▪ **args**: *object*

| Name      | Type                                                                        |
| --------- | --------------------------------------------------------------------------- |
| `account` | string \| [Account](/polymesh-sdk-api-reference/docs-v2/classes/account.md) |

▪ **callback**: [*SubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)*‹*[*AccountBalance*](/polymesh-sdk-api-reference/docs-v2/interfaces/accountbalance.md)*›*

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

### getCurrentIdentity

▸ **getCurrentIdentity**(): *Promise‹*[*CurrentIdentity*](/polymesh-sdk-api-reference/docs-v2/classes/currentidentity.md) *| null›*

*Defined in* [*src/Polymesh.ts:434*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L434)

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

**Returns:** *Promise‹*[*CurrentIdentity*](/polymesh-sdk-api-reference/docs-v2/classes/currentidentity.md) *| null›*

### getIdentity

▸ **getIdentity**(`args`: object): [*Identity*](/polymesh-sdk-api-reference/docs-v2/classes/identity.md)

*Defined in* [*src/Polymesh.ts:427*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L427)

Create an Identity instance from a DID

**Parameters:**

▪ **args**: *object*

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

**Returns:** [*Identity*](/polymesh-sdk-api-reference/docs-v2/classes/identity.md)

### getLatestBlock

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

*Defined in* [*src/Polymesh.ts:642*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L642)

Retrieve the number of the latest block in the chain

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

### getNetworkProperties

▸ **getNetworkProperties**(): *Promise‹*[*NetworkProperties*](/polymesh-sdk-api-reference/docs-v2/interfaces/networkproperties.md)*›*

*Defined in* [*src/Polymesh.ts:584*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L584)

Retrieve information for the current network

**Returns:** *Promise‹*[*NetworkProperties*](/polymesh-sdk-api-reference/docs-v2/interfaces/networkproperties.md)*›*

### getSecurityToken

▸ **getSecurityToken**(`args`: object): *Promise‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)*›*

*Defined in* [*src/Polymesh.ts:558*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L558)

Retrieve a Security Token

**Parameters:**

▪ **args**: *object*

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

**Returns:** *Promise‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)*›*

### getSecurityTokens

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

*Defined in* [*src/Polymesh.ts:521*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L521)

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*](/polymesh-sdk-api-reference/docs-v2/classes/securitytoken.md)*\[]›*

### getTickerReservation

▸ **getTickerReservation**(`args`: object): *Promise‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v2/classes/tickerreservation.md)*›*

*Defined in* [*src/Polymesh.ts:401*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L401)

Retrieve a Ticker Reservation

**Parameters:**

▪ **args**: *object*

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

**Returns:** *Promise‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v2/classes/tickerreservation.md)*›*

### getTickerReservations

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

*Defined in* [*src/Polymesh.ts:362*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L362)

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

**Parameters:**

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

**Returns:** *Promise‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v2/classes/tickerreservation.md)*\[]›*

### getTransactionFees

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

*Defined in* [*src/Polymesh.ts:469*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L469)

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*](/polymesh-sdk-api-reference/docs-v2/classes/account.md)

*Defined in* [*src/Polymesh.ts:476*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L476)

Get the treasury wallet address

**Returns:** [*Account*](/polymesh-sdk-api-reference/docs-v2/classes/account.md)

### getTreasuryBalance

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

*Defined in* [*src/Polymesh.ts:608*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L608)

Get the Treasury POLYX balance

**`note`** can be subscribed to

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

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

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

**Parameters:**

| Name       | Type                                                                                 |
| ---------- | ------------------------------------------------------------------------------------ |
| `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹BigNumber› |

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

### isIdentityValid

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

*Defined in* [*src/Polymesh.ts:458*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L458)

Return whether the supplied Identity/DID exists

**Parameters:**

▪ **args**: *object*

| Name       | Type                                                                          |
| ---------- | ----------------------------------------------------------------------------- |
| `identity` | [Identity](/polymesh-sdk-api-reference/docs-v2/classes/identity.md) \| string |

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

### isTickerAvailable

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

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

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](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)‹boolean›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

*Defined in* [*src/Polymesh.ts:331*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L331)

**Parameters:**

▪ **args**: *object*

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

▪ **callback**: [*SubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#subcallback)*‹boolean›*

**Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v2/globals.md#unsubcallback)*›*

### onConnectionError

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

*Defined in* [*src/Polymesh.ts:485*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L485)

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:502*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L502)

Handle disconnection

**Parameters:**

▪ **callback**: *function*

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

**Parameters:**

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

**Returns:** *function*

an unsubscribe callback

▸ (): *void*

### registerIdentity

▸ **registerIdentity**(`args`: [RegisterIdentityParams](/polymesh-sdk-api-reference/docs-v2/interfaces/registeridentityparams.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*Identity*](/polymesh-sdk-api-reference/docs-v2/classes/identity.md)*››*

*Defined in* [*src/Polymesh.ts:635*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L635)

Register an Identity

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

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

**Parameters:**

| Name   | Type                                                                                               |
| ------ | -------------------------------------------------------------------------------------------------- |
| `args` | [RegisterIdentityParams](/polymesh-sdk-api-reference/docs-v2/interfaces/registeridentityparams.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*Identity*](/polymesh-sdk-api-reference/docs-v2/classes/identity.md)*››*

### reserveTicker

▸ **reserveTicker**(`args`: [ReserveTickerParams](/polymesh-sdk-api-reference/docs-v2/interfaces/reservetickerparams.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v2/classes/tickerreservation.md)*››*

*Defined in* [*src/Polymesh.ts:321*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L321)

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

**Parameters:**

| Name   | Type                                                                                         |
| ------ | -------------------------------------------------------------------------------------------- |
| `args` | [ReserveTickerParams](/polymesh-sdk-api-reference/docs-v2/interfaces/reservetickerparams.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v2/classes/tickerreservation.md)*››*

### transferPolyX

▸ **transferPolyX**(`args`: [TransferPolyXParams](/polymesh-sdk-api-reference/docs-v2/interfaces/transferpolyxparams.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹void››*

*Defined in* [*src/Polymesh.ts:261*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L261)

Transfer an amount of POLYX to a specified Account

**Parameters:**

| Name   | Type                                                                                         |
| ------ | -------------------------------------------------------------------------------------------- |
| `args` | [TransferPolyXParams](/polymesh-sdk-api-reference/docs-v2/interfaces/transferpolyxparams.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v2/classes/transactionqueue.md)*‹void››*

### `Static` connect

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

*Defined in* [*src/Polymesh.ts:101*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L101)

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

**Parameters:**

| Name     | Type                                                                                              |
| -------- | ------------------------------------------------------------------------------------------------- |
| `params` | [ConnectParamsBase](/polymesh-sdk-api-reference/docs-v2/interfaces/connectparamsbase.md) & object |

**Returns:** *Promise‹*[*Polymesh*](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md)*›*

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

*Defined in* [*src/Polymesh.ts:111*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L111)

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

**Parameters:**

| Name     | Type                                                                                              |
| -------- | ------------------------------------------------------------------------------------------------- |
| `params` | [ConnectParamsBase](/polymesh-sdk-api-reference/docs-v2/interfaces/connectparamsbase.md) & object |

**Returns:** *Promise‹*[*Polymesh*](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md)*›*

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

*Defined in* [*src/Polymesh.ts:125*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L125)

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

**Parameters:**

| Name     | Type                                                                                              |
| -------- | ------------------------------------------------------------------------------------------------- |
| `params` | [ConnectParamsBase](/polymesh-sdk-api-reference/docs-v2/interfaces/connectparamsbase.md) & object |

**Returns:** *Promise‹*[*Polymesh*](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md)*›*

▸ **connect**(`params`: [ConnectParamsBase](/polymesh-sdk-api-reference/docs-v2/interfaces/connectparamsbase.md)): *Promise‹*[*Polymesh*](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md)*›*

*Defined in* [*src/Polymesh.ts:134*](https://github.com/PolymathNetwork/polymesh-sdk/blob/5b409784/src/Polymesh.ts#L134)

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

**Parameters:**

| Name     | Type                                                                                     |
| -------- | ---------------------------------------------------------------------------------------- |
| `params` | [ConnectParamsBase](/polymesh-sdk-api-reference/docs-v2/interfaces/connectparamsbase.md) |

**Returns:** *Promise‹*[*Polymesh*](/polymesh-sdk-api-reference/docs-v2/classes/polymesh.md)*›*