signData (#15)

Author: acfunk

README.md

@@ -4,12 +4,20 @@ Lute Connect is a Javascript library to securely sign transactions with Lute, an
 
 ## Installation
 
-The package can be installed via npm:
+The package can be installed via your favorite package manager:
 
-```bash
+```sh
 npm i lute-connect
 ```
 
+```sh
+yarn add lute-connect
+```
+
+```sh
+pnpm add lute-connect
+```
+
 ## API Usage
 
 ### Quick start
@@ -38,7 +46,7 @@ async function connect() {
 
 ### Sign transactions
 
-```js
+```ts
 // Warning: Browser will block pop-up if user doesn't trigger lute.signTxns() with a button click
 async function signTransactions(txns) {
   try {
@@ -58,26 +66,30 @@ async function signTransactions(txns) {
 
 ### Sign data
 
-```js
+```ts
 // Warning: Browser will block pop-up if user doesn't trigger lute.signData() with a button click
 async function authenticate() {
   try {
-    const domain = "arc60.io";
-    const authenticatorData = new Uint8Array(
-      createHash("sha256").update(domain).digest()
-    );
-    const signingData = {
-      data: Buffer.from("{[jsonfields....]}").toString("base64"),
-      signer: publicKey,
-      domain,
-      authenticatorData,
+    const siwxRequest: Siwx = {
+      domain: location.host,
+      chain_id: "283",
+      account_address: activeAccount.value.address,
+      type: "ed25519",
+      statement:
+        "Put your own statement here, for example: I accept the ExampleOrg Terms of Service.",
+      uri: location.origin,
+      version: "1",
+      nonce: Buffer.from(randomBytes(12)).toString("base64"),
+      "issued-at": new Date().toISOString(),
     };
-    const metadata = {
+
+    const data = Buffer.from(JSON.stringify(siwxRequest)).toString("base64");
+    const metadata: SignMetadata = {
       scope: ScopeType.AUTH,
       encoding: "base64",
     };
-    const signerResponse = await lute.signData(signingData, metadata);
-    // TODO: verify signerResponse.signature
+    const signerResponse = await lute.signData(data, metadata);
+    // TODO: verify signerResponse
   } catch (err) {
     console.error(
       "[LuteWallet] Error signing data: " +

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lute-connect",
-  "version": "1.6.0-beta.0",
+  "version": "1.6.0",
   "main": "./dist/main.cjs.js",
   "module": "./dist/main.esm.js",
   "types": "./dist/main.d.ts",

src/main.ts

@@ -57,6 +57,22 @@ export class SignTxnsError extends Error {
   }
 }
 
+export interface Siwa {
+  domain: string;
+  account_address: string;
+  uri: string;
+  version: string;
+  statement?: string;
+  nonce?: string;
+  "issued-at"?: string;
+  "expiration-time"?: string;
+  "not-before"?: string;
+  "request-id"?: string;
+  chain_id: "283";
+  resources?: string[];
+  type: "ed25519";
+}
+
 export interface SignData {
   data: string;
   signer: Uint8Array;
@@ -191,17 +207,14 @@ export default class LuteConnect {
     });
   }
 
-  signData(
-    signingData: SignData,
-    metadata: SignMetadata
-  ): Promise<SignDataResponse> {
+  signData(data: string, metadata: SignMetadata): Promise<SignDataResponse> {
     return new Promise(async (resolve, reject) => {
       const useExt = this.forceWeb ? false : await this.isExtensionInstalled();
       let win: any;
       if (useExt) {
         window.dispatchEvent(
           new CustomEvent("lute-connect", {
-            detail: { action: "data", signingData, metadata },
+            detail: { action: "data", data, metadata },
           })
         );
       } else {
@@ -215,7 +228,7 @@ export default class LuteConnect {
         if (detail.debug) console.log("[Lute Debug]", detail);
         switch (detail.action) {
           case "ready":
-            win?.postMessage({ action: "data", signingData, metadata }, "*");
+            win?.postMessage({ action: "data", data, metadata }, "*");
             break;
           case "signed":
             window.removeEventListener(type, messageHandler);