@ar.io/sdk 2.5.1-alpha.1 → 2.5.1-alpha.3
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 +27 -1
- package/bundles/web.bundle.min.js +2 -2
- package/lib/cjs/common/io.js +1 -2
- package/lib/cjs/version.js +1 -1
- package/lib/esm/common/io.js +1 -2
- package/lib/esm/version.js +1 -1
- package/lib/types/common/io.d.ts +0 -2
- package/lib/types/types/common.d.ts +1 -0
- package/lib/types/types/io.d.ts +1 -5
- package/lib/types/version.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -66,6 +66,7 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
|
|
|
66
66
|
- [`getPrimaryNames({ cursor, limit, sortBy, sortOrder })`](#getprimarynames-cursor-limit-sortby-sortorder-)
|
|
67
67
|
- [`getPrimaryName({ name, address })`](#getprimaryname-name-address-)
|
|
68
68
|
- [`requestPrimaryName({ name, address })`](#requestprimaryname-name-address-)
|
|
69
|
+
- [`getPrimaryNameRequest({ initiator })`](#getprimarynamerequest-initiator-)
|
|
69
70
|
- [`redelegateStake({ target, source, stakeQty, vaultId })`](#redelegatestake-target-source-stakeqty-vaultid-)
|
|
70
71
|
- [`getRedelegationFee({ address })`](#getredelegationfee-address-)
|
|
71
72
|
- [Configuration](#configuration)
|
|
@@ -1593,6 +1594,31 @@ const { id: txId } = await io.requestPrimaryName({
|
|
|
1593
1594
|
});
|
|
1594
1595
|
```
|
|
1595
1596
|
|
|
1597
|
+
#### `getPrimaryNameRequest({ initiator })`
|
|
1598
|
+
|
|
1599
|
+
Retrieves the primary name request for a a wallet address.
|
|
1600
|
+
|
|
1601
|
+
```typescript
|
|
1602
|
+
const io = IO.init();
|
|
1603
|
+
const request = await io.getPrimaryNameRequest({
|
|
1604
|
+
initiator: 't4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3',
|
|
1605
|
+
});
|
|
1606
|
+
```
|
|
1607
|
+
|
|
1608
|
+
<details>
|
|
1609
|
+
<summary>Output</summary>
|
|
1610
|
+
|
|
1611
|
+
```json
|
|
1612
|
+
{
|
|
1613
|
+
"initiator": "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
|
|
1614
|
+
"name": "arns",
|
|
1615
|
+
"startTimestamp": 1728067635857,
|
|
1616
|
+
"endTimestamp": 1735843635857
|
|
1617
|
+
}
|
|
1618
|
+
```
|
|
1619
|
+
|
|
1620
|
+
</details>
|
|
1621
|
+
|
|
1596
1622
|
#### `redelegateStake({ target, source, stakeQty, vaultId })`
|
|
1597
1623
|
|
|
1598
1624
|
Redelegates the stake of a specific address to a new gateway. Vault ID may be optionally included in order to redelegate from an existing withdrawal vault. The redelegation fee is calculated based on the fee rate and the stake amount. Users are allowed one free redelegation every seven epochs. Each additional redelegation beyond the free redelegation will increase the fee by 10%, capping at a 60% redelegation fee.
|
|
@@ -2030,7 +2056,7 @@ _Note: Requires `signer` to be provided on `ANT.init` to sign the transaction._
|
|
|
2030
2056
|
```typescript
|
|
2031
2057
|
const { id: txId } = await ant.approvePrimaryNameRequest({
|
|
2032
2058
|
name: 'arns',
|
|
2033
|
-
|
|
2059
|
+
address: 't4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3', // must match the request initiator address
|
|
2034
2060
|
ioProcessId: IO_TESTNET_PROCESS_ID, // the IO process id to use for the request
|
|
2035
2061
|
});
|
|
2036
2062
|
```
|