passkey-kit 0.2.3 → 0.2.5

package/README.md

@@ -1,4 +1,44 @@
-# passkey-kit
+# 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.
+
+Demo site: [passkey-kit-demo.pages.dev](https://passkey-kit-demo.pages.dev/)
+
+To get started first install the package:
+```
+pnpm i passkey-kit
+```
+
+On the client:
+```ts
+const account = new PasskeyKit({
+    rpcUrl: env.RPC_URL,
+    networkPassphrase: env.NETWORK_PASSPHRASE
+});
+```
+
+On the server:
+```ts
+const account = new PasskeyKit({
+    launchtubeUrl: env.LAUNCHTUBE_URL,
+    launchtubeJwt: env.LAUNCHTUBE_JWT,
+});
+```
+
+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).
+
+## Contributing 
+
+Passkey kit consists of three primary directories:
+- `./contracts` - Contains the Rust Soroban smart contracts of the smart wallet implementation.
+- `./src` - Contains the TypeScript files for the actual TS SDK library.
+- `./demo` - Contains a basic demo of the SDK in action.
 
 To install dependencies:
 
@@ -12,10 +52,16 @@ To build:
 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`.
+To run the demo:
+
+```bash
+cd ./demo
+pnpm i
+pnpm run start
+```
 
-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.
+[!IMPORTANT]
+> 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`.
 
-## TODO
-- [ ] Signer list should be paginated
-- [ ] Attach some meaningful metadata to signers so you know which one belongs to which domain
+[!IMPORTANT]
+> 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 vs swapping out entire directories.

package/TODO.md

@@ -0,0 +1,2 @@
+- [ ] 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.2.3",
+  "version": "0.2.5",
   "description": "A helper library for creating and using passkey accounts on the Stellar blockchain.",
   "author": "Tyler van der Hoeven",
   "license": "MIT",

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, SorobanRpc, Operation, scValToNative, TransactionBuilder, authorizeEntry } 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"
@@ -38,7 +38,7 @@ export class PasskeyKit extends PasskeyBase {
         launchtubeUrl?: string,
         launchtubeJwt?: string,
         factoryContractId?: string,
-        networkPassphrase: Networks,
+        networkPassphrase: string,
     }) {
         const {
             rpcUrl,
@@ -58,7 +58,7 @@ export class PasskeyKit extends PasskeyBase {
 
         this.rpcUrl = rpcUrl
         this.rpc = new SorobanRpc.Server(rpcUrl)
-        this.networkPassphrase = networkPassphrase
+        this.networkPassphrase = networkPassphrase as Networks
         this.factory = new FactoryClient({
             contractId: this.factoryContractId,
             networkPassphrase,
@@ -169,8 +169,8 @@ export class PasskeyKit extends PasskeyBase {
         }
         // if that fails look up from the factory mapper
         catch {
-            contractData = await this.rpc.getContractData(this.factoryContractId, xdr.ScVal.scvBytes(keyIdBuffer))
-            contractId = scValToNative(contractData.val.contractData().val())
+            const { val } = await this.rpc.getContractData(this.factoryContractId, xdr.ScVal.scvBytes(keyIdBuffer))
+            contractId = scValToNative(val.contractData().val())
         }
 
         this.wallet = new PasskeyClient({
@@ -295,7 +295,11 @@ export class PasskeyKit extends PasskeyBase {
             ledgersToLive?: number
         }
     ) {
-        // Hack to ensure we don't stack fees when simulating and assembling multiple times
+        /* NOTE 
+            - Hack to ensure we don't stack fees when simulating and assembling multiple times
+                AssembleTransaction always adds the resource fee onto the transaction fee. 
+                This is bad in cases where you need to simulate multiple times
+        */
         txn = TransactionBuilder.cloneFrom(new Transaction(
             typeof txn === 'string'
                 ? txn
@@ -335,6 +339,10 @@ export class PasskeyKit extends PasskeyBase {
     public async getData(contractData?: SorobanRpc.Api.LedgerEntryResult) {
         const data: Map<string, any> = new Map()
 
+        /* TODO 
+            - Pretty easy to get into a state where there is no contractId and this we error at `this.wallet!.options.contractId,`
+                We should have a better error or maybe just handle no-wallet scenarios more gracefully
+        */
         const { val } = contractData || await this.rpc.getContractData(
             this.wallet!.options.contractId,
             xdr.ScVal.scvLedgerKeyContractInstance(),

package/types/kit.d.ts

@@ -17,7 +17,7 @@ export declare class PasskeyKit extends PasskeyBase {
         launchtubeUrl?: string;
         launchtubeJwt?: string;
         factoryContractId?: string;
-        networkPassphrase: Networks;
+        networkPassphrase: string;
     });
     createWallet(name: string, user: string): Promise<{
         keyId: Buffer;