From 349aad0af1c3c919f1658d192173fae6e32c41fb Mon Sep 17 00:00:00 2001 From: Niran Babalola Date: Tue, 3 Dec 2024 14:14:32 -0600 Subject: [PATCH] Update the usage instructions for scripts --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5dd518f..05ccbdc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Example Keyspace Client +# Keyspace Client Library -An example Keyspace client implemented in TypeScript. This client is the basis for the [Keyspace documentation](https://docs.key.space/) and will eventually become a client library for Keyspace. +A Keyspace client library implemented in TypeScript. This client is also the basis for the [Keyspace documentation](https://docs.key.space/). ## Install Dependencies ```bash @@ -55,11 +55,14 @@ bun run scripts/send-eth.ts | Argument | Environment Variable | Description | | --- | --- | --- | -| --keystore-id | KEYSPACE_KEY | The wallet's Keyspace key | +| --account | | The account of the keystore wallet to send from | +| --owner-index | | The index of the owner (default: 0) | +| --initial-config-data | | The initial config data needed to deploy the wallet | | --private-key | PRIVATE_KEY | secp256k1 private key or P256 JWK | +| --to | | The address to send to | | --signature-type | | secp256k1 (default) or webauthn | -Make sure there's ETH in the account you're sending from. You can get the Ethereum address of the smart wallet by running `bun run scripts/get-keyspace-key.ts`. +Make sure there's ETH in the account you're sending from. You can get the Ethereum address of the smart wallet by running `bun run scripts/get-account.ts`. ### Change Owner @@ -69,10 +72,14 @@ bun run scripts/change-owner.ts | Argument | Environment Variable | Description | | --- | --- | --- | -| --keystore-id | KEYSPACE_KEY | The wallet's Keyspace key | -| --private-key | PRIVATE_KEY | secp256k1 private key or P256 JWK | -| --new-private-key | NEW_PRIVATE_KEY | new secp256k1 private key or P256 JWK | +| --account | | The account of the keystore wallet | +| --owner-index | | The index of the owner (default: 0) | +| --initial-config-data | | The initial config data needed to deploy the wallet | +| --private-key | PRIVATE_KEY | Current private key of the owner | +| --config-data | | Current config data for the keystore wallet (hex string) | +| --owner-bytes | | The owner bytes to change in the keystore wallet | | --signature-type | | secp256k1 (default) or webauthn | +| --remove | | Flag to remove the owner instead of adding (optional) | ## Build Documentation