Skip to content

Commit

Permalink
doc: Change README and some function names
Browse files Browse the repository at this point in the history
  • Loading branch information
energyGiver committed Apr 26, 2024
1 parent ab9d2a7 commit a758c41
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 28 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ There are three methods to create DID-Connect-Request Message
```javascript
const socketId: string = socketId;

// 1) didConnectRequestMessage from General json
// 1) didConnectRequestMessage from json
const json = {
from: did,
body: {
Expand All @@ -49,7 +49,7 @@ const json = {
const didConnectRequestMessage =
DIDConnectRequestMessage.fromJSON(json);

// 2) didConnectRequestMessage from Compact
// 2) didConnectRequestMessage from compactJSON
const compactJson = {
from: did,
body: {
Expand All @@ -66,7 +66,7 @@ const compactJson = {
const didConnectRequestMessageFromCompact =
DIDConnectRequestMessage.fromJSON(compactJson);

// 3) didConnectRequestMessage from minimalCompactJson
// 3) didConnectRequestMessage from minimalCompactJSON
const minimalCompactJson = {
from: did,
body: {
Expand Down Expand Up @@ -158,16 +158,16 @@ const didAuthFailedMessage = new DIDAuthFailedMessage(
### Sign / Verify JWS

```javascript
const jws = await compactJWS(
payload,
CryptoHelper.jwk2KeyObject(JWK, "private"),
{
typ: "JWM",
alg: "EdDSA",
},
);
const privateKey = privateKeyFromMnemonic(mnemonic);
const publicKey = publicKeyFromMnemonic(mnemonic);
const JWK = key2JWK("Ed25519", publicKey, privateKey);

var payload = verifyJWS(token, publicKey);
const jws = await compactJWS(payload, JWK, {
typ: "JWM",
alg: "EdDSA",
});

var payload = verifyJWS(jws, publicKey);
```

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

const jwe = await compactJWE(
payload,
await exportJWK(sharedKey),
await jose.exportJWK(sharedKey),
x25519JwkFromX25519PublicKey(ephemeralPublicKey),
);
```

- Without epk

```javascript
const x25519JwkPublicKey = x25519JwkFromEd25519PublicKey(publicKey);
const senderPrivateKeyX25519JWK = x25519JwkFromMnemonic(mnemonic);
const sharedKey = deriveSharedKey(
privateKeyfromX25519Jwk(senderPrivateKeyX25519JWK),
Expand Down Expand Up @@ -224,11 +225,11 @@ const { ephemeralPrivateKey1, ephemeralPublicKey1 } =
const { ephemeralPrivateKey2, ephemeralPublicKey2 } =
generateX25519EphemeralKeyPair();

const sharedKey2 = deriveSharedKey(ephemeralPrivateKey1, ephemeralPublicKey2);
const sharedKey1 = deriveSharedKey(ephemeralPrivateKey1, ephemeralPublicKey2);
const sharedKey2 = deriveSharedKey(ephemeralPrivateKey2, ephemeralPublicKey1);
```

### Connect to Websocket Server
### Connect to Websocket Server with Receiving Connect Request Message

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

Expand All @@ -242,15 +243,15 @@ const agent = new InfraDIDCommAgent(
mnemonic,
"HOLDER",
);
const encoded = "connectRequestMessageCreatedByPeer";

agent.setDIDAuthCallback(didAuthCallback);
agent.setDIDConnectedCallback(didConnectedCallback);
agent.setDIDAuthFailedCallback(didAuthFailedCallback);

agent.init();
agent.initReceivingConnectRequest(encoded);
```

### Make Dynamic QR Code
### Connect to Websocket Server with Creating Connect Request Message

```javascript
const mnemonic =
Expand All @@ -266,6 +267,5 @@ const agent = new InfraDIDCommAgent(
agent.setDIDAuthCallback(didAuthCallback);
agent.setDIDConnectedCallback(didConnectedCallback);
agent.setDIDAuthFailedCallback(didAuthFailedCallback);

agent.initWithConnectRequest();
agent.initCreatingDynamicConnectRequest(context, 30, setConnectRequestCallback);
```
4 changes: 2 additions & 2 deletions examples/websocket/dynamic_qr.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Context } from "../../src/messages/commons";
import { didConnectRequest } from "../../src/websocket/dynamic-qr";
import { dynamicConnectRequest } from "../../src/websocket/dynamic-qr";
import { InfraDIDCommAgent } from "../../src/websocket/index";

async function dynamic_qr_works() {
Expand All @@ -13,7 +13,7 @@ async function dynamic_qr_works() {
"VERIFIER",
);
const context = new Context("newnal", "connect");
await didConnectRequest(client, context, 2, message => {
await dynamicConnectRequest(client, context, 2, message => {
console.log(message);
});
}
Expand Down
10 changes: 5 additions & 5 deletions src/websocket/agent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
DIDConnectRequestMessage,
} from "../../src/messages";
import { Context, Initiator } from "../../src/messages/commons";
import { didConnectRequest } from "./dynamic-qr";
import { dynamicConnectRequest } from "./dynamic-qr";
import {
messageHandler,
sendDIDAuthInitMessageToReceiver,
Expand Down Expand Up @@ -105,25 +105,25 @@ export class InfraDIDCommAgent {
this.socket.connect();
}

initFromConnectRequest(encoded: string): void {
initReceivingConnectRequest(encoded: string): void {
this.onMessage();
this.socket.connect();
this.sendDIDAuthInitMessage(encoded);
}

initFromStaticConnectRequest(): void {
initReceivingStaticConnectRequest(): void {
this.onMessage();
this.socket.connect();
// TODO: Implement static connect request
}

initWithConnectRequest(
initCreatingDynamicConnectRequest(
context: Context,
timeout: number,
callback: (message: string) => void,
): void {
this.onMessage();
didConnectRequest(this, context, timeout, callback);
dynamicConnectRequest(this, context, timeout, callback);
}

reset(): void {
Expand Down
2 changes: 1 addition & 1 deletion src/websocket/dynamic-qr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { InfraDIDCommAgent } from "../../src/websocket/index";
* @param {number} timeout - The timeout in seconds for the connect request. Also used as a delay before the next iteration.
* @param {(message: string) => void} callback - A callback function that is called with the encoded connect request message.
*/
export async function didConnectRequest(
export async function dynamicConnectRequest(
agent: InfraDIDCommAgent,
context: Context,
timeout: number,
Expand Down

0 comments on commit a758c41

Please sign in to comment.