@notabene/javascript-sdk 1.19.0 → 1.21.0

package/README.md

@@ -20,7 +20,7 @@ This library is the JavaScript SDK for loading the widget on a frontend.
 There are two options for loading the Notabene SDK:
 
 ```bash
-<script id="notabene" async src="https://unpkg.com/@notabene/javascript-sdk@latest/dist/es/index.js"></script>
+<script id="notabene" async src="https://unpkg.com/@notabene/javascript-sdk@1.19.0/dist/es/index.js"></script>
 ```
 
 Or installing the library:
@@ -76,6 +76,23 @@ Once the widget determines the transaction is valid, it will call the `onValidSt
 const currentTransactionInfo = notabene.tx;
 ```
 
+###Supported asset formats
+
+- `USDC` the simple asset code passed as a `string`, in case different chain (polygon) -> `USDC-POLY`
+- `CAIP19` format
+  ```js
+  {
+    caip19: 'eip155:1/erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'; // for USDC
+  }
+  ```
+- `coingeckoId` and `network` format
+  ```js
+  {
+    coingeckoId: "usd-coin",
+    network: "ethereum"
+  }
+  ```
+
 ---
 
 ### Re-rendering

package/package.json

@@ -8,7 +8,7 @@
   },
   "author": "Notabene <developers@notabene.id>",
   "license": "MIT",
-  "version": "1.19.0",
+  "version": "1.21.0",
   "main": "dist/index.js",
   "packageManager": "yarn@3.2.2",
   "browserslist": "> 0.5%, last 2 versions, not dead",

package/src/types.ts

@@ -63,9 +63,16 @@ export type BeneficiaryFields = {
   beneficiaryPersonType?: PersonType;
 };
 
+export type CAIP19 = {
+  caip19: string;
+};
+
+export type CoingeckoIdAndNetwork = { coingeckoId: string; network: string };
+
+export type TransactionAsset = string | CAIP19 | CoingeckoIdAndNetwork;
 export type Transaction = OriginatorFields &
   BeneficiaryFields & {
-    transactionAsset: string;
+    transactionAsset: TransactionAsset;
     transactionAmount: string;
     transactionBlockchainInfo?: TransactionBlockchainInfo;
     isNonCustodial?: boolean;