@notabene/javascript-sdk 2.4.1 → 2.5.1

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

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

@@ -1,8 +1,8 @@
 var c = Object.defineProperty;
-var m = (t, e, r) => e in t ? c(t, e, { enumerable: !0, configurable: !0, writable: !0, value: r }) : t[e] = r;
-var o = (t, e, r) => m(t, typeof e != "symbol" ? e + "" : e, r);
-var u = /* @__PURE__ */ ((t) => (t.PRIVATE = "WALLET", t.VASP = "VASP", t))(u || {}), E = /* @__PURE__ */ ((t) => (t.NATURAL = "natural", t.LEGAL = "legal", t.SELF = "self", t))(E || {}), f = /* @__PURE__ */ ((t) => (t.EMPTY = "empty", t.VERIFY = "verify", t.PENDING = "pending", t.VERIFIED = "verified", t.BANNED = "banned", t))(f || {}), p = /* @__PURE__ */ ((t) => (t.ALLOWED = "allowed", t.PENDING = "pending", t))(p || {}), v = /* @__PURE__ */ ((t) => (t.ASSET = "asset", t.DESTINATION = "destination", t.COUNTERPARTY = "counterparty", t.AGENT = "agent", t))(v || {}), h = /* @__PURE__ */ ((t) => (t.COMPLETE = "complete", t.RESIZE = "resize", t.RESULT = "result", t.READY = "ready", t.INVALID = "invalid", t.ERROR = "error", t.CANCEL = "cancel", t))(h || {}), d = /* @__PURE__ */ ((t) => (t.UPDATE = "update", t.REQUEST_RESPONSE = "requestResponse", t))(d || {}), g = /* @__PURE__ */ ((t) => (t.PENDING = "pending", t.FAILED = "rejected", t.FLAGGED = "flagged", t.VERIFIED = "verified", t))(g || {}), w = /* @__PURE__ */ ((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))(w || {});
-class I {
+var m = (e, t, r) => t in e ? c(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
+var o = (e, t, r) => m(e, typeof t != "symbol" ? t + "" : t, r);
+var u = /* @__PURE__ */ ((e) => (e.PRIVATE = "WALLET", e.VASP = "VASP", e))(u || {}), E = /* @__PURE__ */ ((e) => (e.NATURAL = "natural", e.LEGAL = "legal", e.SELF = "self", e))(E || {}), f = /* @__PURE__ */ ((e) => (e.EMPTY = "empty", e.VERIFY = "verify", e.PENDING = "pending", e.VERIFIED = "verified", e.BANNED = "banned", e))(f || {}), p = /* @__PURE__ */ ((e) => (e.ALLOWED = "allowed", e.PENDING = "pending", e))(p || {}), v = /* @__PURE__ */ ((e) => (e.ASSET = "asset", e.DESTINATION = "destination", e.COUNTERPARTY = "counterparty", e.AGENT = "agent", e))(v || {}), h = /* @__PURE__ */ ((e) => (e.COMPLETE = "complete", e.RESIZE = "resize", e.RESULT = "result", e.READY = "ready", e.INVALID = "invalid", e.ERROR = "error", e.CANCEL = "cancel", e))(h || {}), I = /* @__PURE__ */ ((e) => (e.SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE", e.WALLET_CONNECTION_FAILED = "WALLET_CONNECTION_FAILED", e.WALLET_NOT_SUPPORTED = "WALLET_NOT_SUPPORTED", e.TOKEN_INVALID = "TOKEN_INVALID", e))(I || {}), d = /* @__PURE__ */ ((e) => (e.UPDATE = "update", e.REQUEST_RESPONSE = "requestResponse", e))(d || {}), L = /* @__PURE__ */ ((e) => (e.PENDING = "pending", e.FAILED = "rejected", e.FLAGGED = "flagged", e.VERIFIED = "verified", e))(L || {}), g = /* @__PURE__ */ ((e) => (e.SelfDeclaration = "self-declaration", e.SIWE = "siwe", e.SIWX = "siwx", e.EIP191 = "eip-191", e.EIP712 = "eip-712", e.EIP1271 = "eip-1271", e.BIP137 = "bip-137", e.BIP322 = "bip-322", e.BIP137_XPUB = "xpub", e.TIP191 = "tip-191", e.ED25519 = "ed25519", e.MicroTransfer = "microtransfer", e.Screenshot = "screenshot", e.Connect = "connect", e))(g || {});
+class A {
   constructor() {
     o(this, "listeners", /* @__PURE__ */ new Map());
     o(this, "port");
@@ -16,8 +16,8 @@ class I {
    *
    * @param port - The MessagePort instance to use for communication
    */
-  setPort(e) {
-    this.port = e, this.port.onmessage = this.handleMessage, this.port.start();
+  setPort(t) {
+    this.port = t, this.port.onmessage = this.handleMessage, this.port.start();
   }
   /**
      * Registers a callback for a specific message type.
@@ -29,8 +29,8 @@ class I {
      * @param callback - The callback function to execute when matching messages are received
   
      */
-  on(e, r) {
-    return this.listeners.has(e) || this.listeners.set(e, /* @__PURE__ */ new Set()), this.listeners.get(e).add(r), () => this.off(e, r);
+  on(t, r) {
+    return this.listeners.has(t) || this.listeners.set(t, /* @__PURE__ */ new Set()), this.listeners.get(t).add(r), () => this.off(t, r);
   }
   /**
    * Removes a callback for a specific message type.
@@ -41,9 +41,9 @@ class I {
    * @param messageType - The type of message to remove listener from
    * @param callback - The callback function to remove
    */
-  off(e, r) {
-    const i = this.listeners.get(e);
-    i && (i.delete(r), i.size === 0 && this.listeners.delete(e));
+  off(t, r) {
+    const s = this.listeners.get(t);
+    s && (s.delete(r), s.size === 0 && this.listeners.delete(t));
   }
   /**
    * Internal message handler for processing received messages.
@@ -53,28 +53,28 @@ class I {
    *
    * @param event - The message event containing the component message
    */
-  handleMessage(e) {
-    const r = e.data;
+  handleMessage(t) {
+    const r = t.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));
+      const s = r.type, i = this.listeners.get(s);
+      i && i.forEach((n) => n(r));
     }
   }
   /**
    * Sends a message through the message port
    * @param message The host message to send
    */
-  send(e) {
-    this.port && this.port.postMessage(e);
+  send(t) {
+    this.port && this.port.postMessage(t);
   }
 }
-class U {
+class N {
   /**
    * Creates an instance of EmbeddedComponent.
    * @param url - The URL of the embedded component
    * @param value - The initial transaction value
    */
-  constructor(e, r, i) {
+  constructor(t, r, s) {
     o(this, "_url");
     o(this, "_value");
     o(this, "_options");
@@ -82,10 +82,10 @@ class U {
     o(this, "iframe");
     o(this, "eventManager");
     o(this, "modal");
-    this._url = e, this._value = r, this._options = i, this.eventManager = new I(), this.on(h.INVALID, (s) => {
-      s.type === h.INVALID && (this._errors = s.errors, this._value = s.value);
-    }), this.on(h.RESIZE, (s) => {
-      s.type === h.RESIZE && this.iframe && (this.iframe.style.height = `${s.height}px`);
+    this._url = t, this._value = r, this._options = s, this.eventManager = new A(), this.on(h.INVALID, (i) => {
+      i.type === h.INVALID && (this._errors = i.errors, this._value = i.value);
+    }), this.on(h.RESIZE, (i) => {
+      i.type === h.RESIZE && this.iframe && (this.iframe.style.height = `${i.height}px`);
     });
   }
   /**
@@ -119,21 +119,21 @@ class U {
    * @param parentId - The ID of the parent element
    * @throws Will throw an error if the parent element is not found
    */
-  mount(e) {
-    const r = document.querySelector(e);
-    if (!r) throw new Error(`parentID ${e} not found`);
+  mount(t) {
+    const r = document.querySelector(t);
+    if (!r) throw new Error(`parentID ${t} not found`);
     this.embed(r);
   }
   /**
    * Embeds the component into a parent element
    * @param parent - The parent element to embed the component into
    */
-  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) => {
+  embed(t, r = !1) {
+    var s, i;
+    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", t.appendChild(this.iframe), window.addEventListener("message", (n) => {
       var a, l;
       n.source === ((a = this.iframe) == null ? void 0 : a.contentWindow) && ((l = this.eventManager) == null || l.setPort(n.ports[0]));
-    }), (s = (i = this.iframe) == null ? void 0 : i.contentWindow) == null || s.focus();
+    }), (i = (s = this.iframe) == null ? void 0 : s.contentWindow) == null || i.focus();
   }
   removeEmbed() {
     this.iframe && this.iframe.remove();
@@ -142,45 +142,45 @@ class U {
    * Sends a message to the embedded component
    * @param message - The message to send
    */
-  send(e) {
-    this.eventManager.send(e);
+  send(t) {
+    this.eventManager.send(t);
   }
   /**
    * Adds an event listener for a specific message type
    * @param messageType - The type of message to listen for
    * @param callback - The callback function to execute when the message is received
    */
-  on(e, r) {
-    return this.eventManager.on(e, r);
+  on(t, r) {
+    return this.eventManager.on(t, r);
   }
   /**
    * Removes an event listener for a specific message type
    * @param messageType - The type of message to stop listening for
    * @param callback - The callback function to remove
    */
-  off(e, r) {
-    this.eventManager.off(e, r);
+  off(t, r) {
+    this.eventManager.off(t, r);
   }
   /**
    * Updates the transaction value and sends an update message to the component
    * @param value - The new transaction value
    */
-  update(e, r) {
-    this._value = e, r && (this._options = r), this.send({ type: d.UPDATE, value: e, options: this._options });
+  update(t, r) {
+    this._value = t, r && (this._options = r), this.send({ type: d.UPDATE, value: t, options: this._options });
   }
   /**
    * Waits for the component to complete and returns the transaction response
    * @returns A promise that resolves with the transaction response
    */
   completion() {
-    return new Promise((e, r) => {
-      let i, s, n;
+    return new Promise((t, r) => {
+      let s, i, n;
       function a() {
-        i && i(), s && s(), n && n();
+        s && s(), i && i(), n && n();
       }
-      i = this.on(h.COMPLETE, (l) => {
-        e(l.response), a();
-      }), s = this.on(h.CANCEL, () => {
+      s = this.on(h.COMPLETE, (l) => {
+        t(l.response), a();
+      }), i = this.on(h.CANCEL, () => {
         r(new Error("User cancelled")), a();
       }), n = this.on("error", (l) => {
         r(new Error(l.message)), a();
@@ -192,7 +192,7 @@ class U {
    */
   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(h.CANCEL, () => {
+    const t = this.on(h.CANCEL, () => {
       this.closeModal();
     }), r = this.on(h.COMPLETE, () => {
       this.closeModal();
@@ -200,7 +200,7 @@ class U {
     return this.modal.showModal(), this.modal.addEventListener("click", () => {
       this.closeModal();
     }), this.completion().finally(() => {
-      e(), r();
+      t(), r();
     });
   }
   /**
@@ -208,8 +208,8 @@ class U {
    *
    */
   closeModal() {
-    var e;
-    this.modal && ((e = this.modal) == null || e.close(), this.modal.remove(), this.modal = void 0);
+    var t;
+    this.modal && ((t = this.modal) == null || t.close(), this.modal.remove(), this.modal = void 0);
   }
   /**
    * Opens the component in a popup window. This may be needed to support many self-hosted wallets
@@ -218,58 +218,58 @@ class U {
    * @see [Cross-Origin-Opener-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cross-Origin-Opener-Policy)
    */
   async popup() {
-    const e = window.open(
+    const t = window.open(
       this.url,
       "_blank",
       "popup=true,width=600,height=600"
     );
-    window.addEventListener("message", (s) => {
+    window.addEventListener("message", (i) => {
       var n;
-      s.source === e && (console.log("received message from popup", s.data), (n = this.eventManager) == null || n.setPort(s.ports[0]));
+      i.source === t && (console.log("received message from popup", i.data), (n = this.eventManager) == null || n.setPort(i.ports[0]));
     });
     const r = this.on(h.CANCEL, () => {
-      e == null || e.close();
-    }), i = this.on(h.COMPLETE, () => {
-      e == null || e.close();
+      t == null || t.close();
+    }), s = this.on(h.COMPLETE, () => {
+      t == null || t.close();
     });
     return this.completion().finally(() => {
-      r(), i();
+      r(), s();
     });
   }
 }
-function b(t) {
-  return Object.entries(t).map(([e, r]) => {
+function w(e) {
+  return Object.entries(e).map(([t, r]) => {
     if (r == null) return;
-    const i = encodeURIComponent(e), s = encodeURIComponent(
+    const s = encodeURIComponent(t), i = encodeURIComponent(
       typeof r == "object" ? JSON.stringify(r) : String(r)
       // Use String() to handle all primitive types
     );
-    return `${i}=${s}`;
-  }).filter((e) => e !== void 0).join("&");
+    return `${s}=${i}`;
+  }).filter((t) => t !== void 0).join("&");
 }
-function L(t) {
-  const e = t.slice(1);
-  return e ? e.split("&").filter(Boolean).reduce(
-    (i, s) => {
-      const [n, a] = s.split("=");
-      return n && (i[decodeURIComponent(n)] = a ? decodeURIComponent(a) : ""), i;
+function U(e) {
+  const t = e.slice(1);
+  return t ? t.split("&").filter(Boolean).reduce(
+    (s, i) => {
+      const [n, a] = i.split("=");
+      return n && (s[decodeURIComponent(n)] = a ? decodeURIComponent(a) : ""), s;
     },
     {}
   ) : {};
 }
-class A {
+class C {
   /**
    * Creates a new instance of the Notabene SDK
    *
    * @param config - Configuration options for the Notabene SDK
    */
-  constructor(e) {
+  constructor(t) {
     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;
+    this.uxUrl = t.uxUrl || "https://connect.notabene.id", this.nodeUrl = t.nodeUrl, this.authToken = t.authToken, this.theme = t.theme, this.locale = t.locale;
   }
   /**
    * Generates a URL for a Notabene component
@@ -281,15 +281,15 @@ class A {
    * @returns component URL
    * @internal
    */
-  componentUrl(e, r, i, s) {
+  componentUrl(t, r, s, i) {
     const n = new URL(this.uxUrl);
-    n.pathname = e;
-    const a = b({
+    n.pathname = t;
+    const a = w({
       authToken: this.authToken,
       value: r,
-      configuration: i
+      configuration: s
     });
-    return n.hash = a, 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();
+    return n.hash = a, 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), i && (i.callback && n.searchParams.set("callback_url", i.callback), i.redirectUri && n.searchParams.set("redirect_uri", i.redirectUri)), n.toString();
   }
   /**
    * Creates a new embedded component
@@ -301,11 +301,11 @@ class A {
    * @returns A new EmbeddedComponent instance
    * @internal
    */
-  createComponent(e, r, i, s) {
-    return new U(
-      this.componentUrl(e, r, i, s),
+  createComponent(t, r, s, i) {
+    return new N(
+      this.componentUrl(t, r, s, i),
       r,
-      i
+      s
     );
   }
   /**
@@ -316,12 +316,12 @@ class A {
    * @param callbacks - Optional callback configuration
    * @returns A new EmbeddedComponent instance for withdrawal assistance
    */
-  createWithdrawalAssist(e, r, i) {
+  createWithdrawalAssist(t, r, s) {
     return this.createComponent(
       "withdrawal-assist",
-      e,
+      t,
       r,
-      i
+      s
     );
   }
   /**
@@ -333,12 +333,12 @@ class A {
    * @returns A new EmbeddedComponent instance for connection
    * @alpha
    */
-  createConnectWallet(e, r, i) {
+  createConnectWallet(t, r, s) {
     return this.createComponent(
       "connect",
-      e,
+      t,
       r,
-      i
+      s
     );
   }
   /**
@@ -350,26 +350,44 @@ class A {
    * @returns A new EmbeddedComponent instance for deposit requests
    * @public
    */
-  createDepositRequest(e, r, i) {
+  createDepositRequest(t, r, s) {
     return this.createComponent(
       "deposit-request",
-      e,
+      t,
+      r,
+      s
+    );
+  }
+  /**
+   * 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(t, r, s) {
+    return this.createComponent(
+      "deposit-assist",
+      t,
       r,
-      i
+      s
     );
   }
 }
 export {
   u as AgentType,
   h as CMType,
-  U as EmbeddedComponent,
+  N as EmbeddedComponent,
+  I as ErrorIdentifierCode,
   d as HMType,
   E as PersonType,
-  g as ProofStatus,
-  w as ProofTypes,
+  L as ProofStatus,
+  g as ProofTypes,
   f as Status,
   p as VASPSearchControl,
   v as ValidationSections,
-  L as decodeFragmentToObject,
-  A as default
+  U as decodeFragmentToObject,
+  C as default
 };

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.1",
+  "version": "2.5.1",
   "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

@@ -55,6 +55,7 @@ import type {
 import {
   AgentType,
   CMType,
+  ErrorIdentifierCode,
   HMType,
   PersonType,
   ProofStatus,
@@ -71,6 +72,7 @@ export {
   AgentType,
   CMType,
   decodeFragmentToObject,
+  ErrorIdentifierCode,
   HMType,
   PersonType,
   ProofStatus,
@@ -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()),
+  });