@notabene/javascript-sdk 2.9.0 → 2.9.1-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -380,7 +380,7 @@ const connect = notabene.createConnectWallet(
380
380
  The Deposit Request lets your customers request deposits that are fully Travel Rule compliant.
381
381
 
382
382
  ```js
383
- const withdrawal = notabene.createDepositRequest({
383
+ const depositRequest = notabene.createDepositRequest({
384
384
  asset: 'ETH',
385
385
  destination: '0x...',
386
386
  amountDecimal: 1.23,
@@ -408,7 +408,7 @@ const deposit = notabene.createDepositAssist(
408
408
  {
409
409
  asset: 'ETH',
410
410
  amountDecimal: 1.23,
411
- origin: '0x...',
411
+ source: '0x...',
412
412
  destination: '0x...',
413
413
  transactionId: "UUID"
414
414
  },
@@ -421,7 +421,7 @@ const deposit = notabene.createDepositAssist(
421
421
  ### Parameters
422
422
 
423
423
  - `asset`: The cryptocurrency or token being transferred. See [Asset Specification](#asset-specification)
424
- - `origin`: The origin or blockchain address for the deposit. See [Origin](#origin)
424
+ - `source`: The source or blockchain address for the deposit. See [Origin](#origin)
425
425
  - `destination`: The destination or blockchain address for the deposit. See [Destination](#destination)
426
426
  - `amountDecimal`: Optional amount to deposit in decimal format. See [Transaction Amount](#transaction-amount)
427
427
  - `transactionId`: Optional transactionId of a Notabene transaction. Will be returned with the payload to assist updating the Transaction
@@ -480,7 +480,6 @@ The `asset` field the following types of assets specified:
480
480
 
481
481
  - `notabene_asset` code passed as a`string`. See [Notabene Assets Service](https://devx.notabene.id/docs/coins-decimals#assets-service-api).
482
482
  - [CAIP-19](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-19.md_) is a chain agnostic format allows you to support the widest amount of assets and blockchains including NFTs.
483
- - [DTI](https://www.iso.org/standard/80601.html) is the ISO Digital Token Identifier format. See [DTI registry](https://dtif.org/registry-search/) for supported tokens.
484
483
 
485
484
  ### Transaction amount
486
485
 
@@ -497,9 +496,9 @@ Specify the beneficiary address as `destination` using one of the following form
497
496
  - [BIP-21](https://en.bitcoin.it/wiki/BIP_0021) Bitcoin URI
498
497
  - Native blockchain address
499
498
 
500
- ### Origin
499
+ ### Source
501
500
 
502
- Specify the originator address as `origin` using one of the following formats:
501
+ Specify the originator address as `source` using one of the following formats:
503
502
 
504
503
  - [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
505
504
  - [EIP-3770](https://eips.ethereum.org/EIPS/eip-3770) EVM URI
@@ -575,16 +574,16 @@ const options: TransactionOptions = {
575
574
  nationalIdentification: false,
576
575
  countryOfRegistration: true,
577
576
  },
578
- vasps: {
579
- addUnknown: true, // Allow users to add a missing VASP - Defaults to false
580
- onlyActive: true, // Only list active VASPs - Default false
581
- searchable: [
582
- VASPSearchControl.ALLOWED, // JS: 'allowed'
583
- VASPSearchControl.PENDING, // JS: 'pending'
584
- ], // Control searches for VASPs - Defaults to undefined
585
- },
586
577
  hide: [ValidationSections.ASSET, ValidationSections.DESTINATION], // Don't show specific sections of component
587
578
  },
579
+ vasps: {
580
+ addUnknown: true, // Allow users to add a missing VASP - Defaults to false
581
+ onlyActive: true, // Only list active VASPs - Default false
582
+ searchable: [
583
+ VASPSearchControl.ALLOWED, // JS: 'allowed'
584
+ VASPSearchControl.PENDING, // JS: 'pending'
585
+ ], // Control searches for VASPs - Defaults to undefined
586
+ },
588
587
  };
589
588
  const withdrawal = notabene.createWithdrawalAssist(tx, options);
590
589
  ```
@@ -430,12 +430,8 @@ export declare interface Counterparty {
430
430
  *
431
431
  * @public
432
432
  */
433
- export declare type CounterpartyAssistConfig = {
434
- enabled?: boolean;
435
- } | {
436
- [key in PersonType]: {
437
- enabled?: boolean;
438
- };
433
+ export declare type CounterpartyAssistConfig = boolean | {
434
+ counterpartyTypes: PersonType[];
439
435
  };
440
436
 
441
437
  /**
@@ -1556,7 +1552,7 @@ export declare interface TransactionOptions {
1556
1552
  fields?: FieldTypes;
1557
1553
  vasps?: VASPOptions;
1558
1554
  hide?: ValidationSections[];
1559
- counterpartyAssistConfig?: CounterpartyAssistConfig;
1555
+ counterpartyAssist?: CounterpartyAssistConfig;
1560
1556
  }
1561
1557
 
1562
1558
  /**
@@ -10,7 +10,7 @@
10
10
  "author": "Notabene <developers@notabene.id>",
11
11
  "license": "MIT",
12
12
  "packageManager": "yarn@4.5.1",
13
- "version": "2.9.0",
13
+ "version": "2.9.1-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
@@ -430,12 +430,8 @@ export declare interface Counterparty {
430
430
  *
431
431
  * @public
432
432
  */
433
- export declare type CounterpartyAssistConfig = {
434
- enabled?: boolean;
435
- } | {
436
- [key in PersonType]: {
437
- enabled?: boolean;
438
- };
433
+ export declare type CounterpartyAssistConfig = boolean | {
434
+ counterpartyTypes: PersonType[];
439
435
  };
440
436
 
441
437
  /**
@@ -1556,7 +1552,7 @@ export declare interface TransactionOptions {
1556
1552
  fields?: FieldTypes;
1557
1553
  vasps?: VASPOptions;
1558
1554
  hide?: ValidationSections[];
1559
- counterpartyAssistConfig?: CounterpartyAssistConfig;
1555
+ counterpartyAssist?: CounterpartyAssistConfig;
1560
1556
  }
1561
1557
 
1562
1558
  /**
@@ -10,7 +10,7 @@
10
10
  "author": "Notabene <developers@notabene.id>",
11
11
  "license": "MIT",
12
12
  "packageManager": "yarn@4.5.1",
13
- "version": "2.9.0",
13
+ "version": "2.9.1-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
@@ -430,12 +430,8 @@ export declare interface Counterparty {
430
430
  *
431
431
  * @public
432
432
  */
433
- export declare type CounterpartyAssistConfig = {
434
- enabled?: boolean;
435
- } | {
436
- [key in PersonType]: {
437
- enabled?: boolean;
438
- };
433
+ export declare type CounterpartyAssistConfig = boolean | {
434
+ counterpartyTypes: PersonType[];
439
435
  };
440
436
 
441
437
  /**
@@ -1556,7 +1552,7 @@ export declare interface TransactionOptions {
1556
1552
  fields?: FieldTypes;
1557
1553
  vasps?: VASPOptions;
1558
1554
  hide?: ValidationSections[];
1559
- counterpartyAssistConfig?: CounterpartyAssistConfig;
1555
+ counterpartyAssist?: CounterpartyAssistConfig;
1560
1556
  }
1561
1557
 
1562
1558
  /**
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "author": "Notabene <developers@notabene.id>",
11
11
  "license": "MIT",
12
12
  "packageManager": "yarn@4.5.1",
13
- "version": "2.9.0",
13
+ "version": "2.9.1-next.1",
14
14
  "source": "src/notabene.ts",
15
15
  "main": "dist/cjs/notabene.cjs",
16
16
  "module": "dist/esm/notabene.js",
package/src/types.ts CHANGED
@@ -802,13 +802,9 @@ export type VASPOptions = {
802
802
  * @public
803
803
  */
804
804
  export type CounterpartyAssistConfig =
805
+ | boolean
805
806
  | {
806
- enabled?: boolean;
807
- }
808
- | {
809
- [key in PersonType]: {
810
- enabled?: boolean;
811
- };
807
+ counterpartyTypes: PersonType[];
812
808
  };
813
809
 
814
810
  /**
@@ -859,7 +855,7 @@ export interface TransactionOptions {
859
855
  fields?: FieldTypes;
860
856
  vasps?: VASPOptions;
861
857
  hide?: ValidationSections[]; // You can hide a specific section of the component by listing it here
862
- counterpartyAssistConfig?: CounterpartyAssistConfig;
858
+ counterpartyAssist?: CounterpartyAssistConfig;
863
859
  }
864
860
  /**
865
861
  * Component Message Type enum representing different message types that can be sent