@ar.io/sdk 2.5.5 → 2.6.0-alpha.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 +0 -48
- package/bundles/web.bundle.min.js +3 -3
- package/lib/cjs/common/ant.js +1 -1
- package/lib/cjs/common/io.js +5 -0
- package/lib/cjs/version.js +1 -1
- package/lib/esm/common/ant.js +1 -1
- package/lib/esm/common/io.js +5 -0
- package/lib/esm/version.js +1 -1
- package/lib/types/common/io.d.ts +2 -1
- package/lib/types/types/io.d.ts +21 -0
- package/lib/types/version.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -36,7 +36,6 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
|
|
|
36
36
|
- [Gateways](#gateways)
|
|
37
37
|
- [`getGateway({ address })`](#getgateway-address-)
|
|
38
38
|
- [`getGateways({ cursor, limit, sortBy, sortOrder })`](#getgateways-cursor-limit-sortby-sortorder-)
|
|
39
|
-
- [`getGatewayDelegates({ address, cursor, limit, sortBy, sortOrder })`](#getgatewaydelegates-address-cursor-limit-sortby-sortorder-)
|
|
40
39
|
- [`joinNetwork(params)`](#joinnetworkparams)
|
|
41
40
|
- [`leaveNetwork()`](#leavenetwork)
|
|
42
41
|
- [`updateGatewaySettings({ ...settings })`](#updategatewaysettings-settings-)
|
|
@@ -623,53 +622,6 @@ Available `sortBy` options are any of the keys on the gateway object, e.g. `oper
|
|
|
623
622
|
|
|
624
623
|
</details>
|
|
625
624
|
|
|
626
|
-
#### `getGatewayDelegates({ address, cursor, limit, sortBy, sortOrder })`
|
|
627
|
-
|
|
628
|
-
Retrieves all delegates for a specific gateway, paginated and sorted by the specified criteria. The `cursor` used for pagination is the last delegationId from the previous request.
|
|
629
|
-
|
|
630
|
-
```typescript
|
|
631
|
-
const io = IO.init();
|
|
632
|
-
const delegates = await io.getGatewayDelegates({
|
|
633
|
-
address: 'QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ',
|
|
634
|
-
limit: 3,
|
|
635
|
-
sortBy: 'startTimestamp',
|
|
636
|
-
sortOrder: 'desc',
|
|
637
|
-
});
|
|
638
|
-
```
|
|
639
|
-
|
|
640
|
-
<details>
|
|
641
|
-
<summary>Output</summary>
|
|
642
|
-
|
|
643
|
-
```json
|
|
644
|
-
{
|
|
645
|
-
"nextCursor": "ScEtph9-vfY7lgqlUWwUwOmm99ySeZGQhOX0MFAyFEs",
|
|
646
|
-
"limit": 3,
|
|
647
|
-
"sortBy": "startTimestamp",
|
|
648
|
-
"totalItems": 32,
|
|
649
|
-
"sortOrder": "desc",
|
|
650
|
-
"hasMore": true,
|
|
651
|
-
"items": [
|
|
652
|
-
{
|
|
653
|
-
"delegatedStake": 600000000,
|
|
654
|
-
"address": "qD5VLaMYyIHlT6vH59TgYIs6g3EFlVjlPqljo6kqVxk",
|
|
655
|
-
"startTimestamp": 1732716956301
|
|
656
|
-
},
|
|
657
|
-
{
|
|
658
|
-
"delegatedStake": 508999038,
|
|
659
|
-
"address": "KG8TlcWk-8pvroCjiLD2J5zkG9rqC6yYaBuZNqHEyY4",
|
|
660
|
-
"startTimestamp": 1731828123742
|
|
661
|
-
},
|
|
662
|
-
{
|
|
663
|
-
"delegatedStake": 510926479,
|
|
664
|
-
"address": "ScEtph9-vfY7lgqlUWwUwOmm99ySeZGQhOX0MFAyFEs",
|
|
665
|
-
"startTimestamp": 1731689356040
|
|
666
|
-
}
|
|
667
|
-
]
|
|
668
|
-
}
|
|
669
|
-
```
|
|
670
|
-
|
|
671
|
-
</details>
|
|
672
|
-
|
|
673
625
|
#### `joinNetwork(params)`
|
|
674
626
|
|
|
675
627
|
Joins a gateway to the ar.io network via its associated wallet.
|