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

137 lines (70 loc) • 3.29 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
[**@did-btc1/cryptosuite**](../README.md) *** [@did-btc1/cryptosuite](../globals.md) / DataIntegrityProof # Class: DataIntegrityProof Defined in: [data-integrity-proof/index.ts:13](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/cryptosuite/src/data-integrity-proof/index.ts#L13) Implements section [2.2.1 DataIntegrityProof](https://dcdpr.github.io/data-integrity-schnorr-secp256k1/#dataintegrityproof) of the [Data Integrity BIP-340 Cryptosuite](https://dcdpr.github.io/data-integrity-schnorr-secp256k1) spec DataIntegrityProof ## Implements - [`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md) ## Constructors ### Constructor &gt; **new DataIntegrityProof**(`cryptosuite`): `DataIntegrityProof` Defined in: [data-integrity-proof/index.ts:22](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/cryptosuite/src/data-integrity-proof/index.ts#L22) Creates an instance of DataIntegrityProof. #### Parameters ##### cryptosuite [`Cryptosuite`](Cryptosuite.md) The cryptosuite to use for proof generation and verification. #### Returns `DataIntegrityProof` ## Properties ### cryptosuite &gt; **cryptosuite**: [`Cryptosuite`](Cryptosuite.md) Defined in: [data-integrity-proof/index.ts:15](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/cryptosuite/src/data-integrity-proof/index.ts#L15) #### Implementation of [`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md).[`cryptosuite`](../interfaces/IDataIntegrityProof.md#cryptosuite) ## Methods ### addProof() &gt; **addProof**(`params`): `Promise`\<`DidUpdateInvocation`\&gt; Defined in: [data-integrity-proof/index.ts:33](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/cryptosuite/src/data-integrity-proof/index.ts#L33) Add a proof to a document. #### Parameters ##### params [`AddProofParams`](../type-aliases/AddProofParams.md) Parameters for adding a proof to a document. #### Returns `Promise`\<`DidUpdateInvocation`\&gt; A document with a proof added. #### Implementation of [`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md).[`addProof`](../interfaces/IDataIntegrityProof.md#addproof) *** ### verifyProof() &gt; **verifyProof**(`params`): `Promise`\<[`VerificationResult`](../interfaces/VerificationResult.md)\&gt; Defined in: [data-integrity-proof/index.ts:74](https://github.com/dcdpr/did-btc1-js/blob/4ab6f9915d95beed9bc633644c9db1539395f512/packages/cryptosuite/src/data-integrity-proof/index.ts#L74) Verify a proof. #### Parameters ##### params Parameters for verifying a proof. ###### document `string` The document to verify. ###### expectedChallenge? `string` The expected challenge of the proof. ###### expectedDomain? `string`[] The expected domain of the proof. ###### expectedPurpose `string` The expected purpose of the proof. ###### mediaType? `string` The media type of the document. #### Returns `Promise`\<[`VerificationResult`](../interfaces/VerificationResult.md)\&gt; The result of verifying the proof. #### Implementation of [`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md).[`verifyProof`](../interfaces/IDataIntegrityProof.md#verifyproof)