npm - @depay/widgets - Versions diffs - 7.14.3 → 7.15.1 - Mend

@depay/widgets 7.14.3 → 7.15.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.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -3,7 +3,7 @@
 You can either load the `@depay/widgets` package via CDN:
 ```
-<script defer async 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,9 +24,13 @@ 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:
-For a more low-key technical example/demo page have a look at: https://depayfi.github.io/widgets/dev.bundle.html
+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
 ## Support
@@ -43,7 +47,7 @@ DePay supports the most popular crypto wallets:
 - [MetaMask](https://metamask.io)
 - [Coinbase Wallet](https://wallet.coinbase.com)
-100+ different wallets via [WalletConnect](https://walletconnect.org), such as:
+100+ additional wallets via [WalletConnect](https://walletconnect.org), such as:
 - [Trust Wallet](https://trustwallet.com)
 - [DeFi Wallet by crypto.com](https://crypto.com/defi-wallet)
 - [1inch Wallet](https://1inch.io/wallet/)
@@ -63,7 +67,7 @@ DePay supports the most popular crypto wallets:
 DePay Payments allows you to accept and perform crypto payments.
-### Preparation (DePay Payments)
+### Preparation
 In order to receive decentralized payments on any blockchain you need to have your own wallet on that particular blockchain first:
@@ -71,11 +75,7 @@ In order to receive decentralized payments on any blockchain you need to have yo
 - [Create an BSC wallet](https://academy.binance.com/en/articles/how-to-get-started-with-binance-smart-chain-bsc)
 - [Create a Polygon wallet](https://wallet.polygon.technology/)
-### Quick start (DePay Payments)
-```
-<script defer async src="https://integrate.depay.fi/widgets/v7.js"/>
-```
+### Quick start
 ```
 DePayWidgets.Payment({
@@ -88,7 +88,7 @@ DePayWidgets.Payment({
 });
 ```
-### Configuration (DePay Payments)
+### Configuration
 You need to pass a configuration object to `DePayWidgets.Payment` which needs to at least contain the `accept` field:
@@ -128,7 +128,7 @@ DePayWidgets.Payment({
 });
 ```
-#### accept (DePay Payments)
+#### accept
 `blockchain`
@@ -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)
@@ -159,7 +159,7 @@ If you do not pass an amount, the user will be able to select an amount within t
 The address receiving the payment. Always double check that you've set the right address.
-#### amount (DePay Payments)
+#### amount
 ##### fixed currency amounts
@@ -193,7 +193,7 @@ alongside values for `start`, `min` and `step`.
 `step`: The number by wich to increment/decremten changes to the amount.
-#### receiver (DePay Payments)
+#### receiver
 Payment receivers can either be wallet addresses, but also smart contracts.
@@ -219,7 +219,7 @@ 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.
-#### fee (DePay Payments)
+#### fee
 You can configure a fee which will be applied to every payment with it's own dedicated fee receiver address.
@@ -239,7 +239,7 @@ DePayWidgets.Payment({
 });
 ```
-#### fromToken, fromAmount + toToken (DePay Payments)
+#### fromToken, fromAmount + toToken
 In case where you want to configure payments based on the source token + amount, rather than target token and amount, you can pass `fromToken`, `fromAmount` and `toToken` to `accept`.
@@ -259,7 +259,7 @@ DePayWidgets.Payment({
 // This will open a payment widget to send 0.1 BUSD to the receiver, converting it to BNB along the way.
 ```
-#### preload (DePay Payments)
+#### preload
 To optimize initialization speed of the Payment Widget you can preload payment routes as soon as you become aware of the users wallet address.
@@ -286,7 +286,7 @@ DePayWidgets.Payment.preload({
 });
 ```
-#### track (DePay Payments)
+#### track
 `track`
@@ -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.
@@ -390,7 +390,7 @@ In case you want to redirect the user to the next step in your system the poll e
 It is not enough to rely on setting `forward_to` initially with the tracking request, you will also need to respond with `forward_to` when implementing polling
 as the entire reason for polling is to cover cases where websockets fail and the initial `forward_to` can not be communicated to the client.
-#### connected (DePay Payments)
+#### connected
 `connected`
@@ -408,7 +408,7 @@ DePayWidgets.Payment({
 ```
-#### closed (DePay Payments)
+#### closed
 `closed`
@@ -424,7 +424,7 @@ DePayWidgets.Payment({
 ```
-#### before (DePay Payments)
+#### before
 `before`
@@ -442,7 +442,7 @@ DePayWidgets.Payment({
 })
 ```
-#### sent (DePay Payments)
+#### sent
 `sent`
@@ -459,7 +459,7 @@ DePayWidgets.Payment({
 })
 ```
-#### confirmed (DePay Payments)
+#### confirmed
 `confirmed`
@@ -476,7 +476,7 @@ DePayWidgets.Payment({
 })
 ```
-#### validated (DePay Payments)
+#### validated
 `validated`
@@ -491,7 +491,7 @@ DePayWidgets.Payment({
 })
 ```
-#### failed (DePay Payments)
+#### failed
 `failed`
@@ -509,7 +509,7 @@ DePayWidgets.Payment({
 })
 ```
-#### critical (DePay Payments)
+#### critical
 `critical`
@@ -524,7 +524,7 @@ DePayWidgets.Payment({
 })
 ```
-#### error (DePay Payments)
+#### error
 `error`
@@ -540,7 +540,7 @@ DePayWidgets.Payment({
 })
 ```
-#### providers (DePay Payments)
+#### providers
 Allows to set providers to be used for making RPC calls to the individiual blockchains:
@@ -555,7 +555,7 @@ DePayWidgets.Payment({
 })
 ```
-#### currency (DePay Payments)
+#### currency
 Allows you to enforce displayed local currency (instead of automatically detecting it):
@@ -569,7 +569,7 @@ DePayWidgets.Payment({
 ```
-#### whitelist (DePay Payments)
+#### whitelist
 Allows only the configured tokens to be eligible as means of payment (from the sender):
@@ -597,7 +597,7 @@ DePayWidgets.Payment({
 ```
-#### blacklist (DePay Payments)
+#### blacklist
 Allows to blacklist tokens so that they will not be suggested as means of payment (from the sender):
@@ -632,7 +632,7 @@ DePayWidgets.Payment({
 })
 ```
-#### event (DePay Payments)
+#### event
 `event`
@@ -648,7 +648,7 @@ DePayWidgets.Payment({
 })
 ```
-#### container (DePay Payments)
+#### container
 `container`
@@ -660,7 +660,7 @@ DePayWidgets.Payment({
 })
 ```
-#### style (DePay Payments)
+#### style
 `style`
@@ -687,7 +687,7 @@ DePayWidgets.Payment({
 })
 ```
-##### colors (DePay Payments)
+##### colors
 `colors`
@@ -707,7 +707,7 @@ DePayWidgets.Payment({
 })
 ```
-##### fontFamily (DePay Payments)
+##### fontFamily
 `fontFamily`
@@ -722,7 +722,7 @@ DePayWidgets.Payment({
 })
 ```
-##### css (DePay Payments)
+##### css
 `css`
@@ -743,7 +743,7 @@ DePayWidgets.Payment({
 })
 ```
-#### unmount (DePay Payments)
+#### unmount
 `unmount`
@@ -755,7 +755,7 @@ let { unmount } = await DePayWidgets.Payment({})
 unmount()
 ```
-#### recover (DePay Payments)
+#### recover
 `recover`
@@ -778,7 +778,7 @@ A recovered payment still results in a confirmed or failed payment, and also cal
 ```
-#### closable (DePay Payments)
+#### closable
 `closable`
@@ -791,7 +791,7 @@ DePayWidgets.Payment({
 ```
-#### integration (DePay Payments)
+#### integration
 `integration`
@@ -807,7 +807,7 @@ DePayWidgets.Payment({
 DePay Sales allows you to sell tokens directly from your website or dApp with automatic any-to-any payment conversion (so people can use any token when buying your token directly off your website or dApp).
-### Preparation (DePay Sales)
+### Preparation
 In order to sell tokens in a decentralized way, that token needs to have a liquidity pool on a decentralized exchange:
@@ -815,11 +815,7 @@ In order to sell tokens in a decentralized way, that token needs to have a liqui
 - [Create Uniswap v2 Liquidity Pool (Polygon)](https://app.uniswap.org/#/add/v2/ETH?chain=polygon)
 - [Create Pancakeswap Liquidity Pool](https://pancakeswap.finance/add)
-### Quick start (DePay Sales)
-```
-<script defer async src="https://integrate.depay.fi/widgets/v7.js"/>
-```
+### Quick start
 ```javascript
 DePayWidgets.Sale({
@@ -829,7 +825,7 @@ DePayWidgets.Sale({
 });
 ```
-### Configuration (DePay Sales)
+### Configuration
 You need to pass a configuration object to `DePayWidgets.Sale` which needs to at least contain the `sell` field:
@@ -852,7 +848,7 @@ DePayWidgets.Sale({
 });
 ```
-#### sell (DePay Sales)
+#### sell
 `"blockchain": "token"`
@@ -867,9 +863,9 @@ 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)
+#### amount
 When you want to control how the amount selection behaves, pass the `amount` configuration object,
 alongside values for `start`, `min` and `step`.
@@ -891,7 +887,7 @@ DePayWidgets.Sale({
 });
 ```
-#### connected (DePay Sales)
+#### connected
 `connected`
@@ -908,7 +904,7 @@ DePayWidgets.Sale({
 });
 ```
-#### closed (DePay Sales)
+#### closed
 `closed`
@@ -923,7 +919,7 @@ DePayWidgets.Sale({
 });
 ```
-#### sent (DePay Sales)
+#### sent
 `sent`
@@ -940,7 +936,7 @@ DePayWidgets.Sale({
 });
 ```
-#### confirmed (DePay Sales)
+#### confirmed
 `confirmed`
@@ -957,7 +953,7 @@ DePayWidgets.Sale({
 });
 ```
-#### failed (DePay Sales)
+#### failed
 `failed`
@@ -975,7 +971,7 @@ DePayWidgets.Sale({
 });
 ```
-#### critical (DePay Sales)
+#### critical
 `critical`
@@ -990,7 +986,7 @@ DePayWidgets.Sale({
 });
 ```
-#### error (DePay Sales)
+#### error
 `error`
@@ -1006,7 +1002,7 @@ DePayWidgets.Sale({
 });
 ```
-#### providers (DePay Sales)
+#### providers
 Allows to set providers to be used for making RPC calls to the individiual blockchains:
@@ -1020,7 +1016,7 @@ DePayWidgets.Sale({
 });
 ```
-#### currency (DePay Sales)
+#### currency
 Allows you to enforce displayed local currency (instead of automatically detecting it):
@@ -1032,7 +1028,7 @@ DePayWidgets.Sale({
 });
 ```
-#### blacklist (DePay Sales)
+#### blacklist
 Allows to blacklist tokens so that they will not be suggested as means of payment (from the sender):
@@ -1067,7 +1063,7 @@ DePayWidgets.Sale({
 });
 ```
-#### tokenImage (DePay Sales)
+#### tokenImage
 `tokenImage`
@@ -1076,12 +1072,12 @@ 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'
 });
 ```
-#### style (DePay Sales)
+#### style
 `style`
@@ -1109,7 +1105,7 @@ DePayWidgets.Sale({
 });
 ```
-##### colors (DePay Sales)
+##### colors
 `colors`
@@ -1129,7 +1125,7 @@ DePayWidgets.Sale({
 });
 ```
-##### fontFamily (DePay Sales)
+##### fontFamily
 `fontFamily`
@@ -1144,7 +1140,7 @@ DePayWidgets.Sale({
 });
 ```
-##### css (DePay Sales)
+##### css
 `css`
@@ -1165,7 +1161,7 @@ DePayWidgets.Sale({
 });
 ```
-#### unmount (DePay Sales)
+#### unmount
 `unmount`
@@ -1177,7 +1173,7 @@ let { unmount } = await DePayWidgets.Sale({})
 unmount()
 ```
-#### closable (DePay Sales)
+#### closable
 `closable`
@@ -1190,7 +1186,7 @@ DePayWidgets.Sale({
 ```
-#### integration (DePay Sales)
+#### integration
 `integration`
@@ -1206,18 +1202,14 @@ DePayWidgets.Sale({
 DePay Donations allows you to accept donation payments made with thousands of different crypto currencies.
-### Preparation (DePay Donations)
+### Preparation
 In order to receive decentralized donation payments on any blockchain you need to have your own wallet on that particular blockchain first:
 - [Create an Ethereum wallet](https://ethereum.org/en/wallets/)
 - [Create an BSC wallet](https://academy.binance.com/en/articles/how-to-get-started-with-binance-smart-chain-bsc)
-### Quick start (DePay Donations)
-```
-<script defer async src="https://integrate.depay.fi/widgets/v7.js"/>
-```
+### Quick start
 ```javascript
 DePayWidgets.Donation({
@@ -1229,7 +1221,7 @@ DePayWidgets.Donation({
 });
 ```
-### Configuration (DePay Donations)
+### Configuration
 You need to pass a configuration object to `DePayWidgets.Donation` which needs to at least contain the `accept` field:
@@ -1259,7 +1251,7 @@ DePayWidgets.Donation({
 });
 ```
-#### accept (DePay Donations)
+#### accept
 `blockchain`
@@ -1274,13 +1266,13 @@ 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`
 The address receiving the donation. Always double check that you've set the right address.
-#### amount (DePay Donations)
+#### amount
 When you want to control how the amount selection behaves, pass the `amount` configuration object,
 alongside values for `start`, `min` and `step`.
@@ -1291,7 +1283,7 @@ alongside values for `start`, `min` and `step`.
 `step`: The number by wich to increment/decremten changes to the amount.
-#### connected (DePay Donations)
+#### connected
 `connected`
@@ -1308,7 +1300,7 @@ DePayWidgets.Donation({
 });
 ```
-#### fee (DePay Donations)
+#### fee
 You can configure a fee which will be applied to every payment with it's own dedicated fee receiver address.
@@ -1328,7 +1320,7 @@ DePayWidgets.Donation({
 });
 ```
-#### closed (DePay Donations)
+#### closed
 `closed`
@@ -1343,7 +1335,7 @@ DePayWidgets.Donation({
 });
 ```
-#### sent (DePay Donations)
+#### sent
 `sent`
@@ -1360,7 +1352,7 @@ DePayWidgets.Donation({
 });
 ```
-#### confirmed (DePay Donations)
+#### confirmed
 `confirmed`
@@ -1377,7 +1369,7 @@ DePayWidgets.Donation({
 });
 ```
-#### validated (DePay Donations)
+#### validated
 `validated`
@@ -1392,7 +1384,7 @@ DePayWidgets.Payment({
 })
 ```
-#### failed (DePay Donations)
+#### failed
 `failed`
@@ -1410,7 +1402,7 @@ DePayWidgets.Donation({
 });
 ```
-#### critical (DePay Donations)
+#### critical
 `critical`
@@ -1425,7 +1417,7 @@ DePayWidgets.Donation({
 });
 ```
-#### error (DePay Donations)
+#### error
 `error`
@@ -1441,7 +1433,7 @@ DePayWidgets.Donation({
 });
 ```
-#### providers (DePay Donations)
+#### providers
 Allows to set providers to be used for making RPC calls to the individiual blockchains:
@@ -1455,7 +1447,7 @@ DePayWidgets.Donation({
 });
 ```
-#### currency (DePay Donations)
+#### currency
 Allows you to enforce displayed local currency (instead of automatically detecting it):
@@ -1467,7 +1459,33 @@ DePayWidgets.Donation({
 });
 ```
-#### blacklist (DePay Donations)
+#### whitelist
+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
 Allows to blacklist tokens so that they will not be suggested as means of payment (from the sender):
@@ -1502,7 +1520,7 @@ DePayWidgets.Donation({
 })
 ```
-#### container (DePay Donations)
+#### container
 `container`
@@ -1514,7 +1532,7 @@ DePayWidgets.Dontaion({
 })
 ```
-#### style (DePay Donations)
+#### style
 `style`
@@ -1542,7 +1560,7 @@ DePayWidgets.Donation({
 });
 ```
-##### colors (DePay Donations)
+##### colors
 `colors`
@@ -1562,7 +1580,7 @@ DePayWidgets.Donation({
 });
 ```
-##### fontFamily (DePay Donations)
+##### fontFamily
 `fontFamily`
@@ -1577,7 +1595,7 @@ DePayWidgets.Donation({
 });
 ```
-##### css (DePay Donations)
+##### css
 `css`
@@ -1598,7 +1616,7 @@ DePayWidgets.Donation({
 });
 ```
-#### unmount (DePay Donations)
+#### unmount
 `unmount`
@@ -1610,7 +1628,7 @@ let { unmount } = await DePayWidgets.Donation({})
 unmount()
 ```
-#### closable (DePay Donations)
+#### closable
 `closable`
@@ -1623,7 +1641,7 @@ DePayWidgets.Donation({
 ```
-#### integration (DePay Donations)
+#### integration
 `integration`
@@ -1635,23 +1653,19 @@ DePayWidgets.Donation({
 })
 ```
-## DePay Connect (DePay Donations)
+## DePay Connect
 DePay Connect allows you to have your users connect their crypto wallet to your dApp or website.
 Returns connected `account`, `accounts` and `wallet` in return.
-```
-<script defer async src="https://integrate.depay.fi/widgets/v7.js"/>
-```
 ```javascript
 let { account, accounts, wallet }  = await DePayWidgets.Connect()
 ```
 See [depay-web3-wallets](https://github.com/depayfi/depay-web3-wallets) for more details about the returned `wallet`.
-### Rejections (DePay Donations)
+### Rejections
 1. Rejects if user just closes the dialog without connecting any wallet:
@@ -1669,10 +1683,6 @@ DePay Login allows you to perform web3 wallet logins with ease.
 Returns `account` if succesfully signed and recovered log in message.
-```
-<script defer async src="https://integrate.depay.fi/widgets/v7.js"/>
-```
 ```javascript
 let message = "Sign to login"
 let account = await DePayWidgets.Login({ message })
@@ -1728,7 +1738,7 @@ DePayWidgets.Login({ message, recover: ({ message, signature })=>{
 })
 ```
-### Rejections (DePay Login)
+### Rejections
 1. Rejects if user just closes the dialog without connecting any wallet:
@@ -1746,10 +1756,6 @@ 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 defer async src="https://integrate.depay.fi/widgets/v7.js"/>
-```
 ```javascript
 let token = await DePayWidgets.Select({ what: 'token' })
@@ -1834,3 +1840,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.