@ar.io/sdk 2.5.0-alpha.10 → 2.5.0-alpha.12
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 +32 -0
- package/bundles/web.bundle.min.js +23 -23
- package/lib/cjs/common/io.js +9 -0
- package/lib/cjs/constants.js +1 -1
- package/lib/cjs/version.js +1 -1
- package/lib/esm/common/io.js +9 -0
- package/lib/esm/constants.js +1 -1
- package/lib/esm/version.js +1 -1
- package/lib/types/common/io.d.ts +3 -0
- package/lib/types/constants.d.ts +1 -1
- package/lib/types/types/io.d.ts +3 -0
- package/lib/types/version.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -52,6 +52,7 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
|
|
|
52
52
|
- [`increaseDelegateStake({ target, qty })`](#increasedelegatestake-target-qty-)
|
|
53
53
|
- [`decreaseDelegateStake({ target, qty, instant })`](#decreasedelegatestake-target-qty-instant-)
|
|
54
54
|
- [`getDelegations({ address, cursor, limit, sortBy, sortOrder })`](#getdelegations-address-cursor-limit-sortby-sortorder-)
|
|
55
|
+
- [`getAllowedDelegates({ address, cursor, limit, sortBy, sortOrder })`](#getalloweddelegates-address-cursor-limit-sortby-sortorder-)
|
|
55
56
|
- [`getGatewayVaults({ address, cursor, limit, sortBy, sortOrder })`](#getgatewayvaults-address-cursor-limit-sortby-sortorder-)
|
|
56
57
|
- [`instantWithdrawal({ gatewayAddress, vaultId })`](#instantwithdrawal-gatewayaddress-vaultid-)
|
|
57
58
|
- [`increaseOperatorStake({ qty })`](#increaseoperatorstake-qty-)
|
|
@@ -1259,6 +1260,37 @@ const vaults = await io.getDelegations({
|
|
|
1259
1260
|
|
|
1260
1261
|
</details>
|
|
1261
1262
|
|
|
1263
|
+
#### `getAllowedDelegates({ address, cursor, limit, sortBy, sortOrder })`
|
|
1264
|
+
|
|
1265
|
+
Retrieves all allowed delegates for a specific address. The `cursor` used for pagination is the last address from the previous request.
|
|
1266
|
+
|
|
1267
|
+
```typescript
|
|
1268
|
+
const io = IO.init();
|
|
1269
|
+
const allowedDelegates = await io.getAllowedDelegates({
|
|
1270
|
+
address: 'QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ',
|
|
1271
|
+
});
|
|
1272
|
+
```
|
|
1273
|
+
|
|
1274
|
+
<details>
|
|
1275
|
+
<summary>Output</summary>
|
|
1276
|
+
|
|
1277
|
+
```json
|
|
1278
|
+
{
|
|
1279
|
+
"sortOrder": "desc",
|
|
1280
|
+
"hasMore": false,
|
|
1281
|
+
"totalItems": 4,
|
|
1282
|
+
"limit": 100,
|
|
1283
|
+
"items": [
|
|
1284
|
+
"PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM",
|
|
1285
|
+
"N4h8M9A9hasa3tF47qQyNvcKjm4APBKuFs7vqUVm-SI",
|
|
1286
|
+
"JcC4ZLUY76vmWha5y6RwKsFqYTrMZhbockl8iM9p5lQ",
|
|
1287
|
+
"31LPFYoow2G7j-eSSsrIh8OlNaARZ84-80J-8ba68d8"
|
|
1288
|
+
]
|
|
1289
|
+
}
|
|
1290
|
+
```
|
|
1291
|
+
|
|
1292
|
+
</details>
|
|
1293
|
+
|
|
1262
1294
|
#### `getGatewayVaults({ address, cursor, limit, sortBy, sortOrder })`
|
|
1263
1295
|
|
|
1264
1296
|
Retrieves all vaults across all gateways for a specific address, paginated and sorted by the specified criteria. The `cursor` used for pagination is the last vaultId from the previous request.
|