@notabene/javascript-sdk 2.4.0 → 2.5.0

package/README.md

@@ -20,32 +20,50 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
 
 ## Table of Contents
 
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [Core Concepts](#core-concepts)
-  - [Authentication](#authentication)
-- [General Component Usage](#general-component-usage)
-  - [Embedded Component](#embedded-component)
-    - [Dynamic updates](#dynamic-updates)
-  - [Modal](#modal)
-  - [Linked Component](#linked-component)
-- [Components](#components)
+- [Notabene SafeConnect Components JavaScript SDK](#notabene-safeconnect-components-javascript-sdk)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Quick Start](#quick-start)
+  - [Core Concepts](#core-concepts)
+    - [Authentication](#authentication)
+  - [General Component Usage](#general-component-usage)
+    - [Embedded Component](#embedded-component)
+      - [Dynamic updates](#dynamic-updates)
+    - [Modal](#modal)
+    - [Popup](#popup)
+    - [Linked Component](#linked-component)
+  - [Components](#components)
   - [Assisted Withdrawal](#assisted-withdrawal)
+    - [Parameters](#parameters)
+    - [Configuration Options](#configuration-options)
   - [Connect Wallet](#connect-wallet)
+    - [Parameters](#parameters-1)
+    - [Configuration Options](#configuration-options-1)
   - [Deposit Request](#deposit-request)
-- [Error handling](#error-handling)
-- [Transaction parameters](#transaction-parameters)
-  - [Asset specification](#asset-specification)
-  - [Transaction amount](#transaction-amount)
-  - [Destination](#destination)
-  - [Asset Price](#asset-price)
-- [Configuration](#configuration)
-  - [Transaction Options](#transaction-options)
-  - [Common use cases](#common-use-cases)
-  - [Configuring ownership proofs](#configuring-ownership-proofs)
-  - [Counterparty Field Properties](#counterparty-field-properties)
-- [Locales](#locales)
-- [License](#license)
+    - [Parameters](#parameters-2)
+  - [Deposit Assist](#deposit-assist)
+    - [Parameters](#parameters-3)
+  - [Error handling](#error-handling)
+  - [Transaction parameters](#transaction-parameters)
+    - [Asset specification](#asset-specification)
+    - [Transaction amount](#transaction-amount)
+    - [Destination](#destination)
+    - [Origin](#origin)
+    - [Asset Price](#asset-price)
+  - [Configuration](#configuration)
+    - [Transaction Options](#transaction-options)
+    - [Common use cases](#common-use-cases)
+      - [Only allow first party transactions](#only-allow-first-party-transactions)
+      - [Only VASP to VASP transactions](#only-vasp-to-vasp-transactions)
+      - [Only Self-hosted wallet transactions](#only-self-hosted-wallet-transactions)
+    - [Configuring ownership proofs](#configuring-ownership-proofs)
+      - [Supporting Micro Transactions (aka Satoshi tests)](#supporting-micro-transactions-aka-satoshi-tests)
+      - [Fallback Proof Options](#fallback-proof-options)
+    - [Counterparty Field Properties](#counterparty-field-properties)
+      - [Full Example](#full-example)
+      - [Field reference](#field-reference)
+  - [Locales](#locales)
+  - [License](#license)
 
 ## Installation
 
@@ -371,6 +389,33 @@ const withdrawal = notabene.createDepositRequest({
 
 If any of the required parameters are missing the component will just show the Notabene badge.
 
+## Deposit Assist
+
+The Deposit Assist component helps you collect missing Travel Rule data after a deposit has already been recorded on-chain. For example, if the deposit arrived with incomplete originator information, you can use Deposit Assist to request this information from your end-user.
+
+```js
+const deposit = notabene.createDepositAssist(
+  {
+    asset: 'ETH',
+    amountDecimal: 1.23,
+    origin: '0x...',
+    destination: '0x...',
+  },
+  {
+    // Optional transaction options
+  },
+);
+```
+
+### Parameters
+
+- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
+- `origin`: The origin or blockchain address for the deposit. See [Origin](#origin)
+- `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
+- `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
+
+If any of the required parameters are missing the component will just show the Notabene badge.
+
 ---
 
 ## Error handling
@@ -381,8 +426,6 @@ If any error occurs, the `error` event is passed containing a message.
 withdrawal.on('error', {message} => ...)
 ```
 
-Error types can be found [here](./docs/types/enumerations/ErrorIdentifierCode.md) object.
-
 ## Transaction parameters
 
 ### Asset specification
@@ -408,6 +451,15 @@ Specify the beneficiary address as `destination` using one of the following form
 - [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
 - Native blockchain address
 
+### Origin
+
+Specify the originator address as `origin` using one of the following formats:
+
+- [CAIP-10](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-10.md_) is a chain agnostic format allows you to specify the specific blockchain and address
+- [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770) EVM URI
+- [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
+- Native blockchain address
+
 ### Asset Price
 
 The price of the asset is used to determine certain rules based on thresholds. We recommond you pass in your price like this:
@@ -481,8 +533,8 @@ const options: TransactionOptions = {
       onlyActive: true, // Only list active VASPs - Default false
       searchable: [
         VASPSearchControl.ALLOWED, // JS: 'allowed'
-        VASPSearchControl.PENDING // JS: 'pending'
-      ] // Control searches for VASPs - Defaults to undefined
+        VASPSearchControl.PENDING, // JS: 'pending'
+      ], // Control searches for VASPs - Defaults to undefined
     },
     hide: [ValidationSections.ASSET, ValidationSections.DESTINATION], // Don't show specific sections of component
   },

package/dist/notabene.cjs

@@ -1 +1 @@
-"use strict";var w=Object.defineProperty;var I=(t,e,r)=>e in t?w(t,e,{enumerable:!0,configurable:!0,writable:!0,value:r}):t[e]=r;var o=(t,e,r)=>I(t,typeof e!="symbol"?e+"":e,r);Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});var c=(t=>(t.PRIVATE="WALLET",t.VASP="VASP",t))(c||{}),m=(t=>(t.NATURAL="natural",t.LEGAL="legal",t.SELF="self",t))(m||{}),u=(t=>(t.EMPTY="empty",t.VERIFY="verify",t.PENDING="pending",t.VERIFIED="verified",t.BANNED="banned",t))(u||{}),E=(t=>(t.ALLOWED="allowed",t.PENDING="pending",t))(E||{}),f=(t=>(t.ASSET="asset",t.DESTINATION="destination",t.COUNTERPARTY="counterparty",t.AGENT="agent",t))(f||{}),a=(t=>(t.COMPLETE="complete",t.RESIZE="resize",t.RESULT="result",t.READY="ready",t.INVALID="invalid",t.ERROR="error",t.CANCEL="cancel",t))(a||{}),d=(t=>(t.UPDATE="update",t.REQUEST_RESPONSE="requestResponse",t))(d||{}),p=(t=>(t.PENDING="pending",t.FAILED="rejected",t.FLAGGED="flagged",t.VERIFIED="verified",t))(p||{}),v=(t=>(t.SelfDeclaration="self-declaration",t.SIWE="siwe",t.SIWX="siwx",t.EIP191="eip-191",t.EIP712="eip-712",t.EIP1271="eip-1271",t.BIP137="bip-137",t.BIP322="bip-322",t.BIP137_XPUB="xpub",t.TIP191="tip-191",t.ED25519="ed25519",t.MicroTransfer="microtransfer",t.Screenshot="screenshot",t.Connect="connect",t))(v||{});class b{constructor(){o(this,"listeners",new Map);o(this,"port");this.handleMessage=this.handleMessage.bind(this)}setPort(e){this.port=e,this.port.onmessage=this.handleMessage,this.port.start()}on(e,r){return this.listeners.has(e)||this.listeners.set(e,new Set),this.listeners.get(e).add(r),()=>this.off(e,r)}off(e,r){const i=this.listeners.get(e);i&&(i.delete(r),i.size===0&&this.listeners.delete(e))}handleMessage(e){const r=e.data;if(typeof r=="object"&&r!==null&&"type"in r){const i=r.type,s=this.listeners.get(i);s&&s.forEach(n=>n(r))}}send(e){this.port&&this.port.postMessage(e)}}class g{constructor(e,r,i){o(this,"_url");o(this,"_value");o(this,"_options");o(this,"_errors",[]);o(this,"iframe");o(this,"eventManager");o(this,"modal");this._url=e,this._value=r,this._options=i,this.eventManager=new b,this.on(a.INVALID,s=>{s.type===a.INVALID&&(this._errors=s.errors,this._value=s.value)}),this.on(a.RESIZE,s=>{s.type===a.RESIZE&&this.iframe&&(this.iframe.style.height=`${s.height}px`)})}get url(){return this._url}get value(){return this._value}get options(){return this._options}get errors(){return this._errors}open(){document.location.href=this.url}mount(e){const r=document.querySelector(e);if(!r)throw new Error(`parentID ${e} not found`);this.embed(r)}embed(e,r=!1){var i,s;this.removeEmbed(),this.iframe=document.createElement("iframe"),this.iframe.src=this.url+(r?"":"&embedded=true"),this.iframe.allow="web-share; clipboard-write; hid; bluetooth;",this.iframe.style.width="100%",this.iframe.style.height="0px",this.iframe.style.border="none",this.iframe.style.overflow="hidden",this.iframe.scrolling="no",e.appendChild(this.iframe),window.addEventListener("message",n=>{var l,h;n.source===((l=this.iframe)==null?void 0:l.contentWindow)&&((h=this.eventManager)==null||h.setPort(n.ports[0]))}),(s=(i=this.iframe)==null?void 0:i.contentWindow)==null||s.focus()}removeEmbed(){this.iframe&&this.iframe.remove()}send(e){this.eventManager.send(e)}on(e,r){return this.eventManager.on(e,r)}off(e,r){this.eventManager.off(e,r)}update(e,r){this._value=e,r&&(this._options=r),this.send({type:d.UPDATE,value:e,options:this._options})}completion(){return new Promise((e,r)=>{let i,s,n;function l(){i&&i(),s&&s(),n&&n()}i=this.on(a.COMPLETE,h=>{e(h.response),l()}),s=this.on(a.CANCEL,()=>{r(new Error("User cancelled")),l()}),n=this.on("error",h=>{r(new Error(h.message)),l()})})}async openModal(){this.modal&&this.closeModal(),this.modal=document.createElement("dialog"),this.modal.style.border="none",this.modal.style.backgroundColor="white",this.modal.style.maxWidth="100vw",this.modal.style.maxHeight="100vh",this.modal.style.width="600px",this.modal.style.height="600px",document.body.appendChild(this.modal),this.embed(this.modal,!0);const e=this.on(a.CANCEL,()=>{this.closeModal()}),r=this.on(a.COMPLETE,()=>{this.closeModal()});return this.modal.showModal(),this.modal.addEventListener("click",()=>{this.closeModal()}),this.completion().finally(()=>{e(),r()})}closeModal(){var e;this.modal&&((e=this.modal)==null||e.close(),this.modal.remove(),this.modal=void 0)}async popup(){const e=window.open(this.url,"_blank","popup=true,width=600,height=600");window.addEventListener("message",s=>{var n;s.source===e&&(console.log("received message from popup",s.data),(n=this.eventManager)==null||n.setPort(s.ports[0]))});const r=this.on(a.CANCEL,()=>{e==null||e.close()}),i=this.on(a.COMPLETE,()=>{e==null||e.close()});return this.completion().finally(()=>{r(),i()})}}function C(t){return Object.entries(t).map(([e,r])=>{if(r==null)return;const i=encodeURIComponent(e),s=encodeURIComponent(typeof r=="object"?JSON.stringify(r):String(r));return`${i}=${s}`}).filter(e=>e!==void 0).join("&")}function U(t){const e=t.slice(1);return e?e.split("&").filter(Boolean).reduce((i,s)=>{const[n,l]=s.split("=");return n&&(i[decodeURIComponent(n)]=l?decodeURIComponent(l):""),i},{}):{}}class A{constructor(e){o(this,"nodeUrl");o(this,"authToken");o(this,"uxUrl");o(this,"theme");o(this,"locale");this.uxUrl=e.uxUrl||"https://connect.notabene.id",this.nodeUrl=e.nodeUrl,this.authToken=e.authToken,this.theme=e.theme,this.locale=e.locale}componentUrl(e,r,i,s){const n=new URL(this.uxUrl);n.pathname=e;const l=C({authToken:this.authToken,value:r,configuration:i});return n.hash=l,this.nodeUrl&&n.searchParams.set("nodeUrl",this.nodeUrl),this.theme&&n.searchParams.set("theme",JSON.stringify(this.theme)),this.locale&&n.searchParams.set("locale",this.locale),s&&(s.callback&&n.searchParams.set("callback_url",s.callback),s.redirectUri&&n.searchParams.set("redirect_uri",s.redirectUri)),n.toString()}createComponent(e,r,i,s){return new g(this.componentUrl(e,r,i,s),r,i)}createWithdrawalAssist(e,r,i){return this.createComponent("withdrawal-assist",e,r,i)}createConnectWallet(e,r,i){return this.createComponent("connect",e,r,i)}createDepositRequest(e,r,i){return this.createComponent("deposit-request",e,r,i)}}exports.AgentType=c;exports.CMType=a;exports.EmbeddedComponent=g;exports.HMType=d;exports.PersonType=m;exports.ProofStatus=p;exports.ProofTypes=v;exports.Status=u;exports.VASPSearchControl=E;exports.ValidationSections=f;exports.decodeFragmentToObject=U;exports.default=A;
+"use strict";var w=Object.defineProperty;var I=(t,e,r)=>e in t?w(t,e,{enumerable:!0,configurable:!0,writable:!0,value:r}):t[e]=r;var o=(t,e,r)=>I(t,typeof e!="symbol"?e+"":e,r);Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});var c=(t=>(t.PRIVATE="WALLET",t.VASP="VASP",t))(c||{}),m=(t=>(t.NATURAL="natural",t.LEGAL="legal",t.SELF="self",t))(m||{}),u=(t=>(t.EMPTY="empty",t.VERIFY="verify",t.PENDING="pending",t.VERIFIED="verified",t.BANNED="banned",t))(u||{}),E=(t=>(t.ALLOWED="allowed",t.PENDING="pending",t))(E||{}),f=(t=>(t.ASSET="asset",t.DESTINATION="destination",t.COUNTERPARTY="counterparty",t.AGENT="agent",t))(f||{}),a=(t=>(t.COMPLETE="complete",t.RESIZE="resize",t.RESULT="result",t.READY="ready",t.INVALID="invalid",t.ERROR="error",t.CANCEL="cancel",t))(a||{}),d=(t=>(t.UPDATE="update",t.REQUEST_RESPONSE="requestResponse",t))(d||{}),p=(t=>(t.PENDING="pending",t.FAILED="rejected",t.FLAGGED="flagged",t.VERIFIED="verified",t))(p||{}),v=(t=>(t.SelfDeclaration="self-declaration",t.SIWE="siwe",t.SIWX="siwx",t.EIP191="eip-191",t.EIP712="eip-712",t.EIP1271="eip-1271",t.BIP137="bip-137",t.BIP322="bip-322",t.BIP137_XPUB="xpub",t.TIP191="tip-191",t.ED25519="ed25519",t.MicroTransfer="microtransfer",t.Screenshot="screenshot",t.Connect="connect",t))(v||{});class b{constructor(){o(this,"listeners",new Map);o(this,"port");this.handleMessage=this.handleMessage.bind(this)}setPort(e){this.port=e,this.port.onmessage=this.handleMessage,this.port.start()}on(e,r){return this.listeners.has(e)||this.listeners.set(e,new Set),this.listeners.get(e).add(r),()=>this.off(e,r)}off(e,r){const i=this.listeners.get(e);i&&(i.delete(r),i.size===0&&this.listeners.delete(e))}handleMessage(e){const r=e.data;if(typeof r=="object"&&r!==null&&"type"in r){const i=r.type,s=this.listeners.get(i);s&&s.forEach(n=>n(r))}}send(e){this.port&&this.port.postMessage(e)}}class g{constructor(e,r,i){o(this,"_url");o(this,"_value");o(this,"_options");o(this,"_errors",[]);o(this,"iframe");o(this,"eventManager");o(this,"modal");this._url=e,this._value=r,this._options=i,this.eventManager=new b,this.on(a.INVALID,s=>{s.type===a.INVALID&&(this._errors=s.errors,this._value=s.value)}),this.on(a.RESIZE,s=>{s.type===a.RESIZE&&this.iframe&&(this.iframe.style.height=`${s.height}px`)})}get url(){return this._url}get value(){return this._value}get options(){return this._options}get errors(){return this._errors}open(){document.location.href=this.url}mount(e){const r=document.querySelector(e);if(!r)throw new Error(`parentID ${e} not found`);this.embed(r)}embed(e,r=!1){var i,s;this.removeEmbed(),this.iframe=document.createElement("iframe"),this.iframe.src=this.url+(r?"":"&embedded=true"),this.iframe.allow="web-share; clipboard-write; hid; bluetooth;",this.iframe.style.width="100%",this.iframe.style.height="0px",this.iframe.style.border="none",this.iframe.style.overflow="hidden",this.iframe.scrolling="no",e.appendChild(this.iframe),window.addEventListener("message",n=>{var l,h;n.source===((l=this.iframe)==null?void 0:l.contentWindow)&&((h=this.eventManager)==null||h.setPort(n.ports[0]))}),(s=(i=this.iframe)==null?void 0:i.contentWindow)==null||s.focus()}removeEmbed(){this.iframe&&this.iframe.remove()}send(e){this.eventManager.send(e)}on(e,r){return this.eventManager.on(e,r)}off(e,r){this.eventManager.off(e,r)}update(e,r){this._value=e,r&&(this._options=r),this.send({type:d.UPDATE,value:e,options:this._options})}completion(){return new Promise((e,r)=>{let i,s,n;function l(){i&&i(),s&&s(),n&&n()}i=this.on(a.COMPLETE,h=>{e(h.response),l()}),s=this.on(a.CANCEL,()=>{r(new Error("User cancelled")),l()}),n=this.on("error",h=>{r(new Error(h.message)),l()})})}async openModal(){this.modal&&this.closeModal(),this.modal=document.createElement("dialog"),this.modal.style.border="none",this.modal.style.backgroundColor="white",this.modal.style.maxWidth="100vw",this.modal.style.maxHeight="100vh",this.modal.style.width="600px",this.modal.style.height="600px",document.body.appendChild(this.modal),this.embed(this.modal,!0);const e=this.on(a.CANCEL,()=>{this.closeModal()}),r=this.on(a.COMPLETE,()=>{this.closeModal()});return this.modal.showModal(),this.modal.addEventListener("click",()=>{this.closeModal()}),this.completion().finally(()=>{e(),r()})}closeModal(){var e;this.modal&&((e=this.modal)==null||e.close(),this.modal.remove(),this.modal=void 0)}async popup(){const e=window.open(this.url,"_blank","popup=true,width=600,height=600");window.addEventListener("message",s=>{var n;s.source===e&&(console.log("received message from popup",s.data),(n=this.eventManager)==null||n.setPort(s.ports[0]))});const r=this.on(a.CANCEL,()=>{e==null||e.close()}),i=this.on(a.COMPLETE,()=>{e==null||e.close()});return this.completion().finally(()=>{r(),i()})}}function C(t){return Object.entries(t).map(([e,r])=>{if(r==null)return;const i=encodeURIComponent(e),s=encodeURIComponent(typeof r=="object"?JSON.stringify(r):String(r));return`${i}=${s}`}).filter(e=>e!==void 0).join("&")}function A(t){const e=t.slice(1);return e?e.split("&").filter(Boolean).reduce((i,s)=>{const[n,l]=s.split("=");return n&&(i[decodeURIComponent(n)]=l?decodeURIComponent(l):""),i},{}):{}}class U{constructor(e){o(this,"nodeUrl");o(this,"authToken");o(this,"uxUrl");o(this,"theme");o(this,"locale");this.uxUrl=e.uxUrl||"https://connect.notabene.id",this.nodeUrl=e.nodeUrl,this.authToken=e.authToken,this.theme=e.theme,this.locale=e.locale}componentUrl(e,r,i,s){const n=new URL(this.uxUrl);n.pathname=e;const l=C({authToken:this.authToken,value:r,configuration:i});return n.hash=l,this.nodeUrl&&n.searchParams.set("nodeUrl",this.nodeUrl),this.theme&&n.searchParams.set("theme",JSON.stringify(this.theme)),this.locale&&n.searchParams.set("locale",this.locale),s&&(s.callback&&n.searchParams.set("callback_url",s.callback),s.redirectUri&&n.searchParams.set("redirect_uri",s.redirectUri)),n.toString()}createComponent(e,r,i,s){return new g(this.componentUrl(e,r,i,s),r,i)}createWithdrawalAssist(e,r,i){return this.createComponent("withdrawal-assist",e,r,i)}createConnectWallet(e,r,i){return this.createComponent("connect",e,r,i)}createDepositRequest(e,r,i){return this.createComponent("deposit-request",e,r,i)}createDepositAssist(e,r,i){return this.createComponent("deposit-assist",e,r,i)}}exports.AgentType=c;exports.CMType=a;exports.EmbeddedComponent=g;exports.HMType=d;exports.PersonType=m;exports.ProofStatus=p;exports.ProofTypes=v;exports.Status=u;exports.VASPSearchControl=E;exports.ValidationSections=f;exports.decodeFragmentToObject=A;exports.default=U;

package/dist/notabene.d.ts

@@ -550,7 +550,7 @@ declare type Error_2 = {
 };
 export { Error_2 as Error }
 
-declare enum ErrorIdentifierCode {
+export declare enum ErrorIdentifierCode {
     SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",
     WALLET_CONNECTION_FAILED = "WALLET_CONNECTION_FAILED",
     WALLET_NOT_SUPPORTED = "WALLET_NOT_SUPPORTED",
@@ -1002,6 +1002,16 @@ declare class Notabene {
      * @public
      */
     createDepositRequest(value: DepositRequest, options?: DepositRequestOptions, callbacks?: CallbackOptions): EmbeddedComponent<DepositRequest, DepositRequestOptions>;
+    /**
+     * Creates a deposit assist component
+     *
+     * @param value - Partial deposit transaction data
+     * @param options - Optional transaction options
+     * @param callbacks - Optional callback configuration
+     * @returns A new EmbeddedComponent instance for deposit assistance
+     * @public
+     */
+    createDepositAssist(value: Partial<Deposit>, options?: TransactionOptions, callbacks?: CallbackOptions): EmbeddedComponent<Deposit, TransactionOptions>;
 }
 export default Notabene;
 
@@ -1401,6 +1411,7 @@ export declare interface TransactionOptions {
  * - ivms101: IVMS 101 travel rule data for the transaction
  * - proof: Optional ownership proof details if required
  * - txCreate: Optional V1 transaction payload for legacy API compatibility
+ * - txUpdate: Optional V1 transaction payload for legacy API compatibility
  *
  * @typeParam V - Type of the transaction value being returned
  *
@@ -1415,6 +1426,7 @@ export declare interface TransactionResponse<V> extends ComponentResponse {
     ivms101: IVMS101;
     proof?: OwnershipProof;
     txCreate?: V1Transaction;
+    txUpdate?: V1Transaction;
 }
 
 /**
@@ -1524,6 +1536,7 @@ export declare type V1Transaction = {
     originatorVASPdid: DID;
     beneficiaryVASPdid: DID;
     beneficiaryProof?: OwnershipProof;
+    originatorProof?: OwnershipProof;
     originator?: Originator;
     beneficiary: Beneficiary;
 };

package/dist/notabene.js

@@ -68,7 +68,7 @@ class I {
     this.port && this.port.postMessage(e);
   }
 }
-class U {
+class C {
   /**
    * Creates an instance of EmbeddedComponent.
    * @param url - The URL of the embedded component
@@ -237,7 +237,7 @@ class U {
     });
   }
 }
-function b(t) {
+function U(t) {
   return Object.entries(t).map(([e, r]) => {
     if (r == null) return;
     const i = encodeURIComponent(e), s = encodeURIComponent(
@@ -284,7 +284,7 @@ class A {
   componentUrl(e, r, i, s) {
     const n = new URL(this.uxUrl);
     n.pathname = e;
-    const a = b({
+    const a = U({
       authToken: this.authToken,
       value: r,
       configuration: i
@@ -302,7 +302,7 @@ class A {
    * @internal
    */
   createComponent(e, r, i, s) {
-    return new U(
+    return new C(
       this.componentUrl(e, r, i, s),
       r,
       i
@@ -358,11 +358,28 @@ class A {
       i
     );
   }
+  /**
+   * Creates a deposit assist component
+   *
+   * @param value - Partial deposit transaction data
+   * @param options - Optional transaction options
+   * @param callbacks - Optional callback configuration
+   * @returns A new EmbeddedComponent instance for deposit assistance
+   * @public
+   */
+  createDepositAssist(e, r, i) {
+    return this.createComponent(
+      "deposit-assist",
+      e,
+      r,
+      i
+    );
+  }
 }
 export {
   u as AgentType,
   h as CMType,
-  U as EmbeddedComponent,
+  C as EmbeddedComponent,
   d as HMType,
   E as PersonType,
   g as ProofStatus,

package/docs/README.md

@@ -24,32 +24,50 @@ This library is the JavaScript SDK for loading the Notabene UX components in the
 
 ## Table of Contents
 
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [Core Concepts](#core-concepts)
-  - [Authentication](#authentication)
-- [General Component Usage](#general-component-usage)
-  - [Embedded Component](#embedded-component)
-    - [Dynamic updates](#dynamic-updates)
-  - [Modal](#modal)
-  - [Linked Component](#linked-component)
-- [Components](#components)
+- [Notabene SafeConnect Components JavaScript SDK](#notabene-safeconnect-components-javascript-sdk)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Quick Start](#quick-start)
+  - [Core Concepts](#core-concepts)
+    - [Authentication](#authentication)
+  - [General Component Usage](#general-component-usage)
+    - [Embedded Component](#embedded-component)
+      - [Dynamic updates](#dynamic-updates)
+    - [Modal](#modal)
+    - [Popup](#popup)
+    - [Linked Component](#linked-component)
+  - [Components](#components)
   - [Assisted Withdrawal](#assisted-withdrawal)
+    - [Parameters](#parameters)
+    - [Configuration Options](#configuration-options)
   - [Connect Wallet](#connect-wallet)
+    - [Parameters](#parameters-1)
+    - [Configuration Options](#configuration-options-1)
   - [Deposit Request](#deposit-request)
-- [Error handling](#error-handling)
-- [Transaction parameters](#transaction-parameters)
-  - [Asset specification](#asset-specification)
-  - [Transaction amount](#transaction-amount)
-  - [Destination](#destination)
-  - [Asset Price](#asset-price)
-- [Configuration](#configuration)
-  - [Transaction Options](#transaction-options)
-  - [Common use cases](#common-use-cases)
-  - [Configuring ownership proofs](#configuring-ownership-proofs)
-  - [Counterparty Field Properties](#counterparty-field-properties)
-- [Locales](#locales)
-- [License](#license)
+    - [Parameters](#parameters-2)
+  - [Deposit Assist](#deposit-assist)
+    - [Parameters](#parameters-3)
+  - [Error handling](#error-handling)
+  - [Transaction parameters](#transaction-parameters)
+    - [Asset specification](#asset-specification)
+    - [Transaction amount](#transaction-amount)
+    - [Destination](#destination)
+    - [Origin](#origin)
+    - [Asset Price](#asset-price)
+  - [Configuration](#configuration)
+    - [Transaction Options](#transaction-options)
+    - [Common use cases](#common-use-cases)
+      - [Only allow first party transactions](#only-allow-first-party-transactions)
+      - [Only VASP to VASP transactions](#only-vasp-to-vasp-transactions)
+      - [Only Self-hosted wallet transactions](#only-self-hosted-wallet-transactions)
+    - [Configuring ownership proofs](#configuring-ownership-proofs)
+      - [Supporting Micro Transactions (aka Satoshi tests)](#supporting-micro-transactions-aka-satoshi-tests)
+      - [Fallback Proof Options](#fallback-proof-options)
+    - [Counterparty Field Properties](#counterparty-field-properties)
+      - [Full Example](#full-example)
+      - [Field reference](#field-reference)
+  - [Locales](#locales)
+  - [License](#license)
 
 ## Installation
 
@@ -375,6 +393,33 @@ const withdrawal = notabene.createDepositRequest({
 
 If any of the required parameters are missing the component will just show the Notabene badge.
 
+## Deposit Assist
+
+The Deposit Assist component helps you collect missing Travel Rule data after a deposit has already been recorded on-chain. For example, if the deposit arrived with incomplete originator information, you can use Deposit Assist to request this information from your end-user.
+
+```js
+const deposit = notabene.createDepositAssist(
+  {
+    asset: 'ETH',
+    amountDecimal: 1.23,
+    origin: '0x...',
+    destination: '0x...',
+  },
+  {
+    // Optional transaction options
+  },
+);
+```
+
+### Parameters
+
+- `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
+- `origin`: The origin or blockchain address for the deposit. See [Origin](#origin)
+- `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
+- `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
+
+If any of the required parameters are missing the component will just show the Notabene badge.
+
 ---
 
 ## Error handling
@@ -410,6 +455,15 @@ Specify the beneficiary address as `destination` using one of the following form
 - [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
 - Native blockchain address
 
+### Origin
+
+Specify the originator address as `origin` using one of the following formats:
+
+- [CAIP-10](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-10.md_) is a chain agnostic format allows you to specify the specific blockchain and address
+- [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770) EVM URI
+- [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
+- Native blockchain address
+
 ### Asset Price
 
 The price of the asset is used to determine certain rules based on thresholds. We recommond you pass in your price like this:
@@ -483,8 +537,8 @@ const options: TransactionOptions = {
       onlyActive: true, // Only list active VASPs - Default false
       searchable: [
         VASPSearchControl.ALLOWED, // JS: 'allowed'
-        VASPSearchControl.PENDING // JS: 'pending'
-      ] // Control searches for VASPs - Defaults to undefined
+        VASPSearchControl.PENDING, // JS: 'pending'
+      ], // Control searches for VASPs - Defaults to undefined
     },
     hide: [ValidationSections.ASSET, ValidationSections.DESTINATION], // Don't show specific sections of component
   },

package/docs/types/interfaces/TransactionResponse.md

@@ -15,6 +15,7 @@ Extends ComponentResponse to add transaction-specific response data:
 - ivms101: IVMS 101 travel rule data for the transaction
 - proof: Optional ownership proof details if required
 - txCreate: Optional V1 transaction payload for legacy API compatibility
+- txUpdate: Optional V1 transaction payload for legacy API compatibility
 
 ## See
 

package/docs/types/type-aliases/V1Transaction.md

@@ -32,6 +32,10 @@ Transaction payload suitable for calling Notabene v1 tx/create
 
 > `optional` **originatorEqualsBeneficiary**: `boolean`
 
+### originatorProof?
+
+> `optional` **originatorProof**: [`OwnershipProof`](../interfaces/OwnershipProof.md)
+
 ### originatorVASPdid
 
 > **originatorVASPdid**: [`DID`](DID.md)

package/package.json

@@ -10,7 +10,7 @@
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
   "packageManager": "yarn@4.5.1",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "source": "src/notabene.ts",
   "main": "dist/notabene.js",
   "types": "dist/notabene.d.ts",

package/src/__tests__/notabene.test.ts

@@ -6,6 +6,7 @@ import {
   arbitraryComponent,
   arbitraryConnectionOptions,
   arbitraryConnectionRequest,
+  arbitraryDeposit,
   arbitraryDepositRequest,
   arbitraryDepositRequestOptions,
   arbitraryLocale,
@@ -267,4 +268,39 @@ describe('Notabene', () => {
       },
     );
   });
+  describe('createDepositAssist', () => {
+    test.prop([
+      fc.string({ minLength: 3 }), // authToken
+      fc.webUrl(), // nodeUrl
+      arbitraryDeposit(),
+      arbitraryTransactionOptions(), // options
+      abitraryCallbackOptions(), // callbacks
+    ])(
+      'Should create deposit assist component with correct URL',
+      (authToken, nodeUrl, value, options, callbacks) => {
+        const notabene = new Notabene({
+          nodeUrl,
+          authToken,
+        });
+
+        const component = notabene.createDepositAssist(
+          value,
+          options,
+          callbacks,
+        );
+        const url = new URL(component.url);
+
+        return (
+          url.pathname === '/deposit-assist' &&
+          url.hash ===
+            `#authToken=${encodeURIComponent(authToken)}&value=${encodeURIComponent(
+              JSON.stringify(value),
+            )}&configuration=${encodeURIComponent(JSON.stringify(options))}` &&
+          url.searchParams.get('nodeUrl') === nodeUrl &&
+          url.searchParams.get('callback_url') === callbacks.callback &&
+          url.searchParams.get('redirect_uri') === callbacks.redirectUri
+        );
+      },
+    );
+  });
 });

package/src/notabene.ts

@@ -22,6 +22,7 @@ import type {
   DID,
   DTI,
   Error,
+  ErrorIdentifierCode,
   FieldTypes,
   HostMessage,
   InvalidValue,
@@ -100,6 +101,7 @@ export type {
   DID,
   DTI,
   Error,
+  ErrorIdentifierCode,
   FieldTypes,
   HostMessage,
   InvalidValue,
@@ -321,4 +323,26 @@ export default class Notabene {
       callbacks,
     );
   }
+
+  /**
+   * Creates a deposit assist component
+   *
+   * @param value - Partial deposit transaction data
+   * @param options - Optional transaction options
+   * @param callbacks - Optional callback configuration
+   * @returns A new EmbeddedComponent instance for deposit assistance
+   * @public
+   */
+  public createDepositAssist(
+    value: Partial<Deposit>,
+    options?: TransactionOptions,
+    callbacks?: CallbackOptions,
+  ) {
+    return this.createComponent<Deposit, TransactionOptions>(
+      'deposit-assist',
+      value,
+      options,
+      callbacks,
+    );
+  }
 }

package/src/types.ts

@@ -616,6 +616,7 @@ export type V1Transaction = {
   originatorVASPdid: DID;
   beneficiaryVASPdid: DID;
   beneficiaryProof?: OwnershipProof;
+  originatorProof?: OwnershipProof;
   originator?: Originator;
   beneficiary: Beneficiary;
 };
@@ -655,6 +656,7 @@ export interface ComponentResponse {
  * - ivms101: IVMS 101 travel rule data for the transaction
  * - proof: Optional ownership proof details if required
  * - txCreate: Optional V1 transaction payload for legacy API compatibility
+ * - txUpdate: Optional V1 transaction payload for legacy API compatibility
  *
  * @typeParam V - Type of the transaction value being returned
  *
@@ -669,6 +671,7 @@ export interface TransactionResponse<V> extends ComponentResponse {
   ivms101: IVMS101;
   proof?: OwnershipProof;
   txCreate?: V1Transaction;
+  txUpdate?: V1Transaction;
 }
 
 /**

package/src/utils/arbitraries.ts

@@ -11,6 +11,7 @@ import type {
   ConnectionRequest,
   Counterparty,
   CryptoCredential,
+  Deposit,
   DepositRequest,
   DepositRequestOptions,
   DID,
@@ -242,3 +243,13 @@ export const arbitraryConnectionOptions =
       proofs: transactionOptions.map((opt) => opt.proofs),
     });
   };
+
+export const arbitraryDeposit = (): fc.Arbitrary<Deposit> =>
+  fc.record({
+    agent: arbitraryAgent(),
+    counterparty: arbitraryCounterparty(),
+    asset: arbitraryTransactionAsset(),
+    amountDecimal: fc.float({ min: 0, max: 1e6 }),
+    origin: fc.oneof(arbitraryBlockchainAddress(), arbitraryCAIP10()),
+    destination: fc.oneof(arbitraryBlockchainAddress(), arbitraryCAIP10()),
+  });