passkey-kit 0.4.6 → 0.5.1

package/README.md

@@ -12,28 +12,62 @@ pnpm i passkey-kit
 On the client:
 ```ts
 const account = new PasskeyKit({
-    rpcUrl: env.RPC_URL,
-    networkPassphrase: env.NETWORK_PASSPHRASE,
-    factoryContractId: env.FACTORY_CONTRACT_ID,
+    rpcUrl: env.PUBLIC_rpcUrl,
+    networkPassphrase: env.PUBLIC_networkPassphrase,
+    factoryContractId: env.PUBLIC_factoryContractId,
 });
 ```
 
 On the server:
 ```ts
 const account = new PasskeyBase({
-    launchtubeUrl: env.LAUNCHTUBE_URL,
-    launchtubeJwt: env.LAUNCHTUBE_JWT,
+    rpcUrl: env.PUBLIC_rpcUrl,
+    launchtubeUrl: env.PUBLIC_launchtubeUrl,
+    launchtubeJwt: env.PRIVATE_launchtubeJwt,
+    mercuryUrl: env.PUBLIC_mercuryUrl,
+    mercuryEmail: env.PRIVATE_mercuryEmail,
+    mercuryPassword: env.PRIVATE_mercuryPassword,
 });
 ```
 
 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.
 
+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.
+
+```bash
+cd ./zephyr
+cargo install mercury-cli
+# Get a JWT from Mercury https://test.mercurydata.app
+export MERCURY_JWT="<YOUR.MERCURY.JWT>"
+# Make sure you're on Rust version 1.79.0 or newer
+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
+
+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.
+
+For example if you're using NextJS this will mean modifying your `next.config.mjs` file to include the following packages in the `transpilePackages` key:
+```mjs
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+    transpilePackages: [
+        'passkey-kit', 
+        'passkey-factory-sdk', 
+        'passkey-kit-sdk'
+    ]
+};
+
+export default nextConfig;
+```
+If someone smarter than me knows how to include an optional JS build from a TS library please submit a PR. I just don't want to deploy a compiled version of this and wind up having folks doubling up on an already gargantuan dependency.
+
 ## Contributing 
 
 Passkey kit consists of three primary directories:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "passkey-kit",
-  "version": "0.4.6",
+  "version": "0.5.1",
   "description": "A helper library for creating and using passkey accounts on the Stellar blockchain.",
   "author": "Tyler van der Hoeven",
   "license": "MIT",
@@ -12,8 +12,9 @@
     "@stellar/stellar-sdk": "12.1.0",
     "base64url": "^3.0.1",
     "buffer": "^6.0.3",
-    "passkey-kit-sdk": "0.2.1",
-    "passkey-factory-sdk": "0.2.1"
+    "sac-sdk": "0.1.0",
+    "passkey-factory-sdk": "0.2.1",
+    "passkey-kit-sdk": "0.2.1"
   },
   "devDependencies": {
     "@simplewebauthn/types": "^10.0.0",
@@ -45,8 +46,9 @@
   "homepage": "https://github.com/kalepail/passkey-kit/blob/main/README.md",
   "scripts": {
     "build:demo": "cd demo && pnpm --ignore-workspace install && pnpm run build",
+    "build:sac": "pnpm --filter ./packages/sac-sdk run build",
     "build:pfs": "pnpm --filter ./packages/passkey-factory-sdk run build",
     "build:pks": "pnpm --filter ./packages/passkey-kit-sdk run build",
-    "build": "pnpm run build:pfs && pnpm run build:pks && tsc"
+    "build": "pnpm run build:sac && pnpm run build:pfs && pnpm run build:pks && tsc"
   }
 }

package/packages/sac-sdk/README.md

@@ -0,0 +1,54 @@
+# sac-sdk JS
+
+JS library for interacting with [Soroban](https://soroban.stellar.org/) smart contract `sac-sdk` via Soroban RPC.
+
+This library was automatically generated by Soroban CLI using a command similar to:
+
+```bash
+soroban contract bindings ts \
+  --rpc-url https://soroban-testnet.stellar.org \
+  --network-passphrase "Test SDF Network ; September 2015" \
+  --contract-id CDLZFC3SYJYDZT7K67VZ75HPJVIEUVNIXF47ZG2FB2RMQQVU2HHGCYSC \
+  --output-dir ./path/to/sac-sdk
+```
+
+The network passphrase and contract ID are exported from [index.ts](./src/index.ts) in the `networks` constant. If you are the one who generated this library and you know that this contract is also deployed to other networks, feel free to update `networks` with other valid options. This will help your contract consumers use this library more easily.
+
+# To publish or not to publish
+
+This library is suitable for publishing to NPM. You can publish it to NPM using the `npm publish` command.
+
+But you don't need to publish this library to NPM to use it. You can add it to your project's `package.json` using a file path:
+
+```json
+"dependencies": {
+  "sac-sdk": "./path/to/this/folder"
+}
+```
+
+However, we've actually encountered [frustration](https://github.com/stellar/soroban-example-dapp/pull/117#discussion_r1232873560) using local libraries with NPM in this way. Though it seems a bit messy, we suggest generating the library directly to your `node_modules` folder automatically after each install by using a `postinstall` script. We've had the least trouble with this approach. NPM will automatically remove what it sees as erroneous directories during the `install` step, and then regenerate them when it gets to your `postinstall` step, which will keep the library up-to-date with your contract.
+
+```json
+"scripts": {
+  "postinstall": "soroban contract bindings ts --rpc-url https://soroban-testnet.stellar.org --network-passphrase \"Test SDF Network ; September 2015\" --id CDLZFC3SYJYDZT7K67VZ75HPJVIEUVNIXF47ZG2FB2RMQQVU2HHGCYSC --name sac-sdk"
+}
+```
+
+Obviously you need to adjust the above command based on the actual command you used to generate the library.
+
+# Use it
+
+Now that you have your library up-to-date and added to your project, you can import it in a file and see inline documentation for all of its exported methods:
+
+```js
+import { Contract, networks } from "sac-sdk"
+
+const contract = new Contract({
+  ...networks.futurenet, // for example; check which networks this library exports
+  rpcUrl: '...', // use your own, or find one for testing at https://soroban.stellar.org/docs/reference/rpc#public-rpc-providers
+})
+
+contract.|
+```
+
+As long as your editor is configured to show JavaScript/TypeScript documentation, you can pause your typing at that `|` to get a list of all exports and inline-documentation for each. It exports a separate [async](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) function for each method in the smart contract, with documentation for each generated from the comments the contract's author included in the original source code.

package/packages/sac-sdk/package.json

@@ -0,0 +1,18 @@
+{
+  "version": "0.1.0",
+  "name": "sac-sdk",
+  "type": "module",
+  "main": "src/index.ts",
+  "types": "types/index.d.ts",
+  "scripts": {
+    "prepublishOnly": "pnpm run build",
+    "build": "tsc"
+  },
+  "dependencies": {
+    "buffer": "6.0.3",
+    "@stellar/stellar-sdk": "12.1.0"
+  },
+  "devDependencies": {
+    "typescript": "5.5.3"
+  }
+}