Class: SMTBeacon ​
Defined in: packages/method/src/core/beacon/smt-beacon.ts:14
TODO: Finish implementation Implements SMTBeacon. SMTBeacon
Extends ​
Constructors ​
Constructor ​
new SMTBeacon(
service,signals,sidecar,bitcoin?):SMTBeacon
Defined in: packages/method/src/core/beacon/smt-beacon.ts:21
Creates an instance of SingletonBeacon.
Parameters ​
service ​
The Beacon service.
signals ​
The SingletonBeacon sidecar data.
sidecar ​
The sidecar data.
bitcoin? ​
Returns ​
SMTBeacon
Overrides ​
Properties ​
bitcoin ​
bitcoin:
BitcoinNetworkConnection
Defined in: packages/method/src/core/beacon/interfaces.ts:96
The Bitcoin network connection associated with this Beacon service.
Inherited from ​
service ​
service:
BeaconService
Defined in: packages/method/src/core/beacon/interfaces.ts:80
The Beacon service object parsed from the DID Document.
Inherited from ​
sidecar ​
sidecar:
SidecarData
Defined in: packages/method/src/core/beacon/interfaces.ts:91
The sidecar data associated with this Beacon service. TODO: Make this more specific to Beacon type.
Inherited from ​
signals ​
signals:
BeaconSignal[]
Defined in: packages/method/src/core/beacon/interfaces.ts:85
The array of Beacon Signals associated with this Beacon service.
Inherited from ​
Methods ​
broadcastSignal() ​
broadcastSignal(
updateHash):Promise<string>
Defined in: packages/method/src/core/beacon/smt-beacon.ts:66
Broadcast a SMTBeacon signal.
Parameters ​
updateHash ​
string
The hash of the BTCR2 update to broadcast.
Returns ​
Promise<string>
The result of the broadcast.
Throws ​
if the broadcast fails.
Overrides ​
AggregateBeacon.broadcastSignal
generateSignal() ​
generateSignal(
updateHash):BeaconSignal
Defined in: packages/method/src/core/beacon/smt-beacon.ts:46
TODO: Figure out if this is necessary or not.
Parameters ​
updateHash ​
string
The hash of the BTCR2 update to generate the signal for.
Returns ​
The generated signal.
Throws ​
if the signal is invalid.
Overrides ​
AggregateBeacon.generateSignal
processSignals() ​
processSignals():
Promise<[BTCR2SignedUpdate,BlockMetadata][]>
Defined in: packages/method/src/core/beacon/smt-beacon.ts:55
Process SMTBeacon signals.
Returns ​
Promise<[BTCR2SignedUpdate, BlockMetadata][]>
The processed signed update or undefined.
Throws ​
if the signal processing fails.
Overrides ​
AggregateBeacon.processSignals
establish() ​
staticestablish(service,signals,sidecar):SMTBeacon
Defined in: packages/method/src/core/beacon/smt-beacon.ts:36
Static, convenience method for establishing a SMTBeacon object.
Parameters ​
service ​
The Beacon service.
signals ​
sidecar ​
The sidecar data.
Returns ​
SMTBeacon
The Singleton Beacon.