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

150 lines (81 loc) • 3.32 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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
[**@did-btc1/method**](../README.md) *** [@did-btc1/method](../globals.md) / Btc1Identifier # Class: Btc1Identifier Defined in: [packages/method/src/utils/identifier.ts:17](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/utils/identifier.ts#L17) Implements [3 Syntax](https://dcdpr.github.io/did-btc1/#syntax). A did:btc1 DID consists of a did:btc1 prefix, followed by an id-bech32 value, which is a Bech32m encoding of: - the specification version; - the Bitcoin network identifier; and - either: - a key-value representing a secp256k1 public key; or - a hash-value representing the hash of an initiating external DID document. Btc1Identifier ## Constructors ### Constructor > **new Btc1Identifier**(): `Btc1Identifier` #### Returns `Btc1Identifier` ## Methods ### decode() > `static` **decode**(`identifier`): [`DidComponents`](../interfaces/DidComponents.md) Defined in: [packages/method/src/utils/identifier.ts:135](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/utils/identifier.ts#L135) Implements [3.3 did:btc1 Identifier Decoding](https://dcdpr.github.io/did-btc1/#didbtc1-identifier-decoding). #### Parameters ##### identifier `string` The BTC1 DID to be parsed #### Returns [`DidComponents`](../interfaces/DidComponents.md) The parsed identifier components. See [DidComponents](../interfaces/DidComponents.md) for details. #### Throws if an error occurs while parsing the identifier #### Throws if identifier is invalid #### Throws if the method is not supported *** ### encode() > `static` **encode**(`params`): `string` Defined in: [packages/method/src/utils/identifier.ts:35](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/utils/identifier.ts#L35) Implements [3.2 did:btc1 Identifier Encoding](https://dcdpr.github.io/did-btc1/#didbtc1-identifier-encoding). A did:btc1 DID consists of a did:btc1 prefix, followed by an id-bech32 value, which is a Bech32m encoding of: - the specification version; - the Bitcoin network identifier; and - either: - a key-value representing a secp256k1 public key; or - a hash-value representing the hash of an initiating external DID document. #### Parameters ##### params See [CreateIdentifierParams](../interfaces/CreateIdentifierParams.md) for details. ###### genesisBytes `Bytes` Public key or an intermediate document bytes. ###### idType `string` Identifier type (key or external). ###### network `string` \| `number` Bitcoin network name. ###### version `number` Identifier version. #### Returns `string` The new did:btc1 identifier. *** ### generate() > `static` **generate**(): `object` Defined in: [packages/method/src/utils/identifier.ts:265](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/method/src/utils/identifier.ts#L265) Generates a new did:btc1 identifier based on a newly generated key pair. #### Returns `object` The new did:btc1 identifier. ##### identifier > **identifier**: `object` ###### identifier.controller > **controller**: `string` ###### identifier.id > **id**: `string` ##### keys > **keys**: `SchnorrKeyPair`