passkey-kit 0.4.1 → 0.4.3

package/PROPOSAL.md

@@ -1,4 +1,4 @@
-# Smart Wallet Interface
+# WebAuthn smart wallet contract interface
 
 With the release of [Protocol 21](https://stellar.org/blog/developers/announcing-protocol-21) (and specifically the inclusion of the secp256r1 verification  curve) Soroban now has tremendous first class support for passkey powered smart wallets.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "passkey-kit",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "A helper library for creating and using passkey accounts on the Stellar blockchain.",
   "author": "Tyler van der Hoeven",
   "license": "MIT",

package/src/base.ts

@@ -1,14 +1,35 @@
+import { SorobanRpc, xdr } from "@stellar/stellar-sdk"
+import base64url from "base64url"
+
 export class PasskeyBase {
+    public rpc: SorobanRpc.Server
+    public rpcUrl: string
     public launchtubeUrl: string | undefined
     public launchtubeJwt: string | undefined
+    public mercuryUrl: string | undefined
+    public mercuryJwt: string | undefined
+    public mercuryEmail: string | undefined
+    public mercuryPassword: string | undefined
 
     constructor(options: {
+        rpcUrl: string,
+        networkPassphrase: string,
+        factoryContractId: string,
         launchtubeUrl?: string,
         launchtubeJwt?: string,
+        mercuryUrl?: string,
+        mercuryJwt?: string,
+        mercuryEmail?: string,
+        mercuryPassword?: string
     }) {
         const {
+            rpcUrl,
             launchtubeUrl,
             launchtubeJwt,
+            mercuryUrl,
+            mercuryJwt,
+            mercuryEmail,
+            mercuryPassword
         } = options
 
         if (launchtubeUrl)
@@ -16,8 +37,137 @@ export class PasskeyBase {
 
         if (launchtubeJwt)
             this.launchtubeJwt = launchtubeJwt
+
+        if (mercuryUrl)
+            this.mercuryUrl = mercuryUrl
+
+        if (mercuryJwt)
+            this.mercuryJwt = mercuryJwt
+
+        if (mercuryEmail)
+            this.mercuryEmail = mercuryEmail
+
+        if (mercuryPassword)
+            this.mercuryPassword = mercuryPassword
+
+        if (!mercuryJwt && mercuryUrl && mercuryEmail && mercuryPassword)
+            this.setMercuryJwt()
+
+        this.rpcUrl = rpcUrl
+        this.rpc = new SorobanRpc.Server(rpcUrl)
     }
 
+    public async setMercuryJwt() {
+        if (!this.mercuryEmail || !this.mercuryPassword)
+            throw new Error('Mercury service not configured')
+
+        const { data: { authenticate: { jwtToken } } } = await fetch(`${this.mercuryUrl}/graphql`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify({
+                query: `mutation {
+                    authenticate(input: {
+                        email: "${this.mercuryEmail}"
+                        password: "${this.mercuryPassword}"
+                    }) {
+                        jwtToken
+                    }
+                }`
+            })
+        })
+            .then(async (res) => {
+                if (res.ok)
+                    return res.json()
+
+                throw await res.json()
+            })
+
+        this.mercuryJwt = jwtToken
+        return jwtToken
+    }
+
+    public async getSigners(contractId: string) {
+        if (!this.mercuryUrl || !this.mercuryJwt)
+            throw new Error('Mercury service not configured')
+
+        const signers = await fetch(`${this.mercuryUrl}/zephyr/execute`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                Authorization: `Bearer ${this.mercuryJwt}`
+            },
+            body: JSON.stringify({
+                mode: {
+                    Function: {
+                        fname: "get_signers_by_address",
+                        arguments: JSON.stringify({
+                            address: contractId
+                        })
+                    }
+                }
+            })
+        })
+            .then(async (res) => {
+                if (res.ok)
+                    return res.json()
+
+                throw await res.json()
+            })
+
+        for (const signer of signers) {
+            if (!signer.admin) {
+                try {
+                    await this.rpc.getContractData(contractId, xdr.ScVal.scvBytes(signer.id), SorobanRpc.Durability.Temporary)
+                } catch {
+                    signer.expired = true
+                }
+            }
+
+            signer.id = base64url(signer.id)
+            signer.pk = base64url(signer.pk)
+        }
+
+        return signers as { id: string, pk: string, admin: boolean, expired?: boolean }[]
+    }
+
+    public async getContractId(keyId: string) {
+        if (!this.mercuryUrl || !this.mercuryJwt)
+            return
+
+        const res = await fetch(`${this.mercuryUrl}/zephyr/execute`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                Authorization: `Bearer ${this.mercuryJwt}`
+            },
+            body: JSON.stringify({
+                mode: {
+                    Function: {
+                        fname: "get_address_by_signer",
+                        arguments: JSON.stringify({
+                            id: [...base64url.toBuffer(keyId)]
+                        })
+                    }
+                }
+            })
+        })
+            .then(async (res) => {
+                if (res.ok)
+                    return res.json()
+
+                throw await res.json()
+            })
+
+        return res[0]?.address as string | undefined
+    }
+
+    /* TODO 
+        - Add a method for getting a paginated or filtered list of all a wallet's events
+            @Later
+    */
+
     public async send(xdr: string, fee: number = 10_000) {
         if (!this.launchtubeUrl || !this.launchtubeJwt)
             throw new Error('Launchtube service not configured')

package/src/kit.ts

@@ -1,6 +1,6 @@
 import { Client as PasskeyClient } from 'passkey-kit-sdk'
 import { Client as FactoryClient } from 'passkey-factory-sdk'
-import { Address, Networks, StrKey, hash, xdr, Transaction, SorobanRpc, Operation, TransactionBuilder } from '@stellar/stellar-sdk'
+import { Address, StrKey, hash, xdr, Transaction, SorobanRpc, Operation, TransactionBuilder } from '@stellar/stellar-sdk'
 import base64url from 'base64url'
 import { startRegistration, startAuthentication } from "@simplewebauthn/browser"
 import type { AuthenticatorAttestationResponseJSON } from "@simplewebauthn/types"
@@ -8,39 +8,28 @@ import { decode } from 'cbor-x/decode'
 import { Buffer } from 'buffer'
 import { PasskeyBase } from './base'
 
-type GetContractIdFunction = (keyId: string) => Promise<string>;
-
 export class PasskeyKit extends PasskeyBase {
     public keyId: string | undefined
-    public wallet: PasskeyClient | undefined
+    public networkPassphrase: string
     public factory: FactoryClient
-    public networkPassphrase: Networks
-    public rpcUrl: string
-    public rpc: SorobanRpc.Server
+    public wallet: PasskeyClient | undefined
 
     constructor(options: {
         rpcUrl: string,
-        launchtubeUrl?: string,
-        launchtubeJwt?: string,
         networkPassphrase: string,
         factoryContractId: string,
+        launchtubeUrl?: string,
+        launchtubeJwt?: string,
+        mercuryUrl?: string,
+        mercuryJwt?: string,
+        mercuryEmail?: string,
+        mercuryPassword?: string
     }) {
-        const {
-            rpcUrl,
-            launchtubeUrl,
-            launchtubeJwt,
-            networkPassphrase,
-            factoryContractId,
-        } = options
+        const { rpcUrl, networkPassphrase, factoryContractId } = options
 
-        super({
-            launchtubeUrl,
-            launchtubeJwt,
-        })
+        super(options)
 
-        this.rpcUrl = rpcUrl
-        this.rpc = new SorobanRpc.Server(rpcUrl)
-        this.networkPassphrase = networkPassphrase as Networks
+        this.networkPassphrase = networkPassphrase
         this.factory = new FactoryClient({
             contractId: factoryContractId,
             networkPassphrase,
@@ -75,7 +64,7 @@ export class PasskeyKit extends PasskeyBase {
     public async createKey(app: string, user: string) {
         const now = new Date()
         const displayName = `${user} — ${now.toLocaleString()}`
-        const { id, response} = await startRegistration({
+        const { id, response } = await startRegistration({
             challenge: base64url("stellaristhebetterblockchain"),
             rp: {
                 // id: undefined,
@@ -93,6 +82,7 @@ export class PasskeyKit extends PasskeyBase {
             },
             pubKeyCredParams: [{ alg: -7, type: "public-key" }],
             attestation: "none",
+            timeout: 120_000
         });
 
         if (!this.keyId)
@@ -104,11 +94,11 @@ export class PasskeyKit extends PasskeyBase {
         }
     }
 
-    public async connectWallet(opts: {
+    public async connectWallet(opts?: {
         keyId?: string | Uint8Array,
-        getContractId?: GetContractIdFunction
+        getContractId?: (keyId: string) => Promise<string | undefined>
     }) {
-        let { keyId, getContractId } = opts
+        let { keyId, getContractId = this.getContractId } = opts || {}
         let keyIdBuffer: Buffer
 
         if (!keyId) {
@@ -116,6 +106,7 @@ export class PasskeyKit extends PasskeyBase {
                 challenge: base64url("stellaristhebetterblockchain"),
                 // rpId: undefined,
                 userVerification: "discouraged",
+                timeout: 120_000
             });
 
             console.log(response);
@@ -151,12 +142,9 @@ export class PasskeyKit extends PasskeyBase {
             // TODO what is the error if the entry exists but is archived?
             await this.rpc.getContractData(contractId, xdr.ScVal.scvLedgerKeyContractInstance())
         }
-        // if that fails look up from the factory mapper
+        // if that fails look up from the `getContractId` function
         catch {
-            contractId = undefined
-
-            if (getContractId)
-                contractId = await getContractId(keyId)
+            contractId = await getContractId(keyId)
         }
 
         if (!contractId)
@@ -203,6 +191,7 @@ export class PasskeyKit extends PasskeyBase {
                     challenge: base64url(payload),
                     // rpId: undefined,
                     userVerification: "discouraged",
+                    timeout: 120_000
                 }
                 : {
                     challenge: base64url(payload),
@@ -216,6 +205,7 @@ export class PasskeyKit extends PasskeyBase {
                         },
                     ],
                     userVerification: "discouraged",
+                    timeout: 120_000
                 }
         );
 

package/types/base.d.ts

@@ -1,9 +1,31 @@
+import { SorobanRpc } from "@stellar/stellar-sdk";
 export declare class PasskeyBase {
+    rpc: SorobanRpc.Server;
+    rpcUrl: string;
     launchtubeUrl: string | undefined;
     launchtubeJwt: string | undefined;
+    mercuryUrl: string | undefined;
+    mercuryJwt: string | undefined;
+    mercuryEmail: string | undefined;
+    mercuryPassword: string | undefined;
     constructor(options: {
+        rpcUrl: string;
+        networkPassphrase: string;
+        factoryContractId: string;
         launchtubeUrl?: string;
         launchtubeJwt?: string;
+        mercuryUrl?: string;
+        mercuryJwt?: string;
+        mercuryEmail?: string;
+        mercuryPassword?: string;
     });
+    setMercuryJwt(): Promise<any>;
+    getSigners(contractId: string): Promise<{
+        id: string;
+        pk: string;
+        admin: boolean;
+        expired?: boolean;
+    }[]>;
+    getContractId(keyId: string): Promise<string | undefined>;
     send(xdr: string, fee?: number): Promise<any>;
 }

package/types/kit.d.ts

@@ -1,22 +1,23 @@
 import { Client as PasskeyClient } from 'passkey-kit-sdk';
 import { Client as FactoryClient } from 'passkey-factory-sdk';
-import { Networks, xdr, Transaction, SorobanRpc } from '@stellar/stellar-sdk';
+import { xdr, Transaction } from '@stellar/stellar-sdk';
 import { Buffer } from 'buffer';
 import { PasskeyBase } from './base';
-type GetContractIdFunction = (keyId: string) => Promise<string>;
 export declare class PasskeyKit extends PasskeyBase {
     keyId: string | undefined;
-    wallet: PasskeyClient | undefined;
+    networkPassphrase: string;
     factory: FactoryClient;
-    networkPassphrase: Networks;
-    rpcUrl: string;
-    rpc: SorobanRpc.Server;
+    wallet: PasskeyClient | undefined;
     constructor(options: {
         rpcUrl: string;
-        launchtubeUrl?: string;
-        launchtubeJwt?: string;
         networkPassphrase: string;
         factoryContractId: string;
+        launchtubeUrl?: string;
+        launchtubeJwt?: string;
+        mercuryUrl?: string;
+        mercuryJwt?: string;
+        mercuryEmail?: string;
+        mercuryPassword?: string;
     });
     createWallet(app: string, user: string): Promise<{
         keyId: Buffer;
@@ -27,9 +28,9 @@ export declare class PasskeyKit extends PasskeyBase {
         keyId: Buffer;
         publicKey: Buffer;
     }>;
-    connectWallet(opts: {
+    connectWallet(opts?: {
         keyId?: string | Uint8Array;
-        getContractId?: GetContractIdFunction;
+        getContractId?: (keyId: string) => Promise<string | undefined>;
     }): Promise<{
         keyId: Buffer;
         contractId: string;
@@ -49,4 +50,3 @@ export declare class PasskeyKit extends PasskeyBase {
     private getPublicKey;
     private compactSignature;
 }
-export {};