@depay/widgets 7.14.2 → 7.15.0

package/README.md

@@ -3,7 +3,7 @@
 You can either load the `@depay/widgets` package via CDN:
 
 ```
-<script src="https://integrate.depay.fi/widgets/v7.js"></script>
+<script defer async src="https://integrate.depay.com/widgets/v7.js"></script>
 ```
 
 or you install `@depay/widgets` via the package manager of your choice and ship it as part of your application bundle:
@@ -24,7 +24,7 @@ import DePayWidgets from '@depay/widgets'
 
 ## Demo
 
-To easily configure DePay Payment Widgets please use our configurator here: https://app.depay.fi/integrations/new
+To easily configure DePay Payment Widgets please use our configurator here: https://app.depay.com/integrations/new
 
 For a more low-key technical example/demo page have a look at: https://depayfi.github.io/widgets/dev.bundle.html
 
@@ -74,7 +74,7 @@ In order to receive decentralized payments on any blockchain you need to have yo
 ### Quick start (DePay Payments)
 
 ```
-<script src="https://integrate.depay.fi/widgets/v7.js"/>
+<script defer async src="https://integrate.depay.com/widgets/v7.js"/>
 ```
 
 ```
@@ -144,7 +144,7 @@ Currently supported:
 
 The address of the token you want to receive.
 
-Use our [payment configurator](https://depay.fi/documentation/payments#payment-configurator) in order to simplify configuring this.
+Use our [payment configurator](https://depay.com/documentation/payments#payment-configurator) in order to simplify configuring this.
 
 `amount` (Optional)
 
@@ -341,12 +341,12 @@ DePayWidgets.Payment({
 
 In case you pass a tracking method it needs to return a promise.
 
-Your endpoint needs to make sure to forward this to the [payment tracking api](https://depay.fi/documentation/api#payments).
+Your endpoint needs to make sure to forward this to the [payment tracking api](https://depay.com/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.
+Make sure you read the [Payment Tracking API](https://depay.com/documentation/api#payments) for further details on how to integrate payment tracking.
 
 Payment tracking requests will be attempted up to 3 times by the widget and will display "Payment tracking failed!" to the user if the widget was not able to start payment tracking via the given endpoint after 3 attempts.
 
@@ -818,7 +818,7 @@ In order to sell tokens in a decentralized way, that token needs to have a liqui
 ### Quick start (DePay Sales)
 
 ```
-<script src="https://integrate.depay.fi/widgets/v7.js"/>
+<script defer async src="https://integrate.depay.com/widgets/v7.js"/>
 ```
 
 ```javascript
@@ -867,7 +867,7 @@ Currently supported blockchains:
 
 The address of the token you want to sell.
 
-Use our [sale configurator](https://depay.fi/documentation/sales#sale-configurator) in order to simplify configuring this.
+Use our [sale configurator](https://depay.com/documentation/sales#sale-configurator) in order to simplify configuring this.
 
 #### amount (DePay Sales)
 
@@ -1076,7 +1076,7 @@ Allows to set the token image used in the widget to represent the purchased toke
 ```javascript
 DePayWidgets.Sale({
   
-  tokenImage: 'https://depay.fi/favicon.png'
+  tokenImage: 'https://depay.com/favicon.png'
 
 });
 ```
@@ -1216,7 +1216,7 @@ In order to receive decentralized donation payments on any blockchain you need t
 ### Quick start (DePay Donations)
 
 ```
-<script src="https://integrate.depay.fi/widgets/v7.js"/>
+<script defer async src="https://integrate.depay.com/widgets/v7.js"/>
 ```
 
 ```javascript
@@ -1274,7 +1274,7 @@ Currently supported:
 
 The address of the token you want to receive.
 
-Use our [donation configurator](https://depay.fi/documentation/donations#donation-configurator) in order to simplify configuring this.
+Use our [donation configurator](https://depay.com/documentation/donations#donation-configurator) in order to simplify configuring this.
 
 `receiver`
 
@@ -1467,6 +1467,32 @@ DePayWidgets.Donation({
 });
 ```
 
+#### whitelist (DePay Donations)
+
+Allows only the configured tokens to be eligible as means of payment (from the sender):
+
+```javacript
+DePayWidgets.Donation({
+  
+  whitelist: {
+    ethereum: [
+      '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE', // ETH
+      '0xdac17f958d2ee523a2206206994597c13d831ec7', // USDT
+      '0x6b175474e89094c44da98b954eedeac495271d0f'  // DAI
+    ],
+    bsc: [
+      '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE', // BNB
+      '0xe9e7cea3dedca5984780bafc599bd69add087d56', // BUSD
+      '0x55d398326f99059ff775485246999027b3197955'  // BSC-USD
+    ],
+    polygon: [
+      '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE', // MATIC
+      '0x2791bca1f2de4661ed88a30c99a7a9449aa84174', // USDC
+    ]
+  }
+})
+```
+
 #### blacklist (DePay Donations)
 
 Allows to blacklist tokens so that they will not be suggested as means of payment (from the sender):
@@ -1642,7 +1668,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/v7.js"/>
+<script defer async src="https://integrate.depay.com/widgets/v7.js"/>
 ```
 
 ```javascript
@@ -1670,7 +1696,7 @@ DePay Login allows you to perform web3 wallet logins with ease.
 Returns `account` if succesfully signed and recovered log in message.
 
 ```
-<script src="https://integrate.depay.fi/widgets/v7.js"/>
+<script defer async src="https://integrate.depay.com/widgets/v7.js"/>
 ```
 
 ```javascript
@@ -1747,7 +1773,7 @@ DePay Select widget allows you to open a dialog that allows you to select things
 Resolves with what has been selected by the user:
 
 ```
-<script src="https://integrate.depay.fi/widgets/v7.js"/>
+<script defer async src="https://integrate.depay.com/widgets/v7.js"/>
 ```
 
 ```javascript
@@ -1764,6 +1790,44 @@ let token = await DePayWidgets.Select({ what: 'token' })
 // }
 ```
 
+## Examples
+
+### React
+
+#### DePay Payments
+
+```javascript
+
+import React from 'react'
+import DePayWidgets from '@depay/widgets'
+
+export default (props)=>{
+
+  let unmount
+
+  const openPaymentWidget = ()=>{
+    (
+      { unmount } = DePayWidgets.Payment({...})
+    )
+  }
+
+  useEffect(() => {
+    return ()=>{
+      // make sure an open widgets gets closed/unmounted as part of this component
+      if(unmount) { unmount() }
+    }
+  }, [])
+
+  return(
+    <button onClick={ openPaymentWidget } type="button">
+      Pay
+    </button>
+  )
+}
+
+```
+
+
 ## Development
 
 ### Quick start
@@ -1796,3 +1860,36 @@ npm login
 npm publish
 ```
 
+## Web3 Payments
+
+The future is [Web3 Payments](https://depay.com/web3-payments).
+
+Blockchains hold the potential to faster, simpler and smarter payments.
+
+Web3 Payments are borderless, peer-to-peer, and support multiple tokens and blockchains.
+
+Accept any asset type that your customers already have in their wallet. [DePay](https://depay.com) is blockchain agnostic and can at any time be extended on any blockchain-specific plugin. Interoperability, scalability & flexibility are the cornerstones of our protocol. Accepting any asset that users already have in their wallets no matter which blockchain these are held on, reduces friction when performing decentralized payments.
+
+### Chain Agnostic (Multichain)
+
+Interoperability is the key principle on which our infrastructure is built. [DePay](https://depay.com) is extensible around any blockchain, ensuring a competitive cross-chain future.
+
+### Permissionless
+
+Interoperability is the key principle on which our infrastructure is built. [DePay](https://depay.com) is extensible around any blockchain, ensuring a competitive cross-chain future.
+
+### Trustless
+
+Most Web3 Payment providers & processors receive payments to wallets that they manage themselves. Only in a further intermediate step are the payments paid out to sellers. [DePay](https://depay.com) does not act as an intermediary. Every intermediate step is replaced by smart contracts which are connected to decentralized liquidity pools. As a result, trust is no longer required.
+
+### Easy to use
+
+Our ambition was to create an even easier user experience than you're used to from shopping in current non-crypto e-commerce stores. We think we've done a good job of that.
+
+### Open Source
+
+Feel free to use & contribute to our codebase at. We're happy to have you look under our hood. The [DePay](https://depay.com) protocol will always remain open source.
+
+### Multichain
+
+[DePay](https://depay.com) calculates payment routes on multiple blockchains simultaneously despite what your wallet is currently connected to. Our software automatically detects & switches the network if required.