Class CacheManager

Hierarchy

CacheManager

Constructors

constructor

new CacheManager(indexer, publicKey, chainCode, infos?, __namedParameters, masterPublicKey?): CacheManager
Parameters
- indexer: indexer.Indexer
- publicKey: string
- chainCode: string
- infos: LockScriptMappingInfo[] = ...
- __namedParameters: {
      TransactionCollector: typeof indexer.TransactionCollector;
      livenessCheckIntervalSeconds?: number;
      logger?: ((level, message) => void);
      pollIntervalSeconds?: number;
      rpc?: RPC;
  }
  - TransactionCollector: typeof indexer.TransactionCollector
  - Optional livenessCheckIntervalSeconds?: number
  - Optional logger?: ((level, message) => void)
    - (level, message): void
      
      Parameters
      
      level: string
      
      message: string
      
      Returns void
  - Optional pollIntervalSeconds?: number
  - Optional rpc?: RPC
- Optional masterPublicKey: string
Returns CacheManager
- Defined in index.ts:547

Properties

`Private` cache

cache: Cache

`Private` isRunning

isRunning: boolean

`Private` livenessCheckIntervalSeconds

livenessCheckIntervalSeconds: number

`Private` logger

logger: ((level, message) => void)

Type declaration

- (level, message): void
- Parameters
  - level: string
  - message: string
  Returns void

`Private` pollIntervalSeconds

pollIntervalSeconds: number

Methods

getChangeKeys

getChangeKeys(): PublicKeyInfo[]
Returns PublicKeyInfo[]
- Defined in index.ts:729

getLiveCellsCache

getLiveCellsCache(): Map<string, Cell>
Returns Map<string, Cell>
- Defined in index.ts:709

getMasterPublicKeyInfo

getMasterPublicKeyInfo(): undefined | PublicKeyInfo
Returns undefined | PublicKeyInfo
- Defined in index.ts:713

getNextChangePublicKeyInfo

getNextChangePublicKeyInfo(): PublicKeyInfo
Returns PublicKeyInfo
- Defined in index.ts:721

getNextReceivingPublicKeyInfo

getNextReceivingPublicKeyInfo(): PublicKeyInfo
Returns PublicKeyInfo
- Defined in index.ts:717

getReceivingKeys

getReceivingKeys(): PublicKeyInfo[]
Returns PublicKeyInfo[]
- Defined in index.ts:725

loop

loop(): Promise<void>
Returns Promise<void>
- Defined in index.ts:676

running

running(): boolean
Returns boolean
- Defined in index.ts:662

scheduleLoop

scheduleLoop(): void
Returns void
- Defined in index.ts:666

start

start(): void
Returns void
- Defined in index.ts:694

startForever

startForever(): void
Returns void
- Defined in index.ts:699

stop

stop(): void
Returns void
- Defined in index.ts:672

`Static` fromMnemonic

fromMnemonic(indexer, mnemonic, infos?, options): CacheManager
Parameters
- indexer: indexer.Indexer
- mnemonic: string
- infos: LockScriptMappingInfo[] = ...
- options: {
      TransactionCollector: typeof indexer.TransactionCollector;
      livenessCheckIntervalSeconds?: number;
      logger?: ((level, message) => void);
      needMasterPublicKey?: boolean;
      pollIntervalSeconds?: number;
      rpc?: RPC;
  }
  - TransactionCollector: typeof indexer.TransactionCollector
  - Optional livenessCheckIntervalSeconds?: number
  - Optional logger?: ((level, message) => void)
    - (level, message): void
      
      Parameters
      
      level: string
      
      message: string
      
      Returns void
  - Optional needMasterPublicKey?: boolean
  - Optional pollIntervalSeconds?: number
  - Optional rpc?: RPC
Returns CacheManager
- Defined in index.ts:628

`Static` loadFromKeystore

loadFromKeystore(indexer, path, password, infos?, options): CacheManager
Load from keystore, if needMasterPublicKey set to true or origin = "ckb-cli", will enable masterPublicKey
Parameters
- indexer: indexer.Indexer
- path: string
- password: string
- infos: LockScriptMappingInfo[] = ...
- options: {
      TransactionCollector: typeof indexer.TransactionCollector;
      livenessCheckIntervalSeconds?: number;
      logger?: ((level, message) => void);
      needMasterPublicKey?: boolean;
      pollIntervalSeconds?: number;
      rpc?: RPC;
  }
  - TransactionCollector: typeof indexer.TransactionCollector
  - Optional livenessCheckIntervalSeconds?: number
  - Optional logger?: ((level, message) => void)
    - (level, message): void
      
      Parameters
      
      level: string
      
      message: string
      
      Returns void
  - Optional needMasterPublicKey?: boolean
  - Optional pollIntervalSeconds?: number
  - Optional rpc?: RPC
Returns CacheManager
- Defined in index.ts:593

Class CacheManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

indexer: indexer.Indexer

publicKey: string

chainCode: string

infos: LockScriptMappingInfo[] = ...

__namedParameters: { TransactionCollector: typeof indexer.TransactionCollector; livenessCheckIntervalSeconds?: number; logger?: ((level, message) => void); pollIntervalSeconds?: number; rpc?: RPC; }

TransactionCollector: typeof indexer.TransactionCollector

Optional livenessCheckIntervalSeconds?: number

Optional logger?: ((level, message) => void)

Parameters

level: string

message: string

Returns void

Optional pollIntervalSeconds?: number

Optional rpc?: RPC

Optional masterPublicKey: string

Returns CacheManager

Properties

Private cache

Private isRunning

Private livenessCheckIntervalSeconds

Private logger

Type declaration

Parameters

level: string

message: string

Returns void

Private pollIntervalSeconds

Methods

getChangeKeys

Returns PublicKeyInfo[]

getLiveCellsCache

Returns Map<string, Cell>

getMasterPublicKeyInfo

Returns undefined | PublicKeyInfo

getNextChangePublicKeyInfo

Returns PublicKeyInfo

getNextReceivingPublicKeyInfo

Returns PublicKeyInfo

getReceivingKeys

Returns PublicKeyInfo[]

loop

Returns Promise<void>

running

Returns boolean

scheduleLoop

Returns void

start

Returns void

startForever

Returns void

stop

Returns void

Static fromMnemonic

Parameters

indexer: indexer.Indexer

mnemonic: string

infos: LockScriptMappingInfo[] = ...

options: { TransactionCollector: typeof indexer.TransactionCollector; livenessCheckIntervalSeconds?: number; logger?: ((level, message) => void); needMasterPublicKey?: boolean; pollIntervalSeconds?: number; rpc?: RPC; }

TransactionCollector: typeof indexer.TransactionCollector

Optional livenessCheckIntervalSeconds?: number

Optional logger?: ((level, message) => void)

Parameters

level: string

message: string

Returns void

Optional needMasterPublicKey?: boolean

Optional pollIntervalSeconds?: number

Optional rpc?: RPC

Returns CacheManager

Static loadFromKeystore

Parameters

__namedParameters: {
TransactionCollector: typeof indexer.TransactionCollector;
livenessCheckIntervalSeconds?: number;
logger?: ((level, message) => void);
pollIntervalSeconds?: number;
rpc?: RPC;
}

`Optional` livenessCheckIntervalSeconds?: number

`Optional` logger?: ((level, message) => void)

`Optional` pollIntervalSeconds?: number

`Optional` rpc?: RPC

`Optional` masterPublicKey: string

`Private` cache

`Private` isRunning

`Private` livenessCheckIntervalSeconds

`Private` logger

`Private` pollIntervalSeconds

`Static` fromMnemonic

options: {
TransactionCollector: typeof indexer.TransactionCollector;
livenessCheckIntervalSeconds?: number;
logger?: ((level, message) => void);
needMasterPublicKey?: boolean;
pollIntervalSeconds?: number;
rpc?: RPC;
}

`Optional` livenessCheckIntervalSeconds?: number

`Optional` logger?: ((level, message) => void)

`Optional` needMasterPublicKey?: boolean

`Optional` pollIntervalSeconds?: number

`Optional` rpc?: RPC

`Static` loadFromKeystore

options: {
TransactionCollector: typeof indexer.TransactionCollector;
livenessCheckIntervalSeconds?: number;
logger?: ((level, message) => void);
needMasterPublicKey?: boolean;
pollIntervalSeconds?: number;
rpc?: RPC;
}

`Optional` livenessCheckIntervalSeconds?: number

`Optional` logger?: ((level, message) => void)

`Optional` needMasterPublicKey?: boolean

`Optional` pollIntervalSeconds?: number

`Optional` rpc?: RPC