@ar.io/sdk 3.3.0-alpha.9 → 3.3.1-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 CHANGED
@@ -47,6 +47,7 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
47
47
  - [`cancelWithdrawal({ gatewayAddress, vaultId })`](#cancelwithdrawal-gatewayaddress-vaultid-)
48
48
  - [`getAllowedDelegates({ address, cursor, limit, sortBy, sortOrder })`](#getalloweddelegates-address-cursor-limit-sortby-sortorder-)
49
49
  - [`getGatewayVaults({ address, cursor, limit, sortBy, sortOrder })`](#getgatewayvaults-address-cursor-limit-sortby-sortorder-)
50
+ - [`getAllGatewayVaults({ cursor, limit, sortBy, sortOrder })`](#getallgatewayvaults-cursor-limit-sortby-sortorder-)
50
51
  - [`increaseOperatorStake({ qty })`](#increaseoperatorstake-qty-)
51
52
  - [`decreaseOperatorStake({ qty })`](#decreaseoperatorstake-qty-)
52
53
  - [`redelegateStake({ target, source, stakeQty, vaultId })`](#redelegatestake-target-source-stakeqty-vaultid-)
@@ -952,6 +953,45 @@ const vaults = await ario.getGatewayVaults({
952
953
 
953
954
  </details>
954
955
 
956
+ #### `getAllGatewayVaults({ cursor, limit, sortBy, sortOrder })`
957
+
958
+ Retrieves all vaults across all gateways, paginated and sorted by the specified criteria. The `cursor` used for pagination is the last vaultId from the previous request.
959
+
960
+ ```typescript
961
+ const ario = ARIO.init();
962
+ const vaults = await ario.getAllGatewayVaults({
963
+ limit: 1,
964
+ sortBy: 'endTimestamp',
965
+ sortOrder: 'desc',
966
+ });
967
+ ```
968
+
969
+ <details>
970
+ <summary>Output</summary>
971
+
972
+ ```json
973
+ {
974
+ "sortOrder": "desc",
975
+ "hasMore": true,
976
+ "totalItems": 95,
977
+ "limit": 1,
978
+ "sortBy": "endTimestamp",
979
+ "items": [
980
+ {
981
+ "cursorId": "PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM_E-QVU3dta36Wia2uQw6tQLjQk7Qw5uN0Z6fUzsoqzUc",
982
+ "gatewayAddress": "PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM",
983
+ "startTimestamp": 1728067635857,
984
+ "balance": 50000000000,
985
+ "vaultId": "E-QVU3dta36Wia2uQw6tQLjQk7Qw5uN0Z6fUzsoqzUc",
986
+ "endTimestamp": 1735843635857
987
+ }
988
+ ],
989
+ "nextCursor": "PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM_E-QVU3dta36Wia2uQw6tQLjQk7Qw5uN0Z6fUzsoqzUc"
990
+ }
991
+ ```
992
+
993
+ </details>
994
+
955
995
  #### `increaseOperatorStake({ qty })`
956
996
 
957
997
  Increases the callers operator stake. Must be executed with a wallet registered as a gateway operator.
@@ -1074,6 +1114,7 @@ const delegates = await ario.getAllDelegates({
1074
1114
  }
1075
1115
  ```
1076
1116
 
1117
+ </details>
1077
1118
  ### Arweave Name System (ArNS)
1078
1119
 
1079
1120
  #### `buyRecord({ name, type, years, processId })`