passkey-kit 0.7.2 → 0.7.4

package/cheatsheet

@@ -13,7 +13,7 @@ stellar contract deploy --wasm target/wasm32-unknown-unknown/release/sample_poli
 
 export JWT=???
 mercury-cli --jwt $JWT --local false --mainnet false deploy
-mercury-cli --jwt $JWT --local false --mainnet false catchup --project-name "smart-wallets-data-multi-signer-multi-sig" --contracts "CDONKSPO6DUH46JRRIAK4O5ZINA5C2RXHP57BMFHKVBGOQXAT3IW6QCO"
+mercury-cli --jwt $JWT --local false --mainnet false catchup --project-name "smart-wallets-data-multi-signer-multi-sig" --contracts "CBMMJ55OQSFSYASVENVHW55QNA4Q52GE42P23E4V7O37GKMETKOFFENA"
 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\": \"CA4G3X75IGGNXNLXFIVFNYIGC6YAVLA7KSIFFDBSR7RQ7KEZMZWLXQBH\"}"}}}'
 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.7.2",
+  "version": "0.7.4",
   "description": "A helper library for creating and using passkey accounts on the Stellar blockchain.",
   "author": "Tyler van der Hoeven",
   "license": "MIT",

package/src/index.ts

@@ -1,5 +1,5 @@
 import { PasskeyServer } from "./server"
-import { PasskeyKit, DEFAULT_LTL } from "./kit"
+import { PasskeyKit } from "./kit"
 import { SACClient } from "./sac"
 
-export { PasskeyServer, PasskeyKit, SACClient, DEFAULT_LTL }
+export { PasskeyServer, PasskeyKit, SACClient }

package/src/kit.ts

@@ -1,14 +1,12 @@
 import { Client as PasskeyClient, type Signature, type SignerKey } from 'passkey-kit-sdk'
 import { Client as FactoryClient } from 'passkey-factory-sdk'
-import { Address, StrKey, hash, xdr, Transaction, SorobanRpc, Operation, TransactionBuilder, Keypair } from '@stellar/stellar-sdk'
+import { Address, StrKey, hash, xdr, SorobanRpc, Keypair, Transaction } from '@stellar/stellar-sdk'
 import base64url from 'base64url'
 import { startRegistration, startAuthentication } from "@simplewebauthn/browser"
 import type { AuthenticatorAttestationResponseJSON, AuthenticatorSelectionCriteria } from "@simplewebauthn/types"
 import { Buffer } from 'buffer'
 import { PasskeyBase } from './base'
-import { DEFAULT_TIMEOUT } from '@stellar/stellar-sdk/contract'
-
-export const DEFAULT_LTL = 12
+import { DEFAULT_TIMEOUT, type Tx } from '@stellar/stellar-sdk/contract'
 
 export class PasskeyKit extends PasskeyBase {
     declare public rpc: SorobanRpc.Server
@@ -77,7 +75,7 @@ export class PasskeyKit extends PasskeyBase {
         return {
             keyId,
             contractId,
-            xdr: built.toXDR()
+            built
         }
     }
 
@@ -195,20 +193,28 @@ export class PasskeyKit extends PasskeyBase {
         if (keyId && keypair)
             throw new Error('Provide either `options.keyId` or `options.keypair` but not both')
 
+        const credentials = entry.credentials().address();
+
         if (!validUntilLedgerSeq) {
-            const lastLedger = await this.rpc.getLatestLedger().then(({ sequence }) => sequence)
-            validUntilLedgerSeq = lastLedger + DEFAULT_TIMEOUT / 5;
+            validUntilLedgerSeq = credentials.signatureExpirationLedger()
+
+            if (!validUntilLedgerSeq) {
+                const lastLedger = await this.rpc.getLatestLedger().then(({ sequence }) => sequence)
+                validUntilLedgerSeq = lastLedger + DEFAULT_TIMEOUT / 5;
+            }
         }
 
-        const credentials = entry.credentials().address();
+        credentials.signatureExpirationLedger(validUntilLedgerSeq)
+        
         const preimage = xdr.HashIdPreimage.envelopeTypeSorobanAuthorization(
             new xdr.HashIdPreimageSorobanAuthorization({
                 networkId: hash(Buffer.from(this.networkPassphrase)),
                 nonce: credentials.nonce(),
-                signatureExpirationLedger: validUntilLedgerSeq,
+                signatureExpirationLedger: credentials.signatureExpirationLedger(),
                 invocation: entry.rootInvocation()
             })
         )
+        
         const payload = hash(preimage.toXDR())
 
         let key: SignerKey
@@ -295,15 +301,16 @@ export class PasskeyKit extends PasskeyBase {
                 credentials.signature(xdr.ScVal.scvMap([scEntry]))
                 break;
             case 'scvMap':
+                // Add the new signature to the existing map
                 credentials.signature().map()?.push(scEntry)
+                // Order the map by key
+                credentials.signature().map()?.sort((a, b) => 
+                    a.key().toXDR().compare(b.key().toXDR())
+                )
                 break;
             default:
                 throw new Error('Unsupported signature')
         }
-
-        credentials.signatureExpirationLedger(validUntilLedgerSeq)
-
-        return entry
     }
 
     public async signAuthEntries(
@@ -315,6 +322,8 @@ export class PasskeyKit extends PasskeyBase {
             validUntilLedgerSeq?: number
         }
     ) {
+        // TODO should there be more control over which auth entries are signed? Especially given we support multiple signers now?
+        // As-is .sign() will always sign every smart wallet auth entry. This may be okay but likely we should have more control over which auth entry the signer is signing
         for (const auth of entries) {
             if (
                 auth.credentials().switch().name === 'sorobanCredentialsAddress'
@@ -325,12 +334,10 @@ export class PasskeyKit extends PasskeyBase {
                     await this.signAuthEntry(auth, options)
             }
         }
-
-        return entries
     }
 
     public async sign(
-        txn: Transaction | string,
+        txn: Transaction,
         options?: {
             rpId?: string,
             keyId?: 'any' | string | Uint8Array
@@ -338,41 +345,29 @@ export class PasskeyKit extends PasskeyBase {
             validUntilLedgerSeq?: number
         }
     ) {
-        txn = this.getTxn(txn)
-
-        // Only need to sign auth for `invokeHostFunction` operations
-        if (txn.operations[0].type === 'invokeHostFunction') {
-            const entries = txn.operations[0].auth
+        const entries = this.getAuthEntries(txn)
 
-            if (entries)
-                await this.signAuthEntries(entries, options)
-        }
-
-        return txn.toXDR()
+        if (entries)
+            await this.signAuthEntries(entries, options)
     }
 
     public async attachPolicy(
-        txn: Transaction | string,
+        txn: Transaction,
         index: number,
         policy: string
     ) {
-        txn = this.getTxn(txn)
-
-        // Only need to sign auth for `invokeHostFunction` operations
-        if (txn.operations[0].type !== 'invokeHostFunction')
-            return txn.toXDR()
-
         if (!this.wallet)
             throw new Error('Wallet not connected')
 
-        let context_arg: xdr.ScVal
-
-        const auth = txn.operations[0].auth?.[index]
+        const entries = this.getAuthEntries(txn)
+        const auth = entries?.[index]
         const context = auth?.rootInvocation().function()
 
-        if (!auth || !context)
+        if (!entries || !auth || !context)
             throw new Error('No context found')
 
+        let context_arg: xdr.ScVal
+
         switch (context.switch().name) {
             case 'sorobanAuthorizedFunctionTypeContractFn':
                 switch (context.contractFn().contractAddress().switch().name) {
@@ -453,19 +448,14 @@ export class PasskeyKit extends PasskeyBase {
             rootInvocation: __check_auth_invocation,
         });
 
-        txn.operations[0].auth?.push(__check_auth)
-
-        return txn.toXDR()
+        entries.push(__check_auth)
     }
 
-    private getTxn(txn: Transaction | string): Transaction {
-        txn = TransactionBuilder.cloneFrom(new Transaction(
-            typeof txn === 'string'
-                ? txn
-                : txn.toXDR(),
-            this.networkPassphrase
-        ), { fee: '0' }).build()
+    public prepareTransaction(txn: Tx) {
+        return new Transaction(txn.toXDR(), this.networkPassphrase);
+    }
 
+    private getAuthEntries(txn: Transaction) {
         if (txn.operations.length !== 1)
             throw new Error('Must include only one Soroban operation')
 
@@ -477,7 +467,13 @@ export class PasskeyKit extends PasskeyBase {
             ) throw new Error('Must include only one operation of type `invokeHostFunction` or `extendFootprintTtl` or `restoreFootprint`')
         }
 
-        return txn
+        // Only need to sign auth for `invokeHostFunction` operations
+        if (txn.operations[0].type === 'invokeHostFunction') {
+            const entries = txn.operations[0].auth
+
+            if (entries && entries.length)
+                return entries
+        }
     }
 
     /* LATER 

package/src/server.ts

@@ -1,4 +1,4 @@
-import { SorobanRpc, xdr } from "@stellar/stellar-sdk"
+import { SorobanRpc, Transaction, xdr } from "@stellar/stellar-sdk"
 import { PasskeyBase } from "./base"
 import base64url from "base64url"
 
@@ -123,13 +123,13 @@ export class PasskeyServer extends PasskeyBase {
         - Add a method for getting a paginated or filtered list of all a wallet's events
     */
 
-    public async send(xdr: string, fee?: number) {
+    public async send(txn: Transaction, fee?: number) {
         if (!this.launchtubeUrl || !this.launchtubeJwt)
             throw new Error('Launchtube service not configured')
 
         const data = new FormData();
 
-        data.set('xdr', xdr);
+        data.set('xdr', txn.toXDR());
 
         if (fee)
             data.set('fee', fee.toString());

package/types/index.d.ts

@@ -1,4 +1,4 @@
 import { PasskeyServer } from "./server";
-import { PasskeyKit, DEFAULT_LTL } from "./kit";
+import { PasskeyKit } from "./kit";
 import { SACClient } from "./sac";
-export { PasskeyServer, PasskeyKit, SACClient, DEFAULT_LTL };
+export { PasskeyServer, PasskeyKit, SACClient };

package/types/kit.d.ts

@@ -1,11 +1,11 @@
 import { Client as PasskeyClient } from 'passkey-kit-sdk';
 import { Client as FactoryClient } from 'passkey-factory-sdk';
-import { xdr, Transaction, SorobanRpc, Keypair } from '@stellar/stellar-sdk';
+import { xdr, SorobanRpc, Keypair, Transaction } from '@stellar/stellar-sdk';
 import { startRegistration, startAuthentication } from "@simplewebauthn/browser";
 import type { AuthenticatorSelectionCriteria } from "@simplewebauthn/types";
 import { Buffer } from 'buffer';
 import { PasskeyBase } from './base';
-export declare const DEFAULT_LTL = 12;
+import { type Tx } from '@stellar/stellar-sdk/contract';
 export declare class PasskeyKit extends PasskeyBase {
     rpc: SorobanRpc.Server;
     rpcUrl: string;
@@ -29,7 +29,7 @@ export declare class PasskeyKit extends PasskeyBase {
     createWallet(app: string, user: string): Promise<{
         keyId: Buffer;
         contractId: string;
-        xdr: string;
+        built: Tx;
     }>;
     createKey(app: string, user: string, settings?: {
         rpId?: string;
@@ -51,21 +51,22 @@ export declare class PasskeyKit extends PasskeyBase {
         keyId?: 'any' | string | Uint8Array;
         keypair?: Keypair;
         validUntilLedgerSeq?: number;
-    }): Promise<xdr.SorobanAuthorizationEntry>;
+    }): Promise<void>;
     signAuthEntries(entries: xdr.SorobanAuthorizationEntry[], options?: {
         rpId?: string;
         keyId?: 'any' | string | Uint8Array;
         keypair?: Keypair;
         validUntilLedgerSeq?: number;
-    }): Promise<xdr.SorobanAuthorizationEntry[]>;
-    sign(txn: Transaction | string, options?: {
+    }): Promise<void>;
+    sign(txn: Transaction, options?: {
         rpId?: string;
         keyId?: 'any' | string | Uint8Array;
         keypair?: Keypair;
         validUntilLedgerSeq?: number;
-    }): Promise<string>;
-    attachPolicy(txn: Transaction | string, index: number, policy: string): Promise<string>;
-    private getTxn;
+    }): Promise<void>;
+    attachPolicy(txn: Transaction, index: number, policy: string): Promise<void>;
+    prepareTransaction(txn: Tx): Transaction<import("@stellar/stellar-sdk").Memo<import("@stellar/stellar-sdk").MemoType>, import("@stellar/stellar-sdk").Operation[]>;
+    private getAuthEntries;
     private getPublicKey;
     private compactSignature;
 }

package/types/server.d.ts

@@ -1,3 +1,4 @@
+import { Transaction } from "@stellar/stellar-sdk";
 import { PasskeyBase } from "./base";
 export declare class PasskeyServer extends PasskeyBase {
     launchtubeUrl: string | undefined;
@@ -19,5 +20,5 @@ export declare class PasskeyServer extends PasskeyBase {
         expired?: boolean;
     }[]>;
     getContractId(keyId: string): Promise<any>;
-    send(xdr: string, fee?: number): Promise<any>;
+    send(txn: Transaction, fee?: number): Promise<any>;
 }