External module "src/common"

Index

Functions

Functions

getNetwork

getNetwork(): V1Network

- Defined in drone/src/modules/core/src/common.ts:32
Get the global Bitcoin network. Used for v1 only.

deprecated

Returns V1Network

getRmgNetwork

getRmgNetwork(): V1RmgNetwork

- Defined in drone/src/modules/core/src/common.ts:41
Get the global RMG network. Used for v1 only.

deprecated

Returns V1RmgNetwork

setNetwork

setNetwork(network: V1Network): void

- Defined in drone/src/modules/core/src/common.ts:18
Set the global Bitcoin network. Used for v1 only.

deprecated

Parameters
- network: V1Network
Returns void

setRmgNetwork

setRmgNetwork(network: V1RmgNetwork): void

- Defined in drone/src/modules/core/src/common.ts:50
Set the global RMG network. Used for v1 only.

deprecated

Parameters
- network: V1RmgNetwork
Returns void

validateParams

validateParams(params: object, expectedParams: string[], optionalParams?: string[], optionalCallback?: NodeCallback<any>): boolean

- Defined in drone/src/modules/core/src/common.ts:65
Helper function to validate the input parameters to an SDK method. Only validates for strings - if parameter is different, check that manually

deprecated

Parameters
- params: object
  
  dictionary of parameter key-value pairs
- expectedParams: string[]
  
  list of expected string parameters
- Default value optionalParams: string[] = []
  
  list of optional string parameters
- Optional optionalCallback: NodeCallback<any>
  
  if callback provided, must be a function
Returns boolean

true if validated, throws with reason otherwise

Generated using TypeDoc