passkey-kit 0.5.2 → 0.5.4

package/.vscode/settings.json

@@ -2,7 +2,7 @@
     "rust-analyzer.linkedProjects": [
         "./zephyr/Cargo.toml",
         "./contracts/Cargo.toml",
-        "./contracts/contract-webauthn-factory/Cargo.toml",
-        "./contracts/contract-webauthn-secp256r1/Cargo.toml",
+        "./contracts/webauthn-factory/Cargo.toml",
+        "./contracts/webauthn-wallet/Cargo.toml",
     ]
 }

package/README.md

@@ -1,6 +1,6 @@
 # Passkey Kit
 
-Passkey kit is a basic TypeScript SDK for creating and managing Stellar smart wallets. It's intended to be used in tandem with [Launchtube](https://github.com/kalepail/launchtube) for submitting passkey signed transactions onchain however this is not a requirement. This is both a client and a server side library. `PasskeyKit` on the client and `PasskeyBase` on the server.
+Passkey kit is a basic TypeScript SDK for creating and managing Stellar smart wallets. It's intended to be used in tandem with [Launchtube](https://github.com/kalepail/launchtube) for submitting passkey signed transactions onchain however this is not a requirement. This is both a client and a server side library. `PasskeyKit` on the client and `PasskeyServer` on the server.
 
 Demo site: [passkey-kit-demo.pages.dev](https://passkey-kit-demo.pages.dev/)
 
@@ -20,7 +20,7 @@ const account = new PasskeyKit({
 
 On the server:
 ```ts
-const account = new PasskeyBase({
+const account = new PasskeyServer({
     rpcUrl: env.PUBLIC_rpcUrl,
     launchtubeUrl: env.PUBLIC_launchtubeUrl,
     launchtubeJwt: env.PRIVATE_launchtubeJwt,
@@ -30,9 +30,15 @@ const account = new PasskeyBase({
 });
 ```
 
-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.
+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).
+
+## Deploy the event indexer
 
-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.
+In order to utilize the Mercury 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
@@ -43,13 +49,7 @@ export MERCURY_JWT="<YOUR.MERCURY.JWT>"
 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
+## TypeScript gotchas
 
 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.
 
@@ -60,7 +60,8 @@ const nextConfig = {
     transpilePackages: [
         'passkey-kit', 
         'passkey-factory-sdk', 
-        'passkey-kit-sdk'
+        'passkey-kit-sdk',
+        'sac-sdk',
     ]
 };
 
@@ -71,10 +72,10 @@ If someone smarter than me knows how to include an optional JS build from a TS l
 ## Contributing 
 
 Passkey kit consists of three primary directories:
-- `./contracts` - Contains the Rust Soroban smart contracts of the smart wallet implementation.
-- `./zephyr` - Contains the [Zephyr](https://www.mercurydata.app/products/zephyr-vm) program for processing smart wallet events.
 - `./src` - Contains the TypeScript files for the actual TS SDK library.
 - `./demo` - Contains a basic demo of the SDK in action.
+- `./contracts` - Contains the Rust Soroban smart contracts of the smart wallet implementation.
+- `./zephyr` - Contains the [Zephyr](https://www.mercurydata.app/products/zephyr-vm) program for processing smart wallet events.
 
 To install dependencies:
 

package/cheatsheet

@@ -9,7 +9,7 @@ pnpm publish --no-git-checks
 
 export MERCURY_JWT=???
 mercury-cli --jwt $MERCURY_JWT --local false --mainnet false deploy
-mercury-cli --jwt $MERCURY_JWT --local false --mainnet false catchup --contracts "CCXIUFR243N7QWKXY44LZO3DVUXHAVBEEJWFGNGNVVB44VJXIYWVGNTR" # don't forget to subscribe to the contract first
+mercury-cli --jwt $MERCURY_JWT --local false --mainnet false catchup --contracts "CDOWBLFYFIWXVUW46QILLAIYIWWCZ63CIRQBG3DK5PDBUVVJ4QVJX2IX" # don't forget to subscribe to the contract first
 curl -X GET https://api.mercurydata.app/catchups/4
 curl -X POST https://api.mercurydata.app/zephyr/execute -H "Authorization: Bearer $MERCURY_JWT" -H 'Content-Type: application/json' -d '{"mode":{"Function": {"fname": "get_signers_by_address", "arguments": "{\"address\": \"CCXIUFR243N7QWKXY44LZO3DVUXHAVBEEJWFGNGNVVB44VJXIYWVGNTR\"}"}}}'
 curl -X POST https://api.mercurydata.app/zephyr/execute -H "Authorization: Bearer $MERCURY_JWT" -H 'Content-Type: application/json' -d '{"mode":{"Function": {"fname": "get_address_by_signer", "arguments": "{\"id\": [78,127,30,69,248,174,95,168,47,59,161,168,51,120,117,135,112,133,232,92]}"}}}'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "passkey-kit",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "A helper library for creating and using passkey accounts on the Stellar blockchain.",
   "author": "Tyler van der Hoeven",
   "license": "MIT",
@@ -8,13 +8,14 @@
   "main": "src/index.ts",
   "types": "types/index.d.ts",
   "dependencies": {
+    "@darkedges/capacitor-native-webauthn": "^0.0.4",
     "@simplewebauthn/browser": "^10.0.0",
     "@stellar/stellar-sdk": "12.1.0",
     "base64url": "^3.0.1",
     "buffer": "^6.0.3",
-    "sac-sdk": "0.1.0",
+    "passkey-factory-sdk": "0.2.1",
     "passkey-kit-sdk": "0.2.1",
-    "passkey-factory-sdk": "0.2.1"
+    "sac-sdk": "0.1.0"
   },
   "devDependencies": {
     "@simplewebauthn/types": "^10.0.0",

package/src/kit.ts

@@ -6,6 +6,7 @@ import { startRegistration, startAuthentication } from "@simplewebauthn/browser"
 import type { AuthenticatorAttestationResponseJSON } from "@simplewebauthn/types"
 import { Buffer } from 'buffer'
 import { PasskeyBase } from './base'
+import { DEFAULT_TIMEOUT } from '@stellar/stellar-sdk/contract'
 
 export class PasskeyKit extends PasskeyBase {
     declare public rpc: SorobanRpc.Server
@@ -14,11 +15,19 @@ export class PasskeyKit extends PasskeyBase {
     public networkPassphrase: string
     public factory: FactoryClient
     public wallet: PasskeyClient | undefined
+    public WebAuthn: {
+        startRegistration: typeof startRegistration,
+        startAuthentication: typeof startAuthentication
+    }
 
     constructor(options: {
         rpcUrl: string,
         networkPassphrase: string,
         factoryContractId: string,
+        WebAuthn?: {
+            startRegistration: typeof startRegistration,
+            startAuthentication: typeof startAuthentication
+        }
     }) {
         const { rpcUrl, networkPassphrase, factoryContractId } = options
 
@@ -30,6 +39,7 @@ export class PasskeyKit extends PasskeyBase {
             networkPassphrase,
             rpcUrl
         })
+        this.WebAuthn = options.WebAuthn || { startRegistration, startAuthentication }
     }
 
     public async createWallet(app: string, user: string) {
@@ -41,7 +51,7 @@ export class PasskeyKit extends PasskeyBase {
             pk: publicKey
         })
 
-        const contractId = result.unwrap() as string
+        const contractId = result.unwrap()
 
         this.wallet = new PasskeyClient({
             contractId,
@@ -52,14 +62,14 @@ export class PasskeyKit extends PasskeyBase {
         return {
             keyId,
             contractId,
-            xdr: built!.toXDR() as string
+            xdr: built?.toXDR()
         }
     }
 
     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 this.WebAuthn.startRegistration({
             challenge: base64url("stellaristhebetterblockchain"),
             rp: {
                 // id: undefined,
@@ -71,9 +81,9 @@ export class PasskeyKit extends PasskeyBase {
                 displayName
             },
             // authenticatorSelection: {
-                // requireResidentKey: false,
-                // residentKey: "preferred",
-                // userVerification: "discouraged",
+            // requireResidentKey: false,
+            // residentKey: "preferred",
+            // userVerification: "discouraged",
             // },
             pubKeyCredParams: [{ alg: -7, type: "public-key" }],
             // attestation: "none",
@@ -97,7 +107,7 @@ export class PasskeyKit extends PasskeyBase {
         let keyIdBuffer: Buffer
 
         if (!keyId) {
-            const response = await startAuthentication({
+            const response = await this.WebAuthn.startAuthentication({
                 challenge: base64url("stellaristhebetterblockchain"),
                 // rpId: undefined,
                 // userVerification: "discouraged",
@@ -162,8 +172,7 @@ export class PasskeyKit extends PasskeyBase {
             ledgersToLive?: number
         }
     ) {
-        // 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 || {}
+        let { keyId, ledgersToLive = DEFAULT_TIMEOUT } = options || {}
 
         const lastLedger = await this.rpc.getLatestLedger().then(({ sequence }) => sequence)
         const credentials = entry.credentials().address();
@@ -177,7 +186,7 @@ export class PasskeyKit extends PasskeyBase {
         )
         const payload = hash(preimage.toXDR())
 
-        const authenticationResponse = await startAuthentication(
+        const authenticationResponse = await this.WebAuthn.startAuthentication(
             keyId === 'any'
                 || (!keyId && !this.keyId)
                 ? {
@@ -242,7 +251,7 @@ export class PasskeyKit extends PasskeyBase {
                 && auth.credentials().address().address().switch().name === 'scAddressTypeContract'
             ) {
                 // If auth entry matches our Smart Wallet move forward with the signature request
-                if (Address.contract(auth.credentials().address().address().contractId()).toString() === this.wallet!.options.contractId)
+                if (Address.contract(auth.credentials().address().address().contractId()).toString() === this.wallet?.options.contractId)
                     await this.signAuthEntry(auth, options)
             }
         }
@@ -309,7 +318,7 @@ export class PasskeyKit extends PasskeyBase {
 
         if (response.publicKey) {
             publicKey = base64url.toBuffer(response.publicKey)
-            publicKey = publicKey!.slice(publicKey!.length - 65)
+            publicKey = publicKey?.slice(publicKey.length - 65)
         }
 
         if (
@@ -331,7 +340,7 @@ export class PasskeyKit extends PasskeyBase {
 
                 let publicKeykPrefixSlice = Buffer.from([0xa5, 0x01, 0x02, 0x03, 0x26, 0x20, 0x01, 0x21, 0x58, 0x20])
                 let startIndex = attestationObject.indexOf(publicKeykPrefixSlice)
-                    startIndex = startIndex + publicKeykPrefixSlice.length
+                startIndex = startIndex + publicKeykPrefixSlice.length
 
                 x = attestationObject.slice(startIndex, 32 + startIndex)
                 y = attestationObject.slice(35 + startIndex, 67 + startIndex)

package/src/server.ts

@@ -167,6 +167,7 @@ export class PasskeyServer extends PasskeyBase {
             @Later
     */
 
+    // TODO maybe fee should default to something more dynamic since we have endpoints for getting fee information now
     public async send(xdr: string, fee: number = 10_000) {
         if (!this.launchtubeUrl || !this.launchtubeJwt)
             throw new Error('Launchtube service not configured')

package/tsconfig.json

@@ -6,7 +6,7 @@
     "module": "ESNext",
     "moduleDetection": "force",
     // Bundler mode
-    "moduleResolution": "node",
+    "moduleResolution": "Bundler",
     "allowImportingTsExtensions": true,
     "verbatimModuleSyntax": true,
     "declaration": true,
@@ -21,12 +21,7 @@
     "noPropertyAccessFromIndexSignature": false,
     "strictNullChecks": true,
   },
-  "exclude": [
-    "./bun_tests",
-    "./contracts",
-    "./demo",
-    "./packages",
-    "./types",
-    "./zephyr",
-  ]
+  "include": [
+    "src/*",
+  ],
 }

package/types/kit.d.ts

@@ -1,6 +1,7 @@
 import { Client as PasskeyClient } from 'passkey-kit-sdk';
 import { Client as FactoryClient } from 'passkey-factory-sdk';
 import { xdr, Transaction, SorobanRpc } from '@stellar/stellar-sdk';
+import { startRegistration, startAuthentication } from "@simplewebauthn/browser";
 import { Buffer } from 'buffer';
 import { PasskeyBase } from './base';
 export declare class PasskeyKit extends PasskeyBase {
@@ -10,15 +11,23 @@ export declare class PasskeyKit extends PasskeyBase {
     networkPassphrase: string;
     factory: FactoryClient;
     wallet: PasskeyClient | undefined;
+    WebAuthn: {
+        startRegistration: typeof startRegistration;
+        startAuthentication: typeof startAuthentication;
+    };
     constructor(options: {
         rpcUrl: string;
         networkPassphrase: string;
         factoryContractId: string;
+        WebAuthn?: {
+            startRegistration: typeof startRegistration;
+            startAuthentication: typeof startAuthentication;
+        };
     });
     createWallet(app: string, user: string): Promise<{
         keyId: Buffer;
         contractId: string;
-        xdr: string;
+        xdr: string | undefined;
     }>;
     createKey(app: string, user: string): Promise<{
         keyId: Buffer;