> ## Documentation Index
> Fetch the complete documentation index at: https://orderly.network/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Orderly network core.BaseKeyStore

[Orderly SDKs](/sdks/tech-doc/README) / [Modules](/sdks/tech-doc/modules) / [@orderly.network/core](/sdks/tech-doc/modules/orderly_network_core) / BaseKeyStore

# Class: BaseKeyStore

[@orderly.network/core](/sdks/tech-doc/modules/orderly_network_core).BaseKeyStore

## Hierarchy

* **`BaseKeyStore`**

  ↳ [`LocalStorageStore`](/sdks/tech-doc/classes/orderly_network_core.LocalStorageStore)

  ↳ [`LocalStorageStore`](/sdks/tech-doc/classes/orderly_network_core.LocalStorageStore)

## Implements

* [`OrderlyKeyStore`](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore)

## Table of contents

### Constructors

* [constructor](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#constructor)

### Properties

* [networkId](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#networkid)

### Accessors

* [keyPrefix](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#keyprefix)

### Methods

* [cleanAllKey](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#cleanallkey)
* [cleanKey](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#cleankey)
* [generateKey](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#generatekey)
* [getAccountId](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#getaccountid)
* [getAddress](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#getaddress)
* [getOrderlyKey](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#getorderlykey)
* [setAccountId](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#setaccountid)
* [setAddress](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#setaddress)
* [setKey](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore#setkey)

## Constructors

### constructor

• **new BaseKeyStore**(`networkId?`)

#### Parameters

| Name        | Type     | Default value |
| :---------- | :------- | :------------ |
| `networkId` | `string` | `"testnet"`   |

#### Defined in

[packages/core/src/keyStore.ts:16](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L16)

## Properties

### networkId

• `Private` `Readonly` **networkId**: `string` = `"testnet"`

#### Defined in

[packages/core/src/keyStore.ts:17](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L17)

## Accessors

### keyPrefix

• `Protected` `get` **keyPrefix**(): `string`

#### Returns

`string`

#### Defined in

[packages/core/src/keyStore.ts:29](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L29)

## Methods

### cleanAllKey

▸ `Abstract` **cleanAllKey**(`address`): `void`

#### Parameters

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

#### Returns

`void`

#### Implementation of

[OrderlyKeyStore](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore).[cleanAllKey](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore#cleanallkey)

#### Defined in

[packages/core/src/keyStore.ts:26](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L26)

***

### cleanKey

▸ `Abstract` **cleanKey**(`address`, `key`): `void`

#### Parameters

| Name      | Type     |
| :-------- | :------- |
| `address` | `string` |
| `key`     | `string` |

#### Returns

`void`

#### Implementation of

[OrderlyKeyStore](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore).[cleanKey](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore#cleankey)

#### Defined in

[packages/core/src/keyStore.ts:27](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L27)

***

### generateKey

▸ `Abstract` **generateKey**(): [`OrderlyKeyPair`](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyPair)

#### Returns

[`OrderlyKeyPair`](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyPair)

#### Implementation of

[OrderlyKeyStore](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore).[generateKey](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore#generatekey)

#### Defined in

[packages/core/src/keyStore.ts:24](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L24)

***

### getAccountId

▸ `Abstract` **getAccountId**(`address`): `undefined` | `null` | `string`

#### Parameters

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

#### Returns

`undefined` | `null` | `string`

#### Implementation of

[OrderlyKeyStore](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore).[getAccountId](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore#getaccountid)

#### Defined in

[packages/core/src/keyStore.ts:20](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L20)

***

### getAddress

▸ `Abstract` **getAddress**(): `undefined` | `null` | `string`

#### Returns

`undefined` | `null` | `string`

#### Implementation of

[OrderlyKeyStore](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore).[getAddress](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore#getaddress)

#### Defined in

[packages/core/src/keyStore.ts:22](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L22)

***

### getOrderlyKey

▸ `Abstract` **getOrderlyKey**(`address?`): `null` | [`OrderlyKeyPair`](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyPair)

#### Parameters

| Name       | Type     |
| :--------- | :------- |
| `address?` | `string` |

#### Returns

`null` | [`OrderlyKeyPair`](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyPair)

#### Implementation of

[OrderlyKeyStore](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore).[getOrderlyKey](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore#getorderlykey)

#### Defined in

[packages/core/src/keyStore.ts:19](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L19)

***

### setAccountId

▸ `Abstract` **setAccountId**(`address`, `accountId`): `void`

#### Parameters

| Name        | Type     |
| :---------- | :------- |
| `address`   | `string` |
| `accountId` | `string` |

#### Returns

`void`

#### Implementation of

[OrderlyKeyStore](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore).[setAccountId](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore#setaccountid)

#### Defined in

[packages/core/src/keyStore.ts:21](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L21)

***

### setAddress

▸ `Abstract` **setAddress**(`address`): `void`

#### Parameters

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

#### Returns

`void`

#### Implementation of

[OrderlyKeyStore](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore).[setAddress](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore#setaddress)

#### Defined in

[packages/core/src/keyStore.ts:23](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L23)

***

### setKey

▸ `Abstract` **setKey**(`orderlyKey`, `secretKey`): `void`

#### Parameters

| Name         | Type                                                                              |
| :----------- | :-------------------------------------------------------------------------------- |
| `orderlyKey` | `string`                                                                          |
| `secretKey`  | [`OrderlyKeyPair`](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyPair) |

#### Returns

`void`

#### Implementation of

[OrderlyKeyStore](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore).[setKey](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyStore#setkey)

#### Defined in

[packages/core/src/keyStore.ts:25](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/core/src/keyStore.ts#L25)