@notabene/javascript-sdk 2.21.0 → 2.22.0-next.1

package/README.md

@@ -377,15 +377,19 @@ The Connect Wallet component helps you collect and verify the address of your us
 ### Parameters
 
 - `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
+- `address`: Optional account to collect a proof for, as a blockchain address or CAIP-10 identifier. When set, the component narrows the connected wallet to this account and only offers to verify that one; connecting fails if the wallet does not hold it. When omitted, the user chooses which of their addresses to prove.
 
 ```js
 const connect = notabene.createConnectWallet({
   asset: 'ETH',
+  address: '0x...',
 });
 
 const { proof, txCreate } = await connect.openModal();
 ```
 
+The proved account is returned on `proof.address` as a CAIP-10 identifier.
+
 ## Deposit Request
 
 The Deposit Request lets your customers request deposits that are fully Travel Rule compliant.

package/dist/cjs/notabene.d.ts

@@ -710,6 +710,20 @@ export declare type ConnectionOptions = Omit<TransactionOptions, 'allowedAgentTy
  */
 export declare interface ConnectionRequest extends ComponentRequest {
     asset: TransactionAsset;
+    /**
+     * The account to collect a proof for.
+     *
+     * @remarks
+     * When set, the component narrows the connected wallet to this account and
+     * only offers to verify that one, instead of letting the user pick any
+     * address the wallet reports. Connecting fails if the wallet does not hold
+     * it. When omitted, the user chooses which of their addresses to prove.
+     *
+     * A bare blockchain address is resolved against the chain of {@link ConnectionRequest.asset}.
+     *
+     * @see {@link OwnershipProof.address} For the proved account on the response
+     */
+    address?: BlockchainAddress | CAIP10;
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {

package/dist/cjs/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.21.0",
+  "version": "2.22.0-next.1",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",

package/dist/esm/notabene.d.ts

@@ -710,6 +710,20 @@ export declare type ConnectionOptions = Omit<TransactionOptions, 'allowedAgentTy
  */
 export declare interface ConnectionRequest extends ComponentRequest {
     asset: TransactionAsset;
+    /**
+     * The account to collect a proof for.
+     *
+     * @remarks
+     * When set, the component narrows the connected wallet to this account and
+     * only offers to verify that one, instead of letting the user pick any
+     * address the wallet reports. Connecting fails if the wallet does not hold
+     * it. When omitted, the user chooses which of their addresses to prove.
+     *
+     * A bare blockchain address is resolved against the chain of {@link ConnectionRequest.asset}.
+     *
+     * @see {@link OwnershipProof.address} For the proved account on the response
+     */
+    address?: BlockchainAddress | CAIP10;
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {

package/dist/esm/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.21.0",
+  "version": "2.22.0-next.1",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",

package/dist/notabene.d.ts

@@ -710,6 +710,20 @@ export declare type ConnectionOptions = Omit<TransactionOptions, 'allowedAgentTy
  */
 export declare interface ConnectionRequest extends ComponentRequest {
     asset: TransactionAsset;
+    /**
+     * The account to collect a proof for.
+     *
+     * @remarks
+     * When set, the component narrows the connected wallet to this account and
+     * only offers to verify that one, instead of letting the user pick any
+     * address the wallet reports. Connecting fails if the wallet does not hold
+     * it. When omitted, the user chooses which of their addresses to prove.
+     *
+     * A bare blockchain address is resolved against the chain of {@link ConnectionRequest.asset}.
+     *
+     * @see {@link OwnershipProof.address} For the proved account on the response
+     */
+    address?: BlockchainAddress | CAIP10;
 }
 
 export declare interface ConnectionResponse<T extends ComponentRequest> {

package/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.21.0",
+  "version": "2.22.0-next.1",
   "source": "src/notabene.ts",
   "main": "dist/cjs/notabene.cjs",
   "module": "dist/esm/notabene.js",

package/src/types.ts

@@ -641,6 +641,20 @@ export interface InvoiceReaderResponse {
  */
 export interface ConnectionRequest extends ComponentRequest {
   asset: TransactionAsset;
+  /**
+   * The account to collect a proof for.
+   *
+   * @remarks
+   * When set, the component narrows the connected wallet to this account and
+   * only offers to verify that one, instead of letting the user pick any
+   * address the wallet reports. Connecting fails if the wallet does not hold
+   * it. When omitted, the user chooses which of their addresses to prove.
+   *
+   * A bare blockchain address is resolved against the chain of {@link ConnectionRequest.asset}.
+   *
+   * @see {@link OwnershipProof.address} For the proved account on the response
+   */
+  address?: BlockchainAddress | CAIP10;
 }
 
 /**

package/src/utils/arbitraries.ts

@@ -125,6 +125,9 @@ export const arbitraryConnectionRequest = (): fc.Arbitrary<ConnectionRequest> =>
     asset: arbitraryTransactionAsset(),
     requestId: fc.option(fc.uuid()),
     customer: fc.option(arbitraryCounterparty()),
+    address: fc.option(
+      fc.oneof(arbitraryBlockchainAddress(), arbitraryCAIP10()),
+    ),
   });
 
 // Helper for ISO date format