@zerohash-sdk/fund-js 1.3.0 → 1.4.1

package/README.md

@@ -1,158 +1,166 @@
-# @zerohash-sdk/crypto-sell-js
+# @zerohash-sdk/fund-js
 
-A JavaScript SDK that enables frontend applications to seamlessly integrate with the Connect Crypto Sell product.
+A JavaScript SDK that enables frontend applications to seamlessly integrate with the Connect Fund product.
 
-Connect Crypto Sell provides a secure, customizable flow for selling crypto assets directly within your application.
+Connect Fund provides a secure, customizable flow for funding accounts via crypto deposits directly within your application.
 
 ## Installation
 
 ### Via NPM (recommended)
 
 ```bash
-npm install @zerohash-sdk/crypto-sell-js
+npm install @zerohash-sdk/fund-js
 ```
 
 ```javascript
-import { CryptoSell } from '@zerohash-sdk/crypto-sell-js';
+import { Fund } from '@zerohash-sdk/fund-js';
 ```
 
 ### Via CDN
 
-You can import the script in your HTML file and use the `CryptoSell` class provided by it.
+You can import the script in your HTML file and use the `Fund` class provided by it.
 
 ```html
 <script
   type="module"
-  src="https://sdk.connect.xyz/crypto-sell-web/index.js"
+  src="https://sdk.connect.xyz/fund-web/index.js"
 ></script>
 ```
 
 Or import directly in your JavaScript code:
 
 ```javascript
-import { CryptoSell } from 'https://sdk.connect.xyz/crypto-sell-web/index.js';
+import { Fund } from 'https://sdk.connect.xyz/fund-web/index.js';
 ```
 
 ## Getting Started
 
-Follow these simple steps to integrate Connect Crypto Sell into your frontend application:
+Follow these simple steps to integrate Connect Fund into your frontend application:
 
-### 1. Import the CryptoSell module
+### 1. Import the Fund module
 
 ```javascript
-import { CryptoSell } from '@zerohash-sdk/crypto-sell-js';
+import { Fund } from '@zerohash-sdk/fund-js';
 ```
 
 ### 1.1 Or import via CDN
 
 ```javascript
-import { CryptoSell } from 'https://sdk.connect.xyz/crypto-sell-web/index.js';
+import { Fund } from 'https://sdk.connect.xyz/fund-web/index.js';
 ```
 
 ### 2. Initialize and render the widget
 
 ```javascript
-// Create a CryptoSell instance with configuration
-const cryptoSell = new CryptoSell({
+// Create a Fund instance with configuration
+const fund = new Fund({
   jwt: 'your-jwt-token', // Obtain this from your backend
   env: 'prod', // or 'cert' for testing
   theme: 'auto', // 'auto' (default), 'light', or 'dark'
-  onCompleted: ({ amountSold, assetSymbol }) => {
-    console.log('Sell completed:', amountSold, assetSymbol);
+  onCompleted: ({ assetSymbol, amount, network, depositAddress }) => {
+    console.log('Fund completed:', amount, assetSymbol, network, depositAddress);
   },
   onError: ({ errorCode, reason }) => {
-    console.error('Crypto sell error:', errorCode, 'Reason:', reason);
+    console.error('Fund error:', errorCode, 'Reason:', reason);
   },
   onClose: () => {
-    console.log('Crypto sell widget closed');
+    console.log('Fund widget closed');
   },
   onEvent: ({ type, data }) => {
     console.log('Event received:', type, data);
   },
   onLoaded: () => {
-    console.log('Crypto sell widget loaded and ready');
+    console.log('Fund widget loaded and ready');
   },
 });
 
 // Render the widget to a container element
-const container = document.getElementById('crypto-sell-container');
-await cryptoSell.render(container);
+const container = document.getElementById('fund-container');
+await fund.render(container);
 
 // Update configuration dynamically
-cryptoSell.updateConfig({
+fund.updateConfig({
   jwt: 'new-jwt-token',
   theme: 'dark',
 });
 
 // Check if rendered
-if (cryptoSell.isRendered()) {
+if (fund.isRendered()) {
   console.log('Widget is active');
 }
 
 // Clean up when done
-cryptoSell.destroy();
+fund.destroy();
 ```
 
 ### 2.1 Using TypeScript (optional)
 
 ```typescript
-import { CryptoSell, CryptoSellConfig } from '@zerohash-sdk/crypto-sell-js';
+import { Fund, FundConfig } from '@zerohash-sdk/fund-js';
 
-const config: CryptoSellConfig = {
+const config: FundConfig = {
   jwt: 'your-jwt-token',
   env: 'cert',
   theme: 'dark',
-  onCompleted: ({ amountSold, assetSymbol }) => {
-    console.log(`Sold ${amountSold} ${assetSymbol}`);
+  onCompleted: ({ assetSymbol, amount }) => {
+    console.log(`Funded ${amount} ${assetSymbol}`);
   },
   onError: ({ errorCode, reason }) => {
     console.error(errorCode, reason);
   },
 };
 
-const cryptoSell = new CryptoSell(config);
-await cryptoSell.render(document.getElementById('crypto-sell-container')!);
+const fund = new Fund(config);
+await fund.render(document.getElementById('fund-container')!);
 ```
 
 ## API Reference
 
 ### Configuration
 
-| Prop          | Type                                    | Required | Default  | Description                                        |
-| ------------- | --------------------------------------- | -------- | -------- | -------------------------------------------------- |
-| `jwt`         | `string`                                | Yes      | -        | JWT token for authentication with Connect          |
-| `env`         | `"prod" \| "cert" \| "dev" \| "local"`  | No       | `"prod"` | Target environment                                 |
-| `theme`       | `"auto" \| "light" \| "dark"`           | No       | `"auto"` | Theme mode for the interface                       |
-| `onCompleted` | `({ amountSold, assetSymbol }) => void` | No       | -        | Callback when the sell flow completes successfully |
-| `onError`     | `({ errorCode, reason }) => void`       | No       | -        | Callback for error events                          |
-| `onClose`     | `() => void`                            | No       | -        | Callback when the widget is closed                 |
-| `onEvent`     | `({ type, data }) => void`              | No       | -        | Callback for general events                        |
-| `onLoaded`    | `() => void`                            | No       | -        | Callback when the widget is loaded and ready       |
+| Prop          | Type                                                         | Required | Default  | Description                                        |
+| ------------- | ------------------------------------------------------------ | -------- | -------- | -------------------------------------------------- |
+| `jwt`         | `string`                                                     | Yes      | -        | JWT token for authentication with Connect          |
+| `env`         | `"prod" \| "cert" \| "dev" \| "local"`                       | No       | `"prod"` | Target environment                                 |
+| `theme`       | `"auto" \| "light" \| "dark"`                                | No       | `"auto"` | Theme mode for the interface                       |
+| `isPay`       | `boolean`                                                    | No       | `false`  | Run the SDK in Pay mode (see notes below)          |
+| `onCompleted` | `({ assetSymbol, amount, network, depositAddress }) => void` | No       | -        | Callback when the fund flow completes successfully |
+| `onError`     | `({ errorCode, reason }) => void`                            | No       | -        | Callback for error events                          |
+| `onClose`     | `() => void`                                                 | No       | -        | Callback when the widget is closed                 |
+| `onEvent`     | `({ type, data }) => void`                                   | No       | -        | Callback for general events                        |
+| `onLoaded`    | `() => void`                                                 | No       | -        | Callback when the widget is loaded and ready       |
+
+### Pay mode (`isPay`)
+
+When `isPay` is `true`, the Fund SDK runs in Pay mode:
+
+- Uses the `pay-sdk` app id and the `app:internal:pay` scope when calling trade-api.
+- Signs the `account_funding_pay` terms agreement.
 
 ### Constructor
 
 ```javascript
-new CryptoSell(config: CryptoSellConfig)
+new Fund(config: FundConfig)
 ```
 
-Creates a new CryptoSell instance with the provided configuration.
+Creates a new Fund instance with the provided configuration.
 
 ### Methods
 
 #### `render(container: HTMLElement): Promise<void>`
 
-Renders the Crypto Sell widget to the specified container element.
+Renders the Fund widget to the specified container element.
 
 ```javascript
-await cryptoSell.render(document.getElementById('crypto-sell-container'));
+await fund.render(document.getElementById('fund-container'));
 ```
 
-#### `updateConfig(config: Partial<CryptoSellConfig>): void`
+#### `updateConfig(config: Partial<FundConfig>): void`
 
 Updates the configuration of an already rendered widget.
 
 ```javascript
-cryptoSell.updateConfig({
+fund.updateConfig({
   jwt: 'new-token',
   theme: 'dark',
 });
@@ -163,7 +171,7 @@ cryptoSell.updateConfig({
 Removes the widget from the DOM and cleans up resources.
 
 ```javascript
-cryptoSell.destroy();
+fund.destroy();
 ```
 
 #### `isRendered(): boolean`
@@ -171,17 +179,17 @@ cryptoSell.destroy();
 Returns whether the widget is currently rendered.
 
 ```javascript
-if (cryptoSell.isRendered()) {
+if (fund.isRendered()) {
   // Widget is active
 }
 ```
 
-#### `getConfig(): CryptoSellConfig`
+#### `getConfig(): FundConfig`
 
 Returns a copy of the current configuration.
 
 ```javascript
-const config = cryptoSell.getConfig();
+const config = fund.getConfig();
 console.log('Current JWT:', config.jwt);
 ```
 
@@ -189,18 +197,20 @@ console.log('Current JWT:', config.jwt);
 
 ### onCompleted
 
-Called when the sell flow completes successfully.
+Called when the fund flow completes successfully.
 
 ```javascript
-onCompleted: ({ amountSold, assetSymbol }) => {
-  // amountSold: Quantity sold as a string
-  // assetSymbol: Symbol of the asset sold (e.g. 'BTC.BITCOIN')
+onCompleted: ({ assetSymbol, amount, network, depositAddress }) => {
+  // assetSymbol: Asset symbol (e.g. 'BTC.BITCOIN')
+  // amount: Amount to be deposited as a string
+  // network: Network used for the deposit
+  // depositAddress: Deposit address for the asset
 };
 ```
 
 ### onError
 
-Called when an error occurs in the Crypto Sell widget.
+Called when an error occurs in the Fund widget.
 
 ```javascript
 onError: ({ errorCode, reason }) => {
@@ -211,7 +221,7 @@ onError: ({ errorCode, reason }) => {
 
 ### onClose
 
-Called when the Crypto Sell widget is closed by the user.
+Called when the Fund widget is closed by the user.
 
 ```javascript
 onClose: () => {
@@ -221,7 +231,7 @@ onClose: () => {
 
 ### onEvent
 
-Called for general events from the Crypto Sell widget.
+Called for general events from the Fund widget.
 
 ```javascript
 onEvent: ({ type, data }) => {
@@ -232,7 +242,7 @@ onEvent: ({ type, data }) => {
 
 ### onLoaded
 
-Called when the Crypto Sell widget has fully loaded and is ready for user interaction.
+Called when the Fund widget has fully loaded and is ready for user interaction.
 
 ```javascript
 onLoaded: () => {

package/dist/index.d.ts

@@ -441,6 +441,17 @@ declare type FundCompletedData = {
 };
 
 export declare interface FundConfig extends BaseConfig<FundEvent>, FundCallbacks {
+    /**
+     * Runs the SDK in Pay mode.
+     *
+     * - Uses the `pay-sdk` app id and `app:internal:pay` scope when talking to trade-api.
+     * - Signs the `account_funding_pay` terms agreement.
+     * - Polls deposit status by `transactionId` (single-deposit endpoint) instead of
+     *   by `deposit_address` (list endpoint).
+     *
+     * @default false
+     */
+    isPay?: boolean;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zerohash-sdk/fund-js",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "private": false,
   "type": "module",
   "main": "./dist/index.js",