passkey-kit 0.1.0 → 0.1.1

package/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "rust-analyzer.linkedProjects": [
+        "./contracts/contract-webauthn-factory/Cargo.toml",
+        "./contracts/contract-webauthn-secp256r1/Cargo.toml",
+    ]
+}

package/README.md

@@ -10,4 +10,12 @@ To build:
 
 ```bash
 pnpm run build
-```
+```
+
+If you fiddle with contracts in `./contracts` you'll need to run the make commands. Just remember to update the `WEBAUTHN_FACTORY` and `WEBAUTHN_WASM` values from the `make deploy` command before running `make init`. Once you run `make init` you'll need to update all the `.env` site files with the new `PUBLIC_factoryContractId`.
+
+Keep in mind the bindings here in `./packages` have been _heavily_ modified. Be careful when rebuilding and updating. Likely you'll only want to update the `src/index.ts` files in each respective package.
+
+## TODO
+- [ ] Signer list should be paginated
+- [ ] Attach some meaningful metadata to signers so you know which one belongs to which domain

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "passkey-kit",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "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

@@ -11,6 +11,8 @@ import { Buffer } from 'buffer'
 /* TODO 
     - Clean up these params and the interface as a whole
         Might put wallet activities and maybe factory as well into the root of the class vs buried inside this.wallet and this.factory
+        @Later
+
     - Right now publicKey can mean a Stellar public key or a passkey public key, there should be a noted difference
 */
 
@@ -25,23 +27,30 @@ export class PasskeyAccount {
     public horizon: Horizon.Server
     public rpcUrl: string
     public rpc: SorobanRpc.Server
-    public feeBumpUrl: string
-    public feeBumpJwt: string
+    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 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
+            @Later
     */
     constructor(options: {
         sequencePublicKey: string,
         networkPassphrase: Networks,
         horizonUrl: string,
         rpcUrl: string,
-        feeBumpUrl: string,
-        feeBumpJwt: string,
-        factoryContractId?: string,
+        feeBumpUrl?: string,
+        feeBumpJwt?: 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
+        */
+        factoryContractId?: string, 
     }) {
         const {
             sequencePublicKey,
@@ -59,8 +68,12 @@ export class PasskeyAccount {
         this.horizon = new Horizon.Server(horizonUrl)
         this.rpcUrl = rpcUrl
         this.rpc = new SorobanRpc.Server(rpcUrl)
-        this.feeBumpUrl = feeBumpUrl
-        this.feeBumpJwt = feeBumpJwt
+
+        if (feeBumpUrl)
+            this.feeBumpUrl = feeBumpUrl
+
+        if (feeBumpJwt)
+            this.feeBumpJwt = feeBumpJwt
 
         if (factoryContractId)
             this.factoryContractId = factoryContractId
@@ -99,7 +112,7 @@ export class PasskeyAccount {
 
     public async createKey(name: string, user: string) {
         const startRegistrationResponse = await startRegistration({
-            challenge: base64url("sorobanisbest"),
+            challenge: base64url("stellaristhebetterblockchain"),
             rp: {
                 // id: undefined,
                 name,
@@ -145,6 +158,7 @@ export class PasskeyAccount {
             - Support passing in a contractId as well as a keyId
                 Maybe not as we wouldn't have a keyId which could have interesting consequences
                 Also not sure what the use case would be for this where keyId wouldn't also be possible and better
+                @No
         */
         
         // @ts-ignore 
@@ -158,7 +172,7 @@ export class PasskeyAccount {
         const startAuthenticationResponse = id
             ? { id }
             : await startAuthentication({
-                challenge: base64url("sorobanisbest"),
+                challenge: base64url("stellaristhebetterblockchain"),
                 // rpId: undefined,
                 userVerification: "discouraged",
             });
@@ -226,6 +240,7 @@ export class PasskeyAccount {
         ), { 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
         const op = txn.operations[0] as Operation.InvokeHostFunction
         const auth = op.auth![0]
         const lastLedger = await this.rpc.getLatestLedger().then(({ sequence }) => sequence)
@@ -311,7 +326,7 @@ export class PasskeyAccount {
         data.set('xdr', txn.toXDR());
         data.set('fee', fee.toString());
 
-        const bumptxn = await fetch(this.feeBumpUrl, {
+        const bumptxn = await fetch(this.feeBumpUrl!, {
             method: 'POST',
             headers: {
                 authorization: `Bearer ${this.feeBumpJwt}`,

package/tsconfig.json

@@ -26,5 +26,5 @@
     "noPropertyAccessFromIndexSignature": false,
     "strictNullChecks": true,
   },
-  "exclude": ["./demo", "./packages", "./types"]
+  "exclude": ["./demo", "./packages", "./types", "./contracts"]
 }

package/types/index.d.ts

@@ -13,16 +13,16 @@ export declare class PasskeyAccount {
     horizon: Horizon.Server;
     rpcUrl: string;
     rpc: SorobanRpc.Server;
-    feeBumpUrl: string;
-    feeBumpJwt: string;
+    feeBumpUrl: string | undefined;
+    feeBumpJwt: string | undefined;
     factoryContractId: string;
     constructor(options: {
         sequencePublicKey: string;
         networkPassphrase: Networks;
         horizonUrl: string;
         rpcUrl: string;
-        feeBumpUrl: string;
-        feeBumpJwt: string;
+        feeBumpUrl?: string;
+        feeBumpJwt?: string;
         factoryContractId?: string;
     });
     createWallet(name: string, user: string): Promise<{

package/types/src/index.d.ts

@@ -0,0 +1,49 @@
+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 { Buffer } from 'buffer';
+export declare class PasskeyAccount {
+    keyId: string | undefined;
+    sudoKeyId: string | undefined;
+    wallet: PasskeyClient | undefined;
+    factory: FactoryClient;
+    sequencePublicKey: string;
+    networkPassphrase: Networks;
+    horizonUrl: string;
+    horizon: Horizon.Server;
+    rpcUrl: string;
+    rpc: SorobanRpc.Server;
+    feeBumpUrl: string | undefined;
+    feeBumpJwt: string | undefined;
+    factoryContractId: string;
+    constructor(options: {
+        sequencePublicKey: string;
+        networkPassphrase: Networks;
+        horizonUrl: string;
+        rpcUrl: string;
+        feeBumpUrl?: string;
+        feeBumpJwt?: string;
+        factoryContractId?: string;
+    });
+    createWallet(name: string, user: string): Promise<{
+        keyId: Buffer;
+        contractId: string;
+        xdr: string;
+    }>;
+    createKey(name: string, user: string): Promise<{
+        keyId: Buffer;
+        publicKey: Buffer;
+    }>;
+    connectWallet(id?: string): Promise<{
+        keyId: Buffer;
+        contractId: string;
+    }>;
+    sign(txn: Transaction | string, options?: {
+        keyId?: 'any' | 'sudo' | string | Uint8Array;
+        ledgersToLive?: number;
+    }): Promise<string>;
+    send(txn: Transaction, fee?: number): Promise<Horizon.HorizonApi.SubmitTransactionResponse>;
+    getData(): Promise<Map<string, any>>;
+    private getPublicKeyObject;
+    private convertEcdsaSignatureAsnToCompact;
+}