@depay/widgets 9.2.0 → 9.2.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 +24 -24
- package/dist/esm/index.bundle.js +16 -16
- package/dist/esm/index.js +8 -4
- package/dist/umd/index.bundle.js +16 -16
- package/dist/umd/index.js +8 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
You can either load the `@depay/widgets` package via CDN:
|
|
4
4
|
|
|
5
5
|
```
|
|
6
|
-
<script defer async src="https://integrate.depay.com/widgets/
|
|
6
|
+
<script defer async src="https://integrate.depay.com/widgets/v9.js"></script>
|
|
7
7
|
```
|
|
8
8
|
|
|
9
9
|
or you install `@depay/widgets` via the package manager of your choice and ship it as part of your application bundle:
|
|
@@ -198,7 +198,7 @@ Make sure to not pass any amounts to `accept` if you use fix currency amounts.
|
|
|
198
198
|
|
|
199
199
|
The widget will still display local currency conversions to users. If you want to change this see `currency` configuration.
|
|
200
200
|
|
|
201
|
-
##### amount selection (
|
|
201
|
+
##### amount selection (changeable amounts)
|
|
202
202
|
|
|
203
203
|
When you want to control how the amount selection behaves, pass the `amount` configuration object,
|
|
204
204
|
alongside values for `start`, `min` and `step`.
|
|
@@ -207,11 +207,11 @@ alongside values for `start`, `min` and `step`.
|
|
|
207
207
|
|
|
208
208
|
`min`: The minimum amount selectable.
|
|
209
209
|
|
|
210
|
-
`step`: The number by
|
|
210
|
+
`step`: The number by which to increment/decrement changes to the amount.
|
|
211
211
|
|
|
212
212
|
#### fee
|
|
213
213
|
|
|
214
|
-
You can configure a fee which will be applied to every payment with
|
|
214
|
+
You can configure a fee which will be applied to every payment with its own dedicated fee receiver address.
|
|
215
215
|
|
|
216
216
|
The fee will be taken from the target token and target amount (after swap, depending on your `accept` configuration).
|
|
217
217
|
|
|
@@ -253,7 +253,7 @@ DePayWidgets.Payment({
|
|
|
253
253
|
|
|
254
254
|
To optimize initialization speed of the Payment Widget you can preload payment routes as soon as you become aware of the users wallet address.
|
|
255
255
|
|
|
256
|
-
Typically right after the users
|
|
256
|
+
Typically right after the users connects his wallet, or in cases the user has his wallet already connected you can preload immediately:
|
|
257
257
|
|
|
258
258
|
```javascript
|
|
259
259
|
let address = '0x4aD374e0836c26BeC213a19D3e030F8b3A8AcDE4' // e.g. retrieve it right when you perform wallet connect
|
|
@@ -382,7 +382,7 @@ Payment tracking requests will be attempted indefinitely. After 2 minutes a warn
|
|
|
382
382
|
|
|
383
383
|
##### Asynchronous Validation
|
|
384
384
|
|
|
385
|
-
For user flows where you can release the user
|
|
385
|
+
For user flows where you can release the user immediately, we recommend performing payment validation asynchronously as in certain situations it can take up to multiple minutes to validate a payment:
|
|
386
386
|
|
|
387
387
|
You can configure the widget to track/validate the payment asynchronously:
|
|
388
388
|
|
|
@@ -406,12 +406,12 @@ This allows you to release the user immediately, showing him some confirmation a
|
|
|
406
406
|
|
|
407
407
|
In order to ensure a 100% coverage that users are released and forwarded within your payment flow, you will need to implement polling in addition to tracking.
|
|
408
408
|
|
|
409
|
-
The `track.poll` configuration either takes an `enpoint` or a `method` (
|
|
409
|
+
The `track.poll` configuration either takes an `enpoint` or a `method` (similar to track itself).
|
|
410
410
|
|
|
411
411
|
It will use the endpoint or the method to request a release every 5 seconds.
|
|
412
412
|
|
|
413
413
|
You need to make sure to respond to this request with a status `404` in case the user is not to be released just yet (payment and processing on your side are not complete yet)
|
|
414
|
-
or `200` if the payment has been completed and the processing on your side is done and the user can be released and forwarded
|
|
414
|
+
or `200` if the payment has been completed and the processing on your side is done and the user can be released and forwarded within your payment flow.
|
|
415
415
|
|
|
416
416
|
In case you want to redirect the user to the next step in your system, the poll endpoint needs to respond with a body containing json like: `{ forward_to: 'https://example.com/next_step_url' }`.
|
|
417
417
|
|
|
@@ -495,7 +495,7 @@ DePayWidgets.Payment({
|
|
|
495
495
|
|
|
496
496
|
A function that will be called before the payment is handed over to the wallet.
|
|
497
497
|
|
|
498
|
-
Allows you to stop the payment if this
|
|
498
|
+
Allows you to stop the payment if this method returns false.
|
|
499
499
|
|
|
500
500
|
```javascript
|
|
501
501
|
DePayWidgets.Payment({
|
|
@@ -578,7 +578,7 @@ DePayWidgets.Payment({
|
|
|
578
578
|
|
|
579
579
|
`critical`
|
|
580
580
|
|
|
581
|
-
A function that will be called if the widget throws
|
|
581
|
+
A function that will be called if the widget throws a critical internal error that it can't handle and display on its own:
|
|
582
582
|
|
|
583
583
|
```javascript
|
|
584
584
|
DePayWidgets.Payment({
|
|
@@ -593,7 +593,7 @@ DePayWidgets.Payment({
|
|
|
593
593
|
|
|
594
594
|
`error`
|
|
595
595
|
|
|
596
|
-
A function that will be called if the widget throws
|
|
596
|
+
A function that will be called if the widget throws a non-critical internal error that it can and will handle and display on its own:
|
|
597
597
|
|
|
598
598
|
```javascript
|
|
599
599
|
DePayWidgets.Payment({
|
|
@@ -607,7 +607,7 @@ DePayWidgets.Payment({
|
|
|
607
607
|
|
|
608
608
|
#### providers
|
|
609
609
|
|
|
610
|
-
Allows to set providers to be used for making RPC calls to the
|
|
610
|
+
Allows to set providers to be used for making RPC calls to the individual blockchains:
|
|
611
611
|
|
|
612
612
|
```javascript
|
|
613
613
|
DePayWidgets.Payment({
|
|
@@ -830,7 +830,7 @@ unmount()
|
|
|
830
830
|
|
|
831
831
|
`recover`
|
|
832
832
|
|
|
833
|
-
Allows you to recover a
|
|
833
|
+
Allows you to recover a previously made payment. E.g. useful if you need to continue to show a pending payment progress if user rearrives or reloads a payment page:
|
|
834
834
|
|
|
835
835
|
```javascript
|
|
836
836
|
DePayWidgets.Payment({
|
|
@@ -945,7 +945,7 @@ alongside values for `start`, `min` and `step`.
|
|
|
945
945
|
|
|
946
946
|
`min`: The minimum amount selectable.
|
|
947
947
|
|
|
948
|
-
`step`: The number by
|
|
948
|
+
`step`: The number by which to increment/decrement changes to the amount.
|
|
949
949
|
|
|
950
950
|
`token`: Set to `true` if you want amount selection to be denominated in the token you're selling, e.g.:
|
|
951
951
|
|
|
@@ -1046,7 +1046,7 @@ DePayWidgets.Sale({
|
|
|
1046
1046
|
|
|
1047
1047
|
`critical`
|
|
1048
1048
|
|
|
1049
|
-
A function that will be called if the widget throws
|
|
1049
|
+
A function that will be called if the widget throws a critical internal error that it can't handle and display on its own:
|
|
1050
1050
|
|
|
1051
1051
|
```javascript
|
|
1052
1052
|
DePayWidgets.Sale({
|
|
@@ -1061,7 +1061,7 @@ DePayWidgets.Sale({
|
|
|
1061
1061
|
|
|
1062
1062
|
`error`
|
|
1063
1063
|
|
|
1064
|
-
A function that will be called if the widget throws
|
|
1064
|
+
A function that will be called if the widget throws a non-critical internal error that it can and will handle and display on its own:
|
|
1065
1065
|
|
|
1066
1066
|
```javascript
|
|
1067
1067
|
DePayWidgets.Sale({
|
|
@@ -1075,7 +1075,7 @@ DePayWidgets.Sale({
|
|
|
1075
1075
|
|
|
1076
1076
|
#### providers
|
|
1077
1077
|
|
|
1078
|
-
Allows to set providers to be used for making RPC calls to the
|
|
1078
|
+
Allows to set providers to be used for making RPC calls to the individual blockchains:
|
|
1079
1079
|
|
|
1080
1080
|
```javascript
|
|
1081
1081
|
DePayWidgets.Sale({
|
|
@@ -1271,7 +1271,7 @@ DePayWidgets.Sale({
|
|
|
1271
1271
|
|
|
1272
1272
|
## DePay Donations
|
|
1273
1273
|
|
|
1274
|
-
DePay Donations allows you to accept donation payments made with thousands of different
|
|
1274
|
+
DePay Donations allows you to accept donation payments made with thousands of different cryptocurrencies.
|
|
1275
1275
|
|
|
1276
1276
|
### Preparation
|
|
1277
1277
|
|
|
@@ -1352,7 +1352,7 @@ alongside values for `start`, `min` and `step`.
|
|
|
1352
1352
|
|
|
1353
1353
|
`min`: The minimum amount selectable.
|
|
1354
1354
|
|
|
1355
|
-
`step`: The number by
|
|
1355
|
+
`step`: The number by which to increment/decrement changes to the amount.
|
|
1356
1356
|
|
|
1357
1357
|
#### connected
|
|
1358
1358
|
|
|
@@ -1373,7 +1373,7 @@ DePayWidgets.Donation({
|
|
|
1373
1373
|
|
|
1374
1374
|
#### fee
|
|
1375
1375
|
|
|
1376
|
-
You can configure a fee which will be applied to every payment with
|
|
1376
|
+
You can configure a fee which will be applied to every payment with its own dedicated fee receiver address.
|
|
1377
1377
|
|
|
1378
1378
|
The fee will be taken from the target token and target amount (after swap, depending on your `accept` configuration).
|
|
1379
1379
|
|
|
@@ -1477,7 +1477,7 @@ DePayWidgets.Donation({
|
|
|
1477
1477
|
|
|
1478
1478
|
`critical`
|
|
1479
1479
|
|
|
1480
|
-
A function that will be called if the widget throws
|
|
1480
|
+
A function that will be called if the widget throws a critical internal error that it can't handle and display on its own:
|
|
1481
1481
|
|
|
1482
1482
|
```javascript
|
|
1483
1483
|
DePayWidgets.Donation({
|
|
@@ -1492,7 +1492,7 @@ DePayWidgets.Donation({
|
|
|
1492
1492
|
|
|
1493
1493
|
`error`
|
|
1494
1494
|
|
|
1495
|
-
A function that will be called if the widget throws
|
|
1495
|
+
A function that will be called if the widget throws a non-critical internal error that it can and will handle and display on its own:
|
|
1496
1496
|
|
|
1497
1497
|
```javascript
|
|
1498
1498
|
DePayWidgets.Donation({
|
|
@@ -1506,7 +1506,7 @@ DePayWidgets.Donation({
|
|
|
1506
1506
|
|
|
1507
1507
|
#### providers
|
|
1508
1508
|
|
|
1509
|
-
Allows to set providers to be used for making RPC calls to the
|
|
1509
|
+
Allows to set providers to be used for making RPC calls to the individual blockchains:
|
|
1510
1510
|
|
|
1511
1511
|
```javascript
|
|
1512
1512
|
DePayWidgets.Donation({
|
|
@@ -1774,7 +1774,7 @@ DePayWidgets.Connect().then(()=>{}).catch((error)=>{
|
|
|
1774
1774
|
|
|
1775
1775
|
DePay Login allows you to perform web3 wallet logins with ease.
|
|
1776
1776
|
|
|
1777
|
-
Returns `account` if
|
|
1777
|
+
Returns `account` if successfully signed and recovered log in message.
|
|
1778
1778
|
|
|
1779
1779
|
```javascript
|
|
1780
1780
|
let message = "Sign to login"
|