@depay/widgets 4.3.0 → 5.0.1

package/README.md

@@ -3,7 +3,7 @@
 You can either load the `@depay/widgets` package via CDN:
 
 ```
-<script src="https://integrate.depay.fi/widgets/v3.js"></script>
+<script src="https://integrate.depay.fi/widgets/v5.js"></script>
 ```
 
 or you install `@depay/widgets` via the package manager of your choice and ship it as part of your application bundle:
@@ -58,7 +58,7 @@ In order to receive decentralized payments on any blockchain you need to have yo
 ### Quick start
 
 ```
-<script src="https://integrate.depay.fi/widgets/v3.js"/>
+<script src="https://integrate.depay.fi/widgets/v5.js"/>
 ```
 
 ```
@@ -174,6 +174,42 @@ DePayWidgets.Payment({
 
 Checkout [DePay Web3 Payments](https://github.com/DePayFi/depay-web3-payments#pay-into-smart-contracts) and [DePay Router Smart Contract](https://github.com/DePayFi/depay-evm-router) for more details.
 
+#### track
+
+`track`
+
+Allows to track payment confirmation via DePay to enable integration into web applications.
+
+```javascript
+DePayWidgets.Payment({
+
+  track: {
+    endpoint: '/track/payments' // your endpoint to forward the payment tracking to the payments api
+  }
+})
+```
+
+Once the payment has been submitted by the widget, it will call the configured endpoint with:
+
+```
+POST /track/payments
+BODY:
+  {
+    "blockchain": "ethereum",
+    "transaction": "0x4311a9820195c2a5af99c45c72c88848ed403a4020863c913feed81d15855ae4",
+    "sender": "0x769794c94e9f113e357023dab73e81dbd6db201c",
+    "nonce": 103,
+    "after_block": 13230369
+  }
+```
+
+Your endpoint needs to make sure to forward this to the [payment tracking api](https://depay.fi/documentation/api#payments).
+
+Also make sure to add `token`, `amount` and `confirmations` when forwarding the request to the payments api.
+Those values are supposed to be set by your backend not the widget nor the fronted because any user could set these values to their liking otherwise, having you confirm payment amounts and tokens that you didn't intend to receive!
+
+Make sure you read the [Payment Tracking API](https://depay.fi/documentation/api#payments) for further details on how to integrate payment tracking.
+
 #### connected
 
 `connected`
@@ -242,23 +278,6 @@ DePayWidgets.Payment({
 })
 ```
 
-#### ensured
-
-`ensured`
-
-A function that will be called once the payment has been confirmed enough times to consider it's "ensured" (e.g. 12 confirmations on Ethereum).
-
-The widget will call this function passing a transaction as single argument (see: [depay-web3-wallets](https://github.com/depayfi/depay-web3-wallets#transaction) for more details)
-
-```javascript
-DePayWidgets.Payment({
-
-  ensured: (transaction)=> {
-    // called when payment transaction has been confirmed X times by the network
-  }
-})
-```
-
 #### failed
 
 `failed`
@@ -520,7 +539,7 @@ In order to sell tokens in a decentralized way, that token needs to have a liqui
 ### Quick start
 
 ```
-<script src="https://integrate.depay.fi/widgets/v3.js"/>
+<script src="https://integrate.depay.fi/widgets/v5.js"/>
 ```
 
 ```javascript
@@ -648,23 +667,6 @@ DePayWidgets.Sale({
 });
 ```
 
-#### ensured
-
-`ensured`
-
-A function that will be called once the payment has been confirmed enough times to consider it's "ensured" (e.g. 12 confirmations on Ethereum).
-
-The widget will call this function passing a transaction as single argument (see: [depay-web3-wallets](https://github.com/depayfi/depay-web3-wallets#transaction) for more details)
-
-```javascript
-DePayWidgets.Sale({
-
-  ensured: (transaction)=> {
-    // called when payment transaction has been confirmed X times by the network
-  }
-});
-```
-
 #### failed
 
 `failed`
@@ -899,7 +901,7 @@ In order to receive decentralized donation payments on any blockchain you need t
 ### Quick start
 
 ```
-<script src="https://integrate.depay.fi/widgets/v3.js"/>
+<script src="https://integrate.depay.fi/widgets/v5.js"/>
 ```
 
 ```javascript
@@ -1040,23 +1042,6 @@ DePayWidgets.Donation({
 });
 ```
 
-#### ensured
-
-`ensured`
-
-A function that will be called once the payment has been confirmed enough times to consider it's "ensured" (e.g. 12 confirmations on Ethereum).
-
-The widget will call this function passing a transaction as single argument (see: [depay-web3-wallets](https://github.com/depayfi/depay-web3-wallets#transaction) for more details)
-
-```javascript
-DePayWidgets.Donation({
-
-  ensured: (transaction)=> {
-    // called when payment transaction has been confirmed X times by the network
-  }
-});
-```
-
 #### failed
 
 `failed`
@@ -1270,7 +1255,7 @@ DePay Connect allows you to have your users connect their crypto wallet to your
 Returns connected `account`, `accounts` and `wallet` in return. 
 
 ```
-<script src="https://integrate.depay.fi/widgets/v3.js"/>
+<script src="https://integrate.depay.fi/widgets/v5.js"/>
 ```
 
 ```javascript
@@ -1313,7 +1298,7 @@ test:cypress:debug
 Test and debug single cypress file:
 
 ```
-yarn test:cypress:debug --spec "cypress/integration/Donation/overview.js"
+yarn test:cypress:debug --spec "cypress/integration/Payment/approve.js"
 ```
 
 ### Release new versions to npm