Orderly SDKs / Modules / @orderly.network/core / OrderlyKeyStore

​

Interface: OrderlyKeyStore

@orderly.network/core.OrderlyKeyStore

​

Implemented by

• BaseKeyStore
• BaseKeyStore
• MockKeyStore
• MockKeyStore

​

Table of contents

​

Properties

• cleanAllKey
• cleanKey
• generateKey
• getAccountId
• getAddress
• getOrderlyKey
• setAccountId
• setAddress
• 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

---

​

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

---

​

generateKey

• generateKey: () => OrderlyKeyPair

​

Type declaration

▸ (): OrderlyKeyPair

Returns

OrderlyKeyPair

​

Defined in

packages/core/src/keyStore.ts:9

---

​

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

---

​

getAddress

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

​

Type declaration

▸ (): undefined | null | string

Returns

undefined | null | string

​

Defined in

packages/core/src/keyStore.ts:7

---

​

getOrderlyKey

• getOrderlyKey: (address?: string) => null | OrderlyKeyPair

​

Type declaration

▸ (address?): null | OrderlyKeyPair

Parameters

Name	Type
address?	string

Returns

null | OrderlyKeyPair

​

Defined in

packages/core/src/keyStore.ts:4

---

​

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

---

​

setAddress

• setAddress: (address: string) => void

​

Type declaration

▸ (address): void

Parameters

Name	Type
address	string

Returns

void

​

Defined in

packages/core/src/keyStore.ts:8

---

​

setKey

• setKey: (orderlyKey: string, secretKey: OrderlyKeyPair) => void

​

Type declaration

▸ (orderlyKey, secretKey): void

Parameters

Name	Type
orderlyKey	string
secretKey	OrderlyKeyPair

Returns

void

​

Defined in

packages/core/src/keyStore.ts:12