passkey-kit 0.4.5 → 0.5.0

package/README.md

@@ -12,28 +12,62 @@ pnpm i passkey-kit
 On the client:
 ```ts
 const account = new PasskeyKit({
-    rpcUrl: env.RPC_URL,
-    networkPassphrase: env.NETWORK_PASSPHRASE,
-    factoryContractId: env.FACTORY_CONTRACT_ID,
+    rpcUrl: env.PUBLIC_rpcUrl,
+    networkPassphrase: env.PUBLIC_networkPassphrase,
+    factoryContractId: env.PUBLIC_factoryContractId,
 });
 ```
 
 On the server:
 ```ts
 const account = new PasskeyBase({
-    launchtubeUrl: env.LAUNCHTUBE_URL,
-    launchtubeJwt: env.LAUNCHTUBE_JWT,
+    rpcUrl: env.PUBLIC_rpcUrl,
+    launchtubeUrl: env.PUBLIC_launchtubeUrl,
+    launchtubeJwt: env.PRIVATE_launchtubeJwt,
+    mercuryUrl: env.PUBLIC_mercuryUrl,
+    mercuryEmail: env.PRIVATE_mercuryEmail,
+    mercuryPassword: env.PRIVATE_mercuryPassword,
 });
 ```
 
 Note that while I don't recommend it you can use the server-intended `send` method on the client side by passing in the `launchtubeUrl` and `launchtubeJwt` values to the `PasskeyKit` constructor. We do this in the `./demo` site to ease demonstration, development and experimentation, however in a production environment you'll want to keep your secrets safe on the server.
 
+In order to utilize the zephyr indexing service to track available signers and reverse lookup smart wallet contract addresses from passkey ids you'll need to deploy the Zephyr program from inside the `./zephyr` directory.
+
+```bash
+cd ./zephyr
+cargo install mercury-cli
+# Get a JWT from Mercury https://test.mercurydata.app
+export MERCURY_JWT="<YOUR.MERCURY.JWT>"
+# Make sure you're on Rust version 1.79.0 or newer
+mercury-cli --jwt $MERCURY_JWT --local false --mainnet false deploy
+```
+
 This is a fully typed library so docs aren't provided, however there's a full example showcasing all the core public methods in the `./demo` directory. I also recommend reviewing the [Super Peach](https://github.com/kalepail/superpeach) repo for an example of how you could implement both the client and server side in a more real-world scenario.
 
 Good luck, have fun, and change the world!
 
 For any questions or to showcase your progress please join the `#passkeys` channel on our [Discord](https://discord.gg/stellardev).
 
+## Some Notes
+
+This is a TypeScript library and the npm package doesn't export a JavaScript version. The `@stellar/stellar-sdk` library is enormous and I really don't wan't folks bundling it up twice. Therefore you'll need to ensure you're transpiling this library into your project and that goes for either a TS project or a JS one. For many of you this will "just work" but for others you'll need to do some fiddling.
+
+For example if you're using NextJS this will mean modifying your `next.config.mjs` file to include the following packages in the `transpilePackages` key:
+```mjs
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+    transpilePackages: [
+        'passkey-kit', 
+        'passkey-factory-sdk', 
+        'passkey-kit-sdk'
+    ]
+};
+
+export default nextConfig;
+```
+If someone smarter than me knows how to include an optional JS build from a TS library please submit a PR. I just don't want to deploy a compiled version of this and wind up having folks doubling up on an already gargantuan dependency.
+
 ## Contributing 
 
 Passkey kit consists of three primary directories:

package/package.json

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

package/pnpm-workspace.yaml

@@ -1,2 +1,3 @@
 packages:
-  - 'packages/*'
+  - 'packages/**'
+  - '!demo/**'

package/src/base.ts

@@ -1,192 +1,13 @@
-import { SorobanRpc, xdr } from "@stellar/stellar-sdk"
-import base64url from "base64url"
+import { SorobanRpc } from "@stellar/stellar-sdk"
 
 export class PasskeyBase {
     public rpc: SorobanRpc.Server | undefined
     public rpcUrl: string | undefined
-    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,
-        launchtubeUrl?: string,
-        launchtubeJwt?: string,
-        mercuryUrl?: string,
-        mercuryJwt?: string,
-        mercuryEmail?: string,
-        mercuryPassword?: string
-    }) {
-        const {
-            rpcUrl,
-            launchtubeUrl,
-            launchtubeJwt,
-            mercuryUrl,
-            mercuryJwt,
-            mercuryEmail,
-            mercuryPassword
-        } = options
-
-        if (launchtubeUrl)
-            this.launchtubeUrl = launchtubeUrl
-
-        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()
-
+    
+    constructor(rpcUrl?: string) {
         if (rpcUrl) {
             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.rpc || !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')
-
-        const data = new FormData();
-
-        data.set('xdr', xdr);
-        data.set('fee', fee.toString());
-
-        return fetch(this.launchtubeUrl, {
-            method: 'POST',
-            headers: {
-                authorization: `Bearer ${this.launchtubeJwt}`,
-            },
-            body: data
-        }).then(async (res) => {
-            if (res.ok)
-                return res.json()
-            else throw await res.json()
-        })
-    }
 }

package/src/index.ts

@@ -1,4 +1,4 @@
-import { PasskeyBase } from "./base"
+import { PasskeyServer } from "./server"
 import { PasskeyKit } from "./kit"
 
-export { PasskeyBase, PasskeyKit }
+export { PasskeyServer, PasskeyKit }

package/src/kit.ts

@@ -8,6 +8,8 @@ import { Buffer } from 'buffer'
 import { PasskeyBase } from './base'
 
 export class PasskeyKit extends PasskeyBase {
+    declare public rpc: SorobanRpc.Server
+    declare public rpcUrl: string
     public keyId: string | undefined
     public networkPassphrase: string
     public factory: FactoryClient
@@ -17,22 +19,10 @@ export class PasskeyKit extends PasskeyBase {
         rpcUrl: string,
         networkPassphrase: string,
         factoryContractId: string,
-        launchtubeUrl?: string,
-        launchtubeJwt?: string,
-        mercuryUrl?: string,
-        mercuryJwt?: string,
-        mercuryEmail?: string,
-        mercuryPassword?: string
     }) {
         const { rpcUrl, networkPassphrase, factoryContractId } = options
 
-        super(options)
-
-        if (!this.rpcUrl)
-            this.rpcUrl = rpcUrl
-
-        if (!this.rpc)
-            this.rpc = new SorobanRpc.Server(rpcUrl)
+        super(rpcUrl)
 
         this.networkPassphrase = networkPassphrase
         this.factory = new FactoryClient({
@@ -103,7 +93,7 @@ export class PasskeyKit extends PasskeyBase {
         keyId?: string | Uint8Array,
         getContractId?: (keyId: string) => Promise<string | undefined>
     }) {
-        let { keyId, getContractId = this.getContractId } = opts || {}
+        let { keyId, getContractId } = opts || {}
         let keyIdBuffer: Buffer
 
         if (!keyId) {
@@ -114,8 +104,6 @@ export class PasskeyKit extends PasskeyBase {
                 timeout: 120_000
             });
 
-            // console.log(response);
-
             keyId = response.id
         }
 
@@ -145,11 +133,11 @@ export class PasskeyKit extends PasskeyBase {
         // attempt passkey id derivation
         try {
             // TODO what is the error if the entry exists but is archived?
-            await this.rpc!.getContractData(contractId, xdr.ScVal.scvLedgerKeyContractInstance())
+            await this.rpc.getContractData(contractId, xdr.ScVal.scvLedgerKeyContractInstance())
         }
         // if that fails look up from the `getContractId` function
         catch {
-            contractId = await getContractId(keyId)
+            contractId = getContractId ? await getContractId(keyId) : undefined
         }
 
         if (!contractId)
@@ -177,7 +165,7 @@ export class PasskeyKit extends PasskeyBase {
         // Default mirrors DEFAULT_TIMEOUT (currently 5 minutes) https://github.com/stellar/js-stellar-sdk/blob/master/src/contract/utils.ts#L7
         let { keyId, ledgersToLive = 60 } = options || {}
 
-        const lastLedger = await this.rpc!.getLatestLedger().then(({ sequence }) => sequence)
+        const lastLedger = await this.rpc.getLatestLedger().then(({ sequence }) => sequence)
         const credentials = entry.credentials().address();
         const preimage = xdr.HashIdPreimage.envelopeTypeSorobanAuthorization(
             new xdr.HashIdPreimageSorobanAuthorization({
@@ -300,7 +288,7 @@ export class PasskeyKit extends PasskeyBase {
                 await this.signAuthEntries(entries, options)
         }
 
-        const sim = await this.rpc!.simulateTransaction(txn)
+        const sim = await this.rpc.simulateTransaction(txn)
 
         if (
             SorobanRpc.Api.isSimulationError(sim)

package/src/server.ts

@@ -0,0 +1,191 @@
+import { SorobanRpc, xdr } from "@stellar/stellar-sdk"
+import base64url from "base64url"
+import { PasskeyBase } from "./base"
+
+export class PasskeyServer extends PasskeyBase {
+    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,
+        launchtubeUrl?: string,
+        launchtubeJwt?: string,
+        mercuryUrl?: string,
+        mercuryJwt?: string,
+        mercuryEmail?: string,
+        mercuryPassword?: string
+    }) {
+        const {
+            rpcUrl,
+            launchtubeUrl,
+            launchtubeJwt,
+            mercuryUrl,
+            mercuryJwt,
+            mercuryEmail,
+            mercuryPassword
+        } = options
+
+        super(rpcUrl)
+
+        if (launchtubeUrl)
+            this.launchtubeUrl = launchtubeUrl
+
+        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
+    }
+
+    public async setMercuryJwt() {
+        if (!this.mercuryUrl || !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.rpc && this.mercuryUrl && !this.mercuryJwt)
+            await this.setMercuryJwt()
+
+        if (!this.rpc || !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)
+            await this.setMercuryJwt()
+
+        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')
+
+        const data = new FormData();
+
+        data.set('xdr', xdr);
+        data.set('fee', fee.toString());
+
+        return fetch(this.launchtubeUrl, {
+            method: 'POST',
+            headers: {
+                authorization: `Bearer ${this.launchtubeJwt}`,
+            },
+            body: data
+        }).then(async (res) => {
+            if (res.ok)
+                return res.json()
+            else throw await res.json()
+        })
+    }
+}

package/types/base.d.ts

@@ -2,28 +2,5 @@ import { SorobanRpc } from "@stellar/stellar-sdk";
 export declare class PasskeyBase {
     rpc: SorobanRpc.Server | undefined;
     rpcUrl: string | undefined;
-    launchtubeUrl: string | undefined;
-    launchtubeJwt: string | undefined;
-    mercuryUrl: string | undefined;
-    mercuryJwt: string | undefined;
-    mercuryEmail: string | undefined;
-    mercuryPassword: string | undefined;
-    constructor(options: {
-        rpcUrl?: 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>;
+    constructor(rpcUrl?: string);
 }

package/types/index.d.ts

@@ -1,3 +1,3 @@
-import { PasskeyBase } from "./base";
+import { PasskeyServer } from "./server";
 import { PasskeyKit } from "./kit";
-export { PasskeyBase, PasskeyKit };
+export { PasskeyServer, PasskeyKit };

package/types/kit.d.ts

@@ -1,9 +1,11 @@
 import { Client as PasskeyClient } from 'passkey-kit-sdk';
 import { Client as FactoryClient } from 'passkey-factory-sdk';
-import { xdr, Transaction } from '@stellar/stellar-sdk';
+import { xdr, Transaction, SorobanRpc } from '@stellar/stellar-sdk';
 import { Buffer } from 'buffer';
 import { PasskeyBase } from './base';
 export declare class PasskeyKit extends PasskeyBase {
+    rpc: SorobanRpc.Server;
+    rpcUrl: string;
     keyId: string | undefined;
     networkPassphrase: string;
     factory: FactoryClient;
@@ -12,12 +14,6 @@ export declare class PasskeyKit extends PasskeyBase {
         rpcUrl: 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;

package/types/server.d.ts

@@ -0,0 +1,27 @@
+import { PasskeyBase } from "./base";
+export declare class PasskeyServer extends PasskeyBase {
+    launchtubeUrl: string | undefined;
+    launchtubeJwt: string | undefined;
+    mercuryUrl: string | undefined;
+    mercuryJwt: string | undefined;
+    mercuryEmail: string | undefined;
+    mercuryPassword: string | undefined;
+    constructor(options: {
+        rpcUrl?: 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>;
+}