Class TokenStorageService

Implements

IStorageService

Index

Constructors

Methods

delete get getAllKeys getKeyPrefixByChainIdAndWallet init put

Basic Methods

clearByWallet countByWallet getAllByWallet getAllKeysByWallet getFirstByWallet getKeyByItem getKeyPrefixByItem isValidItem

Extended Methods

flushDefault getDefault

Constructors

constructor

new TokenStorageService(): TokenStorageService
Returns TokenStorageService
- Defined in ../../src/services/storage/TokenStorageService.ts:46

Methods

delete

delete(key): Promise<boolean>
Parameters
- key: string
  wallet address is the key
Returns Promise<boolean>
Implementation of IStorageService.delete
- Defined in ../../src/services/storage/TokenStorageService.ts:628

get

get(key): Promise<null | TokenEntityItem>
get item
Parameters
- key: string
  {string}
Returns Promise<null | TokenEntityItem>
Implementation of IStorageService.get
- Defined in ../../src/services/storage/TokenStorageService.ts:298

getAllKeys

getAllKeys(query?, maxCount?): Promise<string[]>
get all keys
Parameters
- Optional query: string
  {string}
- Optional maxCount: number
  {number}
Returns Promise<string[]>
Implementation of IStorageService.getAllKeys
- Defined in ../../src/services/storage/TokenStorageService.ts:332

getKeyPrefixByChainIdAndWallet

getKeyPrefixByChainIdAndWallet(chainId, wallet): null | string
get the prefix of a storage key by chainId and wallet
Parameters
- chainId: number
  {number}
- wallet: string
  {string}
Returns null | string
- Defined in ../../src/services/storage/TokenStorageService.ts:279

`Protected` init

init(): Promise<unknown>
Returns Promise<unknown>
- Defined in ../../src/services/storage/TokenStorageService.ts:50

put

put(key, value): Promise<boolean>
put a value by key
Parameters
- key: string
  {string}
- value: TokenEntityItem
  {TokenEntityItem}
Returns Promise<boolean>
Implementation of IStorageService.put
- Defined in ../../src/services/storage/TokenStorageService.ts:362

Basic Methods

clearByWallet

clearByWallet(wallet): Promise<boolean>
delete all items by wallet address
Parameters
- wallet: string
  {string} wallet address
Returns Promise<boolean>
- Defined in ../../src/services/storage/TokenStorageService.ts:576

countByWallet

countByWallet(wallet, query?): Promise<number>
Retrieves the number of records matching the given wallet and query in a store.
Parameters
- wallet: string
  {string} wallet address
- Optional query: string
  {string} query string
Returns Promise<number>
- Defined in ../../src/services/storage/TokenStorageService.ts:608

getAllByWallet

getAllByWallet(wallet, query?, maxCount?): Promise<null | TokenEntityItem[]>
query all items by wallet address
Parameters
- wallet: string
  {string} wallet address
- Optional query: string
  {string} query string
- Optional maxCount: number
  {number} maximum limit number
Returns Promise<null | TokenEntityItem[]>
- Defined in ../../src/services/storage/TokenStorageService.ts:506

getAllKeysByWallet

getAllKeysByWallet(wallet, query?, maxCount?): Promise<null | string[]>
get all keys by wallet address
Parameters
- wallet: string
  {string} wallet address
- Optional query: string
  {string} query string
- Optional maxCount: number
  {number} maximum limit number
Returns Promise<null | string[]>
- Defined in ../../src/services/storage/TokenStorageService.ts:432

getFirstByWallet

getFirstByWallet(wallet): Promise<null | TokenEntityItem>
get the first item by wallet address
Parameters
- wallet: string
  {string} wallet address
Returns Promise<null | TokenEntityItem>
- Defined in ../../src/services/storage/TokenStorageService.ts:402

getKeyByItem

getKeyByItem(item): null | string
get storage key by item object
Parameters
- item: TokenEntityItem
  {TokenEntityItem} TokenEntityItem object
Returns null | string
Implementation of IStorageService.getKeyByItem
- Defined in ../../src/services/storage/TokenStorageService.ts:233

getKeyPrefixByItem

getKeyPrefixByItem(item): null | string
get the prefix of a storage key by item object
Parameters
- item: TokenEntityItem
  {TokenEntityItem} TokenEntityItem object
Returns null | string
- Defined in ../../src/services/storage/TokenStorageService.ts:258

isValidItem

isValidItem(item, callback?): boolean
Check if the input object is a valid item
Parameters
- item: any
  {any} the object to be checked
- Optional callback: CallbackModels
  {CallbackModels} a callback function address to receive error information
Returns boolean
Implementation of IStorageService.isValidItem
- Defined in ../../src/services/storage/TokenStorageService.ts:96

Extended Methods

flushDefault

flushDefault(wallet): Promise<boolean>
Get the default data by the this.getDefault() method and flush the data into the database
Parameters
- wallet: string
  {string} wallet address
Returns Promise<boolean>
Remark
Data is stored in a key-value structure. If a key with the same name already exists, the original data will be overwritten instead of inserting a new record.
- Defined in ../../src/services/storage/TokenStorageService.ts:166

getDefault

getDefault(wallet): TokenEntityItem[]
Get the default token list by wallet address
Parameters
- wallet: string
  {string} wallet address
Returns TokenEntityItem[]
- Defined in ../../src/services/storage/TokenStorageService.ts:116