UNPKG

did-btcr2-js

Version:

Monorepo for did:btcr2 js/ts implementation and supporting packages.

github.com/dcdpr/did-btcr2-js

dcdpr/did-btcr2-js

131 lines (66 loc) • 3.15 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
[**@did-btc1/method**](../README.md) *** [@did-btc1/method](../globals.md) / IBeacon # Interface: IBeacon Defined in: [packages/method/src/interfaces/ibeacon.ts:12](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/interfaces/ibeacon.ts#L12) Beacon interface IBeacon ## Properties ### id &gt; **id**: `string` Defined in: [packages/method/src/interfaces/ibeacon.ts:17](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/interfaces/ibeacon.ts#L17) A unique identifier for the Beacon *** ### service &gt; **service**: [`BeaconService`](BeaconService.md) Defined in: [packages/method/src/interfaces/ibeacon.ts:35](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/interfaces/ibeacon.ts#L35) Returns the Beacon Service object *** ### serviceEndpoint &gt; **serviceEndpoint**: `DidServiceEndpoint` Defined in: [packages/method/src/interfaces/ibeacon.ts:29](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/interfaces/ibeacon.ts#L29) The service endpoint of the Beacon *** ### type &gt; **type**: `string` Defined in: [packages/method/src/interfaces/ibeacon.ts:23](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/interfaces/ibeacon.ts#L23) The type of the Beacon ## Methods ### broadcastSignal() &gt; **broadcastSignal**(`didUpdatePayload`): `Promise`\<[`SignalsMetadata`](../type-aliases/SignalsMetadata.md)\&gt; Defined in: [packages/method/src/interfaces/ibeacon.ts:58](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/interfaces/ibeacon.ts#L58) Broadcasts a signal. #### Parameters ##### didUpdatePayload `DidUpdatePayload` The DID update payload. #### Returns `Promise`\<[`SignalsMetadata`](../type-aliases/SignalsMetadata.md)\&gt; The signal metadata. *** ### generateSignal() &gt; **generateSignal**(`didUpdatePayload`): [`BeaconSignal`](BeaconSignal.md) Defined in: [packages/method/src/interfaces/ibeacon.ts:42](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/interfaces/ibeacon.ts#L42) Generates a Beacon Signal Transaction #### Parameters ##### didUpdatePayload `string` The DID update payload #### Returns [`BeaconSignal`](BeaconSignal.md) The Beacon Signal *** ### processSignal() &gt; **processSignal**(`signal`, `signalsMetadata`): `Promise`\<`undefined` \| `DidUpdatePayload`\&gt; Defined in: [packages/method/src/interfaces/ibeacon.ts:50](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/interfaces/ibeacon.ts#L50) Processes a Beacon Signal. #### Parameters ##### signal [`RawTransactionV2`](RawTransactionV2.md) The raw transaction ##### signalsMetadata [`SignalsMetadata`](../type-aliases/SignalsMetadata.md) The signals metadata from the sidecar data #### Returns `Promise`\<`undefined` \| `DidUpdatePayload`\&gt; The DID update payload