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

# Orderly network core.OrderlyKeyStore

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

# Interface: OrderlyKeyStore

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

## Implemented by

* [`BaseKeyStore`](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore)
* [`BaseKeyStore`](/sdks/tech-doc/classes/orderly_network_core.BaseKeyStore)
* [`MockKeyStore`](/sdks/tech-doc/classes/orderly_network_core.MockKeyStore)
* [`MockKeyStore`](/sdks/tech-doc/classes/orderly_network_core.MockKeyStore)

## Table of contents

### Properties

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

## Properties

### cleanAllKey

• **cleanAllKey**: (`address`: `string`) => `void`

#### Type declaration

▸ (`address`): `void`

##### Parameters

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

##### Returns

`void`

#### Defined in

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

***

### cleanKey

• **cleanKey**: (`address`: `string`, `key`: `string`) => `void`

#### Type declaration

▸ (`address`, `key`): `void`

##### Parameters

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

##### Returns

`void`

#### Defined in

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

***

### generateKey

• **generateKey**: () => [`OrderlyKeyPair`](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyPair)

#### Type declaration

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

##### Returns

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

#### Defined in

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

***

### getAccountId

• **getAccountId**: (`address`: `string`) => `undefined` | `null` | `string`

#### Type declaration

▸ (`address`): `undefined` | `null` | `string`

##### Parameters

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

##### Returns

`undefined` | `null` | `string`

#### Defined in

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

***

### getAddress

• **getAddress**: () => `undefined` | `null` | `string`

#### Type declaration

▸ (): `undefined` | `null` | `string`

##### Returns

`undefined` | `null` | `string`

#### Defined in

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

***

### getOrderlyKey

• **getOrderlyKey**: (`address?`: `string`) => `null` | [`OrderlyKeyPair`](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyPair)

#### Type declaration

▸ (`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)

#### Defined in

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

***

### setAccountId

• **setAccountId**: (`address`: `string`, `accountId`: `string`) => `void`

#### Type declaration

▸ (`address`, `accountId`): `void`

##### Parameters

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

##### Returns

`void`

#### Defined in

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

***

### setAddress

• **setAddress**: (`address`: `string`) => `void`

#### Type declaration

▸ (`address`): `void`

##### Parameters

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

##### Returns

`void`

#### Defined in

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

***

### setKey

• **setKey**: (`orderlyKey`: `string`, `secretKey`: [`OrderlyKeyPair`](/sdks/tech-doc/interfaces/orderly_network_core.OrderlyKeyPair)) => `void`

#### Type declaration

▸ (`orderlyKey`, `secretKey`): `void`

##### Parameters

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

##### Returns

`void`

#### Defined in

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