Skip to content

Commit a758c41

Browse files
committed
doc: Change README and some function names
1 parent ab9d2a7 commit a758c41

File tree

4 files changed

+28
-28
lines changed

4 files changed

+28
-28
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ There are three methods to create DID-Connect-Request Message
3232
```javascript
3333
const socketId: string = socketId;
3434

35-
// 1) didConnectRequestMessage from General json
35+
// 1) didConnectRequestMessage from json
3636
const json = {
3737
from: did,
3838
body: {
@@ -49,7 +49,7 @@ const json = {
4949
const didConnectRequestMessage =
5050
DIDConnectRequestMessage.fromJSON(json);
5151

52-
// 2) didConnectRequestMessage from Compact
52+
// 2) didConnectRequestMessage from compactJSON
5353
const compactJson = {
5454
from: did,
5555
body: {
@@ -66,7 +66,7 @@ const compactJson = {
6666
const didConnectRequestMessageFromCompact =
6767
DIDConnectRequestMessage.fromJSON(compactJson);
6868

69-
// 3) didConnectRequestMessage from minimalCompactJson
69+
// 3) didConnectRequestMessage from minimalCompactJSON
7070
const minimalCompactJson = {
7171
from: did,
7272
body: {
@@ -158,16 +158,16 @@ const didAuthFailedMessage = new DIDAuthFailedMessage(
158158
### Sign / Verify JWS
159159

160160
```javascript
161-
const jws = await compactJWS(
162-
payload,
163-
CryptoHelper.jwk2KeyObject(JWK, "private"),
164-
{
165-
typ: "JWM",
166-
alg: "EdDSA",
167-
},
168-
);
161+
const privateKey = privateKeyFromMnemonic(mnemonic);
162+
const publicKey = publicKeyFromMnemonic(mnemonic);
163+
const JWK = key2JWK("Ed25519", publicKey, privateKey);
169164

170-
var payload = verifyJWS(token, publicKey);
165+
const jws = await compactJWS(payload, JWK, {
166+
typ: "JWM",
167+
alg: "EdDSA",
168+
});
169+
170+
var payload = verifyJWS(jws, publicKey);
171171
```
172172

173173
### Encrypt / Decrypt JWE
@@ -185,14 +185,15 @@ const sharedKey = deriveSharedKey(
185185

186186
const jwe = await compactJWE(
187187
payload,
188-
await exportJWK(sharedKey),
188+
await jose.exportJWK(sharedKey),
189189
x25519JwkFromX25519PublicKey(ephemeralPublicKey),
190190
);
191191
```
192192

193193
- Without epk
194194

195195
```javascript
196+
const x25519JwkPublicKey = x25519JwkFromEd25519PublicKey(publicKey);
196197
const senderPrivateKeyX25519JWK = x25519JwkFromMnemonic(mnemonic);
197198
const sharedKey = deriveSharedKey(
198199
privateKeyfromX25519Jwk(senderPrivateKeyX25519JWK),
@@ -224,11 +225,11 @@ const { ephemeralPrivateKey1, ephemeralPublicKey1 } =
224225
const { ephemeralPrivateKey2, ephemeralPublicKey2 } =
225226
generateX25519EphemeralKeyPair();
226227

227-
const sharedKey2 = deriveSharedKey(ephemeralPrivateKey1, ephemeralPublicKey2);
228+
const sharedKey1 = deriveSharedKey(ephemeralPrivateKey1, ephemeralPublicKey2);
228229
const sharedKey2 = deriveSharedKey(ephemeralPrivateKey2, ephemeralPublicKey1);
229230
```
230231

231-
### Connect to Websocket Server
232+
### Connect to Websocket Server with Receiving Connect Request Message
232233

233234
Check [example](./examples/websocket) for more detail.
234235

@@ -242,15 +243,15 @@ const agent = new InfraDIDCommAgent(
242243
mnemonic,
243244
"HOLDER",
244245
);
246+
const encoded = "connectRequestMessageCreatedByPeer";
245247

246248
agent.setDIDAuthCallback(didAuthCallback);
247249
agent.setDIDConnectedCallback(didConnectedCallback);
248250
agent.setDIDAuthFailedCallback(didAuthFailedCallback);
249-
250-
agent.init();
251+
agent.initReceivingConnectRequest(encoded);
251252
```
252253

253-
### Make Dynamic QR Code
254+
### Connect to Websocket Server with Creating Connect Request Message
254255

255256
```javascript
256257
const mnemonic =
@@ -266,6 +267,5 @@ const agent = new InfraDIDCommAgent(
266267
agent.setDIDAuthCallback(didAuthCallback);
267268
agent.setDIDConnectedCallback(didConnectedCallback);
268269
agent.setDIDAuthFailedCallback(didAuthFailedCallback);
269-
270-
agent.initWithConnectRequest();
270+
agent.initCreatingDynamicConnectRequest(context, 30, setConnectRequestCallback);
271271
```

examples/websocket/dynamic_qr.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { Context } from "../../src/messages/commons";
2-
import { didConnectRequest } from "../../src/websocket/dynamic-qr";
2+
import { dynamicConnectRequest } from "../../src/websocket/dynamic-qr";
33
import { InfraDIDCommAgent } from "../../src/websocket/index";
44

55
async function dynamic_qr_works() {
@@ -13,7 +13,7 @@ async function dynamic_qr_works() {
1313
"VERIFIER",
1414
);
1515
const context = new Context("newnal", "connect");
16-
await didConnectRequest(client, context, 2, message => {
16+
await dynamicConnectRequest(client, context, 2, message => {
1717
console.log(message);
1818
});
1919
}

src/websocket/agent.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {
66
DIDConnectRequestMessage,
77
} from "../../src/messages";
88
import { Context, Initiator } from "../../src/messages/commons";
9-
import { didConnectRequest } from "./dynamic-qr";
9+
import { dynamicConnectRequest } from "./dynamic-qr";
1010
import {
1111
messageHandler,
1212
sendDIDAuthInitMessageToReceiver,
@@ -105,25 +105,25 @@ export class InfraDIDCommAgent {
105105
this.socket.connect();
106106
}
107107

108-
initFromConnectRequest(encoded: string): void {
108+
initReceivingConnectRequest(encoded: string): void {
109109
this.onMessage();
110110
this.socket.connect();
111111
this.sendDIDAuthInitMessage(encoded);
112112
}
113113

114-
initFromStaticConnectRequest(): void {
114+
initReceivingStaticConnectRequest(): void {
115115
this.onMessage();
116116
this.socket.connect();
117117
// TODO: Implement static connect request
118118
}
119119

120-
initWithConnectRequest(
120+
initCreatingDynamicConnectRequest(
121121
context: Context,
122122
timeout: number,
123123
callback: (message: string) => void,
124124
): void {
125125
this.onMessage();
126-
didConnectRequest(this, context, timeout, callback);
126+
dynamicConnectRequest(this, context, timeout, callback);
127127
}
128128

129129
reset(): void {

src/websocket/dynamic-qr.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { InfraDIDCommAgent } from "../../src/websocket/index";
1313
* @param {number} timeout - The timeout in seconds for the connect request. Also used as a delay before the next iteration.
1414
* @param {(message: string) => void} callback - A callback function that is called with the encoded connect request message.
1515
*/
16-
export async function didConnectRequest(
16+
export async function dynamicConnectRequest(
1717
agent: InfraDIDCommAgent,
1818
context: Context,
1919
timeout: number,

0 commit comments

Comments
 (0)