passkey-kit 0.2.0 → 0.2.1

package/cheatsheet

@@ -0,0 +1,5 @@
+# Install contract sdks
+npm publish --workspaces   
+
+# Install passkey-kit
+pnpm publish --no-git-checks

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "passkey-kit",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A helper library for creating and using passkey accounts on the Stellar blockchain.",
   "author": "Tyler van der Hoeven",
   "license": "MIT",
@@ -14,8 +14,8 @@
     "bigint-conversion": "^2.4.3",
     "buffer": "^6.0.3",
     "cbor-x": "^1.5.9",
-    "passkey-factory-sdk": "0.0.7",
-    "passkey-kit-sdk": "0.0.7"
+    "passkey-factory-sdk": "0.0.8",
+    "passkey-kit-sdk": "0.0.8"
   },
   "devDependencies": {
     "typescript": "^5.4.5"

package/packages/passkey-factory-sdk/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.7",
+  "version": "0.0.8",
   "name": "passkey-factory-sdk",
   "type": "module",
   "main": "src/index.ts",

package/packages/passkey-factory-sdk/src/index.ts

@@ -1,12 +1,10 @@
 import { Buffer } from "buffer";
 import {
-  Client as ContractClient,
-  Spec as ContractSpec,
-} from '@stellar/stellar-sdk/contract';
-import type {
   AssembledTransaction,
+  Client as ContractClient,
   ClientOptions as ContractClientOptions,
   Result,
+  Spec as ContractSpec,
 } from '@stellar/stellar-sdk/contract';
 
 if (typeof window !== 'undefined') {
@@ -17,7 +15,7 @@ if (typeof window !== 'undefined') {
 export const networks = {
   testnet: {
     networkPassphrase: "Test SDF Network ; September 2015",
-    contractId: "CDSGG7BSWYWQMTY5KTZVDTC34ZESMZ75ZGSTTVHS4NIKCF4PM3GDJ4G3",
+    contractId: "CBXQAM53YVVPKAPS2NCSOCXTOK6HOXA3JLURVLD6VFQUHJPKFVBJIBHQ",
   }
 } as const
 

package/packages/passkey-factory-sdk/types/index.d.ts

@@ -1,10 +1,9 @@
 import { Buffer } from "buffer";
-import { Client as ContractClient } from '@stellar/stellar-sdk/contract';
-import type { AssembledTransaction, ClientOptions as ContractClientOptions, Result } from '@stellar/stellar-sdk/contract';
+import { AssembledTransaction, Client as ContractClient, ClientOptions as ContractClientOptions, Result } from '@stellar/stellar-sdk/contract';
 export declare const networks: {
     readonly testnet: {
         readonly networkPassphrase: "Test SDF Network ; September 2015";
-        readonly contractId: "CDSGG7BSWYWQMTY5KTZVDTC34ZESMZ75ZGSTTVHS4NIKCF4PM3GDJ4G3";
+        readonly contractId: "CBXQAM53YVVPKAPS2NCSOCXTOK6HOXA3JLURVLD6VFQUHJPKFVBJIBHQ";
     };
 };
 export declare const Errors: {

package/packages/passkey-kit-sdk/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.7",
+  "version": "0.0.8",
   "name": "passkey-kit-sdk",
   "type": "module",
   "main": "src/index.ts",

package/packages/passkey-kit-sdk/src/index.ts

@@ -1,12 +1,10 @@
 import { Buffer } from "buffer";
 import {
-  Client as ContractClient,
-  Spec as ContractSpec,
-} from '@stellar/stellar-sdk/contract';
-import type {
   AssembledTransaction,
+  Client as ContractClient,
   ClientOptions as ContractClientOptions,
   Result,
+  Spec as ContractSpec,
 } from '@stellar/stellar-sdk/contract';
 
 if (typeof window !== 'undefined') {
@@ -17,7 +15,7 @@ if (typeof window !== 'undefined') {
 export const networks = {
   testnet: {
     networkPassphrase: "Test SDF Network ; September 2015",
-    contractId: "CDSGG7BSWYWQMTY5KTZVDTC34ZESMZ75ZGSTTVHS4NIKCF4PM3GDJ4G3",
+    contractId: "CBXQAM53YVVPKAPS2NCSOCXTOK6HOXA3JLURVLD6VFQUHJPKFVBJIBHQ",
   }
 } as const
 
@@ -82,6 +80,26 @@ export interface Client {
     simulate?: boolean;
   }) => Promise<AssembledTransaction<Result<void>>>
 
+  /**
+   * Construct and simulate a upgrade transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+   */
+  upgrade: ({ hash }: { hash: Buffer }, options?: {
+    /**
+     * The fee to pay for the transaction. Default: BASE_FEE
+     */
+    fee?: number;
+
+    /**
+     * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+     */
+    timeoutInSeconds?: number;
+
+    /**
+     * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+     */
+    simulate?: boolean;
+  }) => Promise<AssembledTransaction<Result<void>>>
+
   /**
    * Construct and simulate a resudo transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
    */
@@ -148,6 +166,7 @@ export class Client extends ContractClient {
       new ContractSpec(["AAAABAAAAAAAAAAAAAAABUVycm9yAAAAAAAACgAAAAAAAAAJTm90SW5pdGVkAAAAAAAAAQAAAAAAAAAITm90Rm91bmQAAAACAAAAAAAAAAxOb3RQZXJtaXR0ZWQAAAADAAAAAAAAAA1BbHJlYWR5SW5pdGVkAAAAAAAABAAAAAAAAAAOSnNvblBhcnNlRXJyb3IAAAAAAAUAAAAAAAAADkludmFsaWRDb250ZXh0AAAAAAAGAAAAAAAAACBDbGllbnREYXRhSnNvbkNoYWxsZW5nZUluY29ycmVjdAAAAAcAAAAAAAAAF1NlY3AyNTZyMVB1YmxpY0tleVBhcnNlAAAAAAgAAAAAAAAAF1NlY3AyNTZyMVNpZ25hdHVyZVBhcnNlAAAAAAkAAAAAAAAAFVNlY3AyNTZyMVZlcmlmeUZhaWxlZAAAAAAAAAo=",
         "AAAAAAAAAAAAAAAKZXh0ZW5kX3R0bAAAAAAAAAAAAAA=",
         "AAAAAAAAAAAAAAAEaW5pdAAAAAMAAAAAAAAAAmlkAAAAAAAOAAAAAAAAAAJwawAAAAAD7gAAAEEAAAAAAAAAB2ZhY3RvcnkAAAAAEwAAAAEAAAPpAAAD7QAAAAAAAAAD",
+        "AAAAAAAAAAAAAAAHdXBncmFkZQAAAAABAAAAAAAAAARoYXNoAAAD7gAAACAAAAABAAAD6QAAA+0AAAAAAAAAAw==",
         "AAAAAAAAAAAAAAAGcmVzdWRvAAAAAAABAAAAAAAAAAJpZAAAAAAADgAAAAEAAAPpAAAD7QAAAAAAAAAD",
         "AAAAAAAAAAAAAAAGcm1fc2lnAAAAAAABAAAAAAAAAAJpZAAAAAAADgAAAAEAAAPpAAAD7QAAAAAAAAAD",
         "AAAAAAAAAAAAAAAHYWRkX3NpZwAAAAACAAAAAAAAAAJpZAAAAAAADgAAAAAAAAACcGsAAAAAA+4AAABBAAAAAQAAA+kAAAPtAAAAAAAAAAM=",
@@ -159,6 +178,7 @@ export class Client extends ContractClient {
   public readonly fromJSON = {
     extend_ttl: this.txFromJSON<null>,
     init: this.txFromJSON<Result<void>>,
+    upgrade: this.txFromJSON<Result<void>>,
     resudo: this.txFromJSON<Result<void>>,
     rm_sig: this.txFromJSON<Result<void>>,
     add_sig: this.txFromJSON<Result<void>>,

package/packages/passkey-kit-sdk/types/index.d.ts

@@ -1,10 +1,9 @@
 import { Buffer } from "buffer";
-import { Client as ContractClient } from '@stellar/stellar-sdk/contract';
-import type { AssembledTransaction, ClientOptions as ContractClientOptions, Result } from '@stellar/stellar-sdk/contract';
+import { AssembledTransaction, Client as ContractClient, ClientOptions as ContractClientOptions, Result } from '@stellar/stellar-sdk/contract';
 export declare const networks: {
     readonly testnet: {
         readonly networkPassphrase: "Test SDF Network ; September 2015";
-        readonly contractId: "CDSGG7BSWYWQMTY5KTZVDTC34ZESMZ75ZGSTTVHS4NIKCF4PM3GDJ4G3";
+        readonly contractId: "CBXQAM53YVVPKAPS2NCSOCXTOK6HOXA3JLURVLD6VFQUHJPKFVBJIBHQ";
     };
 };
 export declare const Errors: {
@@ -84,6 +83,25 @@ export interface Client {
          */
         simulate?: boolean;
     }) => Promise<AssembledTransaction<Result<void>>>;
+    /**
+     * Construct and simulate a upgrade transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    upgrade: ({ hash }: {
+        hash: Buffer;
+    }, options?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<Result<void>>>;
     /**
      * Construct and simulate a resudo transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
      */
@@ -149,6 +167,7 @@ export declare class Client extends ContractClient {
     readonly fromJSON: {
         extend_ttl: (json: string) => AssembledTransaction<null>;
         init: (json: string) => AssembledTransaction<Result<void, import("@stellar/stellar-sdk/contract").ErrorMessage>>;
+        upgrade: (json: string) => AssembledTransaction<Result<void, import("@stellar/stellar-sdk/contract").ErrorMessage>>;
         resudo: (json: string) => AssembledTransaction<Result<void, import("@stellar/stellar-sdk/contract").ErrorMessage>>;
         rm_sig: (json: string) => AssembledTransaction<Result<void, import("@stellar/stellar-sdk/contract").ErrorMessage>>;
         add_sig: (json: string) => AssembledTransaction<Result<void, import("@stellar/stellar-sdk/contract").ErrorMessage>>;

package/src/base.ts

@@ -1,54 +1,42 @@
-import { Networks, Transaction, Horizon, FeeBumpTransaction } from '@stellar/stellar-sdk'
-
 export class PasskeyBase {
-    public networkPassphrase: Networks
-    public horizonUrl: string
-    public horizon: Horizon.Server
-    public feeBumpUrl: string | undefined
-    public feeBumpJwt: string | undefined
+    public launchtubeUrl: string | undefined
+    public launchtubeJwt: string | undefined
 
     constructor(options: {
-        networkPassphrase: Networks,
-        horizonUrl: string,
-        feeBumpUrl?: string,
-        feeBumpJwt?: string,
+        launchtubeUrl?: string,
+        launchtubeJwt?: string,
     }) {
         const {
-            networkPassphrase,
-            horizonUrl,
-            feeBumpUrl,
-            feeBumpJwt,
+            launchtubeUrl,
+            launchtubeJwt,
         } = options
 
-        this.networkPassphrase = networkPassphrase
-        this.horizonUrl = horizonUrl
-        this.horizon = new Horizon.Server(horizonUrl)
-
-        if (feeBumpUrl)
-            this.feeBumpUrl = feeBumpUrl
+        if (launchtubeUrl)
+            this.launchtubeUrl = launchtubeUrl
 
-        if (feeBumpJwt)
-            this.feeBumpJwt = feeBumpJwt
+        if (launchtubeJwt)
+            this.launchtubeJwt = launchtubeJwt
     }
 
-    public async send(txn: Transaction, fee: number = 10_000) {
+    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', txn.toXDR());
+        data.set('xdr', xdr);
         data.set('fee', fee.toString());
 
-        const bumptxn = await fetch(this.feeBumpUrl!, {
+        return fetch(this.launchtubeUrl, {
             method: 'POST',
             headers: {
-                authorization: `Bearer ${this.feeBumpJwt}`,
+                authorization: `Bearer ${this.launchtubeJwt}`,
             },
             body: data
         }).then(async (res) => {
             if (res.ok)
-                return res.text()
+                return res.json()
             else throw await res.json()
         })
-
-        return this.horizon.submitTransaction(new FeeBumpTransaction(bumptxn, this.networkPassphrase))
     }
 }

package/src/kit.ts

@@ -1,6 +1,6 @@
 import { Client as PasskeyClient } from 'passkey-kit-sdk'
 import { Client as FactoryClient, networks } from 'passkey-factory-sdk'
-import { Address, Networks, StrKey, hash, xdr, Transaction, Horizon, SorobanRpc, Operation, scValToNative, TransactionBuilder } from '@stellar/stellar-sdk'
+import { Address, Networks, StrKey, hash, xdr, Transaction, SorobanRpc, Operation, scValToNative, TransactionBuilder } from '@stellar/stellar-sdk'
 import { bufToBigint, bigintToBuf } from 'bigint-conversion'
 import base64url from 'base64url'
 import { startRegistration, startAuthentication } from "@simplewebauthn/browser"
@@ -14,10 +14,6 @@ import { PasskeyBase } from './base'
         @Later
 
     - Right now publicKey can mean a Stellar public key or a passkey public key, there should be a noted difference
-
-    - It's finally time to make a server and a client version of this package
-        Maybe. I want to support passing "bad" secret values on the client. 
-            It's maybe only the server that could be smaller and cleaner by opting out out WebAuthN stuff
 */
 
 export class PasskeyKit extends PasskeyBase {
@@ -25,57 +21,45 @@ export class PasskeyKit extends PasskeyBase {
     public sudoKeyId: string | undefined
     public wallet: PasskeyClient | undefined
     public factory: FactoryClient
-    public sequencePublicKey: string
-    // public networkPassphrase: Networks
-    // public horizonUrl: string
-    public horizon: Horizon.Server
+    public networkPassphrase: Networks
     public rpcUrl: string
     public rpc: SorobanRpc.Server
-    // public feeBumpUrl: string | undefined
-    // public feeBumpJwt: string | undefined
     public factoryContractId: string = networks.testnet.contractId
 
     /* TODO 
         - Consider adding the ability to pass in a keyId and maybe even a contractId in order to preconnect to a wallet
             If just a keyId call `connectWallet` in order to get the contractId
             If both keyId and contractId are passed in then we can skip the connectWallet call (though we won't get the sudoKeyId in that case)
-            We don't stictly _need_ this as a dev can just call `connectWallet` after class instantiation but it might be a nice convenience
+            We don't strictly _need_ this as a dev can just call `connectWallet` after class instantiation but it might be a nice convenience
             @Later
     */
+
     constructor(options: {
-        sequencePublicKey: string,
         networkPassphrase: Networks,
-        horizonUrl: string,
         rpcUrl: string,
-        feeBumpUrl?: string,
-        feeBumpJwt?: string,
+        launchtubeUrl?: string,
+        launchtubeJwt?: string,
         /* TODO 
             - Maybe remove this? The factory should likely be baked in a bit more tightly
                 On the other hand once we have a standard interface the factory interface only uses the `deploy` method right now inside the interface
-                @Later
+                @No
         */
-        factoryContractId?: string, 
+        factoryContractId?: string,
     }) {
         const {
-            sequencePublicKey,
             networkPassphrase,
-            horizonUrl,
             rpcUrl,
-            feeBumpUrl,
-            feeBumpJwt,
+            launchtubeUrl,
+            launchtubeJwt,
             factoryContractId
         } = options
 
         super({
-            networkPassphrase,
-            horizonUrl,
-            feeBumpUrl,
-            feeBumpJwt,
+            launchtubeUrl,
+            launchtubeJwt,
         })
 
-        this.sequencePublicKey = sequencePublicKey
-        
-        this.horizon = new Horizon.Server(horizonUrl)
+        this.networkPassphrase = networkPassphrase
         this.rpcUrl = rpcUrl
         this.rpc = new SorobanRpc.Server(rpcUrl)
 
@@ -83,7 +67,6 @@ export class PasskeyKit extends PasskeyBase {
             this.factoryContractId = factoryContractId
 
         this.factory = new FactoryClient({
-            publicKey: sequencePublicKey,
             contractId: this.factoryContractId,
             networkPassphrase,
             rpcUrl
@@ -101,7 +84,6 @@ export class PasskeyKit extends PasskeyBase {
         const contractId = result.unwrap() as string
 
         this.wallet = new PasskeyClient({
-            publicKey: this.sequencePublicKey,
             contractId,
             networkPassphrase: this.networkPassphrase,
             rpcUrl: this.rpcUrl
@@ -164,7 +146,7 @@ export class PasskeyKit extends PasskeyBase {
                 Also not sure what the use case would be for this where keyId wouldn't also be possible and better
                 @No
         */
-        
+
         // @ts-ignore 
         // https://github.com/stellar/js-stellar-base/issues/750
         // if (id && StrKey.isValidContract(id)) {
@@ -210,7 +192,6 @@ export class PasskeyKit extends PasskeyBase {
         }
 
         this.wallet = new PasskeyClient({
-            publicKey: this.sequencePublicKey,
             contractId,
             networkPassphrase: this.networkPassphrase,
             rpcUrl: this.rpcUrl
@@ -225,7 +206,11 @@ export class PasskeyKit extends PasskeyBase {
         }
     }
 
-    // TODO is there anything to be done with using the TS bindings `signAuthEntries` logic? Likely not but worth exploring 
+    /* TODO 
+        - Is there anything to be done with using the TS bindings `signAuthEntries` logic? Likely not but worth exploring 
+            Perhaps not but maybe the js-sdk's `authorizeEntry` or `authorizeInvocation`
+            https://stellar.github.io/js-stellar-sdk/global.html#authorizeInvocation
+    */
     public async sign(
         txn: Transaction | string,
         options?: {
@@ -236,7 +221,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 || {}
 
-        // hack to ensure we don't stack fees when simulating and assembling multiple times
+        // Hack to ensure we don't stack fees when simulating and assembling multiple times
         txn = TransactionBuilder.cloneFrom(new Transaction(
             typeof txn === 'string'
                 ? txn
@@ -245,7 +230,12 @@ export class PasskeyKit extends PasskeyBase {
         ), { fee: '0' }).build()
 
         // NOTE hard coded to sign only Soroban transactions and only and always the first auth
-        // TODO switch to support signing multiple and specific auth entries. Possibly pass in auth entry vs the entire txn
+        /* TODO !!!
+            - Switch to support signing multiple and specific auth entries
+                Possibly pass in auth entry vs the entire txn
+                    Probably a bad idea as it would add complexity to the user side to reassemble the signed entries
+                I think we can probably look at the list of auth entries and assume which ones we want to sign
+        */
         const op = txn.operations[0] as Operation.InvokeHostFunction
         const auth = op.auth![0]
         const lastLedger = await this.rpc.getLatestLedger().then(({ sequence }) => sequence)
@@ -261,7 +251,9 @@ export class PasskeyKit extends PasskeyBase {
         )
 
         const authenticationResponse = await startAuthentication(
-            keyId === 'any' || (keyId === 'sudo' && !this.sudoKeyId) || (!keyId && !this.keyId)
+            keyId === 'any'
+                || (keyId === 'sudo' && !this.sudoKeyId)
+                || (!keyId && !this.keyId)
                 ? {
                     challenge: base64url(authHash),
                     // rpId: undefined,
@@ -319,7 +311,7 @@ export class PasskeyKit extends PasskeyBase {
 
         if (
             SorobanRpc.Api.isSimulationError(sim)
-            || SorobanRpc.Api.isSimulationRestore(sim) // TODO handle restore flow
+            || SorobanRpc.Api.isSimulationRestore(sim) // TODO handle state archival
         ) throw sim
 
         return SorobanRpc.assembleTransaction(txn, sim).build().toXDR()

package/types/base.d.ts

@@ -1,15 +1,9 @@
-import { Networks, Transaction, Horizon } from '@stellar/stellar-sdk';
 export declare class PasskeyBase {
-    networkPassphrase: Networks;
-    horizonUrl: string;
-    horizon: Horizon.Server;
-    feeBumpUrl: string | undefined;
-    feeBumpJwt: string | undefined;
+    launchtubeUrl: string | undefined;
+    launchtubeJwt: string | undefined;
     constructor(options: {
-        networkPassphrase: Networks;
-        horizonUrl: string;
-        feeBumpUrl?: string;
-        feeBumpJwt?: string;
+        launchtubeUrl?: string;
+        launchtubeJwt?: string;
     });
-    send(txn: Transaction, fee?: number): Promise<Horizon.HorizonApi.SubmitTransactionResponse>;
+    send(xdr: string, fee?: number): Promise<any>;
 }

package/types/kit.d.ts

@@ -1,6 +1,6 @@
 import { Client as PasskeyClient } from 'passkey-kit-sdk';
 import { Client as FactoryClient } from 'passkey-factory-sdk';
-import { Networks, Transaction, Horizon, SorobanRpc } from '@stellar/stellar-sdk';
+import { Networks, Transaction, SorobanRpc } from '@stellar/stellar-sdk';
 import { Buffer } from 'buffer';
 import { PasskeyBase } from './base';
 export declare class PasskeyKit extends PasskeyBase {
@@ -8,18 +8,15 @@ export declare class PasskeyKit extends PasskeyBase {
     sudoKeyId: string | undefined;
     wallet: PasskeyClient | undefined;
     factory: FactoryClient;
-    sequencePublicKey: string;
-    horizon: Horizon.Server;
+    networkPassphrase: Networks;
     rpcUrl: string;
     rpc: SorobanRpc.Server;
     factoryContractId: string;
     constructor(options: {
-        sequencePublicKey: string;
         networkPassphrase: Networks;
-        horizonUrl: string;
         rpcUrl: string;
-        feeBumpUrl?: string;
-        feeBumpJwt?: string;
+        launchtubeUrl?: string;
+        launchtubeJwt?: string;
         factoryContractId?: string;
     });
     createWallet(name: string, user: string): Promise<{