DID BTCR2 JS

Appearance

Class: SMTBeacon ​

Defined in: packages/method/src/core/beacon/smt-beacon.ts:16

Implements SMTBeacon. SMTBeacon

Extends ​

Constructors ​

Constructor ​

new SMTBeacon(service): SMTBeacon

Defined in: packages/method/src/core/beacon/smt-beacon.ts:21

Creates an instance of SMTBeacon.

Parameters ​

service ​

BeaconService

The Beacon service.

Returns ​

SMTBeacon

Overrides ​

Beacon.constructor

Properties ​

service ​

readonly service: BeaconService

Defined in: packages/method/src/core/beacon/beacon.ts:27

The Beacon service configuration parsed from the DID Document.

Inherited from ​

Beacon.service

Methods ​

broadcastSignal() ​

broadcastSignal(signedUpdate, secretKey, bitcoin): Promise<SignedBTCR2Update>

Defined in: packages/method/src/core/beacon/smt-beacon.ts:47

Broadcast CAS Beacon signal to the Bitcoin network.

Parameters ​

signedUpdate ​

SignedBTCR2Update

The signed BTCR2 update to broadcast.

secretKey ​

Bytes

The secret key for signing the Bitcoin transaction.

bitcoin ​

BitcoinConnection

The Bitcoin network connection.

Returns ​

Promise<SignedBTCR2Update>

The signed update that was broadcasted.

Throws ​

if broadcasting fails.

Overrides ​

Beacon.broadcastSignal

processSignals() ​

processSignals(signals, sidecar): BeaconProcessResult

Defined in: packages/method/src/core/beacon/smt-beacon.ts:32

Implements 7.2.e.1 Process SMT Beacon.

Parameters ​

signals ​

BeaconSignal[]

The array of Beacon Signals to process.

sidecar ​

SidecarData

The sidecar data associated with the SMT Beacon.

Returns ​

BeaconProcessResult

The processed signals.

Throws ​

if processing fails.

Overrides ​

Beacon.processSignals