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

​

Class: BaseKeyStore

@orderly.network/core.BaseKeyStore

​

Hierarchy

• BaseKeyStore

  ↳ LocalStorageStore

  ↳ LocalStorageStore

​

Implements

• OrderlyKeyStore

​

Table of contents

​

Constructors

• constructor

​

Properties

• networkId

​

Accessors

• keyPrefix

​

Methods

• cleanAllKey
• cleanKey
• generateKey
• getAccountId
• getAddress
• getOrderlyKey
• setAccountId
• setAddress
• setKey

​

Constructors

​

constructor

• new BaseKeyStore(networkId?)

​

Parameters

Name	Type	Default value
networkId	string	"testnet"

​

Defined in

packages/core/src/keyStore.ts:16

​

Properties

​

networkId

• Private Readonly networkId: string = "testnet"

​

Defined in

packages/core/src/keyStore.ts:17

​

Accessors

​

keyPrefix

• Protected get keyPrefix(): string

​

Returns

string

​

Defined in

packages/core/src/keyStore.ts:29

​

Methods

​

cleanAllKey

▸ Abstract cleanAllKey(address): void

​

Parameters

Name	Type
address	string

​

Returns

void

​

Implementation of

OrderlyKeyStore.cleanAllKey

​

Defined in

packages/core/src/keyStore.ts:26

---

​

cleanKey

▸ Abstract cleanKey(address, key): void

​

Parameters

Name	Type
address	string
key	string

​

Returns

void

​

Implementation of

OrderlyKeyStore.cleanKey

​

Defined in

packages/core/src/keyStore.ts:27

---

​

generateKey

▸ Abstract generateKey(): OrderlyKeyPair

​

Returns

OrderlyKeyPair

​

Implementation of

OrderlyKeyStore.generateKey

​

Defined in

packages/core/src/keyStore.ts:24

---

​

getAccountId

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

​

Parameters

Name	Type
address	string

​

Returns

undefined | null | string

​

Implementation of

OrderlyKeyStore.getAccountId

​

Defined in

packages/core/src/keyStore.ts:20

---

​

getAddress

▸ Abstract getAddress(): undefined | null | string

​

Returns

undefined | null | string

​

Implementation of

OrderlyKeyStore.getAddress

​

Defined in

packages/core/src/keyStore.ts:22

---

​

getOrderlyKey

▸ Abstract getOrderlyKey(address?): null | OrderlyKeyPair

​

Parameters

Name	Type
address?	string

​

Returns

null | OrderlyKeyPair

​

Implementation of

OrderlyKeyStore.getOrderlyKey

​

Defined in

packages/core/src/keyStore.ts:19

---

​

setAccountId

▸ Abstract setAccountId(address, accountId): void

​

Parameters

Name	Type
address	string
accountId	string

​

Returns

void

​

Implementation of

OrderlyKeyStore.setAccountId

​

Defined in

packages/core/src/keyStore.ts:21

---

​

setAddress

▸ Abstract setAddress(address): void

​

Parameters

Name	Type
address	string

​

Returns

void

​

Implementation of

OrderlyKeyStore.setAddress

​

Defined in

packages/core/src/keyStore.ts:23

---

​

setKey

▸ Abstract setKey(orderlyKey, secretKey): void

​

Parameters

Name	Type
orderlyKey	string
secretKey	OrderlyKeyPair

​

Returns

void

​

Implementation of

OrderlyKeyStore.setKey

​

Defined in

packages/core/src/keyStore.ts:25