feat(SPV-905): update endpoint use cases

README.md

@@ -55,7 +55,7 @@ The main concept is to create a new instance of the `SpvWalletClient` class and
 ```typescript
 import { SpvWalletClient } from '@bsv/spv-wallet-js-client';
 
-const spvWalletServerUrl = 'http://localhost:3003/v1';
+const spvWalletServerUrl = 'http://localhost:3003';
 
 // Create a new instance of the SPV Wallet client
 const client = new SpvWalletClient(spvWalletServerUrl, {
@@ -65,8 +65,8 @@ const client = new SpvWalletClient(spvWalletServerUrl, {
 
 // Use the client to interact with the SPV Wallet server
 // For example, check the balance
-const xpubInfo = await client.GetXPub();
-console.log('Current balance:', xpubInfo.current_balance);
+const userInfo = await client.GetUser();
+console.log('Current balance:', userInfo.currentBalance);
 ```
 
 > During creation or usage of the client an exception can be thrown - see [handle-exceptions example](./examples/handle-exceptions.ts) how to handle these situations.
@@ -78,7 +78,7 @@ console.log('Current balance:', xpubInfo.current_balance);
 
 The **first argument** of the `SpvWalletClient` constructor is the URL of the SPV Wallet server.
 
-> Note the `/v1` suffix is required.
+> Note the `/api/v1` or /v1 suffix is not required, it will be resolved automatically.
 
 ### Keys configuration
 

examples/access-key.ts

@@ -0,0 +1,26 @@
+import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
+import { exampleXPriv } from './example-keys.js';
+import { errMessage } from './utils.js';
+
+const server = 'http://localhost:3003';
+
+if (!exampleXPriv) {
+  console.log(errMessage('xPriv'));
+  process.exit(1);
+}
+
+const client = new SpvWalletClient(server, {
+  xPriv: exampleXPriv,
+});
+
+const createdAccessKey = await client.CreateAccessKey({ some_metadata: 'example' });
+console.log('Created access key ID:', (createdAccessKey.id));
+console.log('Metadata:', (createdAccessKey.metadata));
+console.log('Created at:', (createdAccessKey.createdAt));
+
+const fetchedAccessKey = await client.GetAccessKeyByID(createdAccessKey.id);
+console.log('Fetched access key ID:', (fetchedAccessKey.id));
+
+const revokedAccessKey = await client.RevokeAccessKey(createdAccessKey.id);
+console.log('Revoked access key ID:', (revokedAccessKey.id));
+console.log('Revoked at:', (revokedAccessKey.revokedAt));

examples/admin-add-user.ts

@@ -2,7 +2,7 @@ import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
 import { exampleAdminKey, exampleXPub, examplePaymail } from './example-keys.js';
 import { errMessage } from './utils.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 if (!exampleAdminKey) {
   console.log(errMessage('adminKey'));

examples/admin-remove-user.ts

@@ -2,7 +2,7 @@ import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
 import { exampleAdminKey, examplePaymail } from './example-keys.js';
 import { errMessage } from './utils.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 if (!exampleAdminKey) {
   console.log(errMessage('adminKey'));

examples/admin-webhooks.ts

@@ -2,7 +2,7 @@ import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
 import { exampleAdminKey } from './example-keys.js';
 import { errMessage } from './utils.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 if (!exampleAdminKey) {
   console.log(errMessage('adminKey'));

examples/create-transaction.ts

@@ -1,8 +1,8 @@
-import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
+import { ErrorNoAdminKey, ErrorResponse, SpvWalletClient, SpvWalletError } from '../dist/typescript-npm-package.cjs.js';
 import { exampleXPriv } from './example-keys.js';
 import { errMessage } from './utils.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 if (!exampleXPriv) {
   console.log(errMessage('xPriv'));
@@ -13,16 +13,36 @@ const client = new SpvWalletClient(server, {
   xPriv: exampleXPriv,
 });
 
-const newTransaction = await client.SendToRecipients(
-  [
+try {
+  const newTransaction = await client.SendToRecipients(
     {
-      to: 'receiver@example.com',
-      satoshis: 1,
+      outputs: [
+        {
+          to: 'receiver@example.com',
+          satoshis: 1,
+        }
+      ]
     },
-  ],
-  { some_metadata: 'example' },
-);
-console.log('SendToRecipients response:', newTransaction);
+    { some_metadata: 'example' },
+  );
+  console.log('SendToRecipients response:', newTransaction);
 
-const tx = await client.GetTransaction(newTransaction.id);
-console.log('GetTransaction response:', tx);
+  const tx = await client.GetTransactionById(newTransaction.id);
+  console.log('GetTransaction response:', tx);
+
+} catch (e) {
+  if (e instanceof SpvWalletError) {
+    // You can check the type of the error and do something specific
+    if (e instanceof ErrorResponse) {
+      console.error('Response status:', e.response.status);
+      console.error('Content:', e.content);
+    } else if (e instanceof ErrorNoAdminKey) {
+      console.error('ErrorNoAdminKey', e.message);
+    } else {
+      //check all the other error types here: src/errors.ts
+      console.error('SpvWalletError:', e.message);
+    }
+  } else {
+    console.log('Unknown error:', e);
+  }
+}

examples/custom-logger.ts

@@ -1,6 +1,6 @@
 import { SpvWalletClient, generateKeys } from '../dist/typescript-npm-package.cjs.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 const newXPub = generateKeys().xPub.toString();
 

examples/generate-totp.ts

@@ -1,6 +1,6 @@
 import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 const aliceXPriv =
   'xprv9s21ZrQH143K4JFXqGhBzdrthyNFNuHPaMUwvuo8xvpHwWXprNK7T4JPj1w53S1gojQncyj8JhSh8qouYPZpbocsq934cH5G1t1DRBfgbod';
@@ -19,7 +19,7 @@ const mockBobContact = {
   pubKey: bobPKI,
 
   //the rest of the fields won't be used for OTP generation but they still need to be defined
-  created_at: new Date(),
+  createdAt: new Date(),
   fullName: '',
   id: '',
   status: '',

examples/get-balance.ts

@@ -2,7 +2,7 @@ import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
 import { exampleXPriv } from './example-keys.js';
 import { errMessage } from './utils.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 if (!exampleXPriv) {
   console.log(errMessage('xPriv'));
@@ -13,5 +13,5 @@ const client = new SpvWalletClient(server, {
   xPriv: exampleXPriv,
 });
 
-const xpubInfo = await client.GetXPub();
-console.log('Current balance:', xpubInfo.current_balance);
+const userInfo = await client.GetUserInfo();
+console.log('Current balance:', userInfo.currentBalance);

examples/get-handled-paymail-domains.ts

@@ -2,7 +2,7 @@ import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
 import { exampleAdminKey, exampleXPriv } from './example-keys.js';
 import { errMessage } from './utils.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 // It is possible to get paymail domains either as an admin or as a user.
 if (!exampleAdminKey && !exampleXPriv) {
@@ -16,4 +16,4 @@ const client = exampleXPriv
 
 const sharedConfig = await client.GetSharedConfig();
 
-console.log(sharedConfig.paymail_domains[0]);
+console.log(sharedConfig.paymailDomains[0]);

examples/get-shared-config.ts

@@ -0,0 +1,17 @@
+import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
+import { exampleXPriv } from './example-keys.js';
+import { errMessage } from './utils.js';
+
+const server = 'http://localhost:3003';
+
+if (!exampleXPriv) {
+  console.log(errMessage('xPriv'));
+  process.exit(1);
+}
+
+const client = new SpvWalletClient(server, {
+  xPriv: exampleXPriv,
+});
+
+const sharedConfig = await client.GetSharedConfig();
+console.log('Shared config:', sharedConfig);

examples/handle-exceptions.ts

@@ -2,7 +2,7 @@ import { ErrorNoAdminKey, ErrorResponse, SpvWalletClient, SpvWalletError } from
 import { exampleXPub } from './example-keys.js';
 import { errMessage } from './utils.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 if (!exampleXPub) {
   console.log(errMessage('xPub'));

examples/list-transactions.ts

@@ -2,7 +2,7 @@ import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
 import { exampleXPriv } from './example-keys.js';
 import { errMessage } from './utils.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 if (!exampleXPriv) {
   console.log(errMessage('xPriv'));
@@ -22,7 +22,7 @@ const txsFiltered = await client.GetTransactions(
   },
   {},
   {
-    page_size: 100,
+    pageSize: 100,
     page: 1,
   },
 );

examples/package.json

@@ -7,20 +7,23 @@
     "build:client": "cd .. && yarn build",
     "_print_starting_label": "echo '' && echo '========== Starting ==========' && echo ''",
     "run:example": "yarn build:client && yarn _print_starting_label && node --loader ts-node/esm",
+    "access-key": "yarn run:example access-key.ts",
     "admin-add-user": "yarn run:example admin-add-user.ts",
     "admin-webhooks": "yarn run:example admin-webhooks.ts",
     "admin-remove-user": "yarn run:example admin-remove-user.ts",
     "create-transaction": "yarn run:example create-transaction.ts",
     "custom-logger": "yarn run:example custom-logger.ts",
+    "generate-totp": "yarn run:example generate-totp.ts",
     "generate-keys": "yarn run:example generate-keys.ts",
     "get-balance": "yarn run:example get-balance.ts",
+    "get-handled-paymail-domains": "yarn run:example get-handled-paymail-domains.ts",
+    "get-shared-config": "yarn run:example get-shared-config.ts",
     "handle-exceptions": "yarn run:example handle-exceptions.ts",
     "list-transactions": "yarn run:example list-transactions.ts",
     "send-op-return": "yarn run:example send-op-return.ts",
+    "update-user-xpub-metadata": "yarn run:example update-user-xpub-metadata.ts",
     "xpriv-from-mnemonic": "yarn run:example xpriv-from-mnemonic.ts",
-    "xpub-from-xpriv": "yarn run:example xpub-from-xpriv.ts",
-    "generate-totp": "yarn run:example generate-totp.ts",
-    "get-handled-paymail-domains": "yarn run:example get-handled-paymail-domains.ts"
+    "xpub-from-xpriv": "yarn run:example xpub-from-xpriv.ts"
   },
   "version": "0.0.0",
   "devDependencies": {

examples/send-op-return.ts

@@ -1,8 +1,8 @@
-import { OpReturn, SpvWalletClient, TransactionConfigInput } from '../dist/typescript-npm-package.cjs.js';
+import { DraftTransactionConfig, OpReturn, SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
 import { exampleXPriv } from './example-keys.js';
 import { errMessage } from './utils.js';
 
-const server = 'http://localhost:3003/v1';
+const server = 'http://localhost:3003';
 
 if (!exampleXPriv) {
   console.log(errMessage('xPriv'));
@@ -14,18 +14,18 @@ const client = new SpvWalletClient(server, {
 });
 
 const opReturn: OpReturn = {
-  string_parts: ['hello', 'world'],
+  stringParts: ['hello', 'world'],
 };
 
-const transactionConfig: TransactionConfigInput = {
+const transactionConfig: DraftTransactionConfig = {
   outputs: [
     {
-      op_return: opReturn,
+      opReturn: opReturn,
     },
   ],
 };
 
-const draftTransaction = await client.DraftTransaction(transactionConfig, {});
+const draftTransaction = await client.NewDraftTransaction(transactionConfig, {});
 console.log('DraftTransaction response:', draftTransaction);
 
 const finalized = await client.SignTransaction(draftTransaction);

examples/update-user-xpub-metadata.ts

@@ -0,0 +1,22 @@
+import { SpvWalletClient } from '../dist/typescript-npm-package.cjs.js';
+import { exampleXPriv } from './example-keys.js';
+import { errMessage } from './utils.js';
+
+const server = 'http://localhost:3003';
+
+if (!exampleXPriv) {
+  console.log(errMessage('xPriv'));
+  process.exit(1);
+}
+
+const client = new SpvWalletClient(server, {
+  xPriv: exampleXPriv,
+});
+
+const userInfo = await client.GetUserInfo();
+console.log('User XPub metadata:', userInfo.metadata);
+console.log('User XPub (updated_at):', userInfo.updatedAt);
+
+const updatedUserInfo = await client.UpdateUserMetadata({ some_metadata_2: 'example2' });
+console.log('Updated User XPub metadata:', updatedUserInfo.metadata);
+console.log('Updated User XPub (updated_at):', updatedUserInfo.updatedAt);