Class RPCBase

Hierarchy

RPCBase
- GridcoinRPC

Index

Constructors

Properties

Methods

call callPreservingKeys filterParameters

Constructors

constructor

new RPCBase(config: IParameters, rpc?: IJsonRPC): RPCBase
Creates an instance of GridcoinRPC

Memberof
GridcoinRPC
Parameters
- config: IParameters
- Optional rpc: IJsonRPC
  
  Dependency injection for the client class
Returns RPCBase
- Defined in RPCBase.ts:46

Properties

`Readonly` client

client: IJsonRPC

Methods

`Protected` call

call<T>(command: string, ...parameters: callParameters[]): Promise<T>
Protected
Send command to the rpc server, get response Transform response field to the camelcase

Returns

Throws

Memberof
RPCBase
Type Parameters
- T
Parameters
- command: string
- Rest ...parameters: callParameters[]
Returns Promise<T>
- Defined in RPCBase.ts:66

`Protected` callPreservingKeys

callPreservingKeys<T>(dataKeyPaths: readonly string[], command: string, ...parameters: callParameters[]): Promise<T>
Protected
Same as call(), for responses that use data (addresses, CPIDs, project names, hashes) as object keys. Keys of the objects at dataKeyPaths are returned verbatim; see camelCaseKeys for the path syntax.

Returns

Throws

Memberof
RPCBase
Type Parameters
- T
Parameters
- dataKeyPaths: readonly string[]
- command: string
- Rest ...parameters: callParameters[]
Returns Promise<T>
- Defined in RPCBase.ts:87

`Private` filterParameters

filterParameters(parameters: callParameters[]): filteredCallParameters[]
Private
Normalise undefined parameters for a positional JSON-RPC call

Trailing undefined parameters are dropped. An undefined parameter followed by a defined one is sent as null, so the parameters after it keep their positions; the daemon treats null as "not provided" for optional arguments.

Returns

Memberof
RPCBase
Parameters
- parameters: callParameters[]
Returns filteredCallParameters[]
- Defined in RPCBase.ts:115

Generated using TypeDoc