@ar.io/sdk 2.4.0-alpha.3 → 2.4.0-alpha.5
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 +35 -1
- package/bundles/web.bundle.min.js +53 -53
- package/lib/cjs/common/ant.js +36 -0
- package/lib/cjs/common/io.js +18 -7
- package/lib/cjs/types/ant.js +9 -1
- package/lib/cjs/version.js +1 -1
- package/lib/esm/common/ant.js +36 -0
- package/lib/esm/common/io.js +18 -7
- package/lib/esm/types/ant.js +8 -0
- package/lib/esm/version.js +1 -1
- package/lib/types/common/ant.d.ts +22 -0
- package/lib/types/common/io.d.ts +11 -2
- package/lib/types/types/ant.d.ts +20 -0
- package/lib/types/types/io.d.ts +2 -2
- package/lib/types/version.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -73,6 +73,8 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
|
|
|
73
73
|
- [`removeRecord({ undername })`](#removerecord-undername-)
|
|
74
74
|
- [`setName({ name })`](#setname-name-)
|
|
75
75
|
- [`setTicker({ ticker })`](#setticker-ticker-)
|
|
76
|
+
- [`setDescription({ description })`](#setdescription-description-)
|
|
77
|
+
- [`setKeywords({ keywords })`](#setkeywords-keywords-)
|
|
76
78
|
- [`releaseName({ name, ioProcessId })`](#releasename-name-ioprocessid-)
|
|
77
79
|
- [Configuration](#configuration-1)
|
|
78
80
|
- [Logging](#logging)
|
|
@@ -1339,8 +1341,10 @@ const info = await ant.getInfo();
|
|
|
1339
1341
|
|
|
1340
1342
|
```json
|
|
1341
1343
|
{
|
|
1342
|
-
"name": "
|
|
1344
|
+
"name": "ArDrive",
|
|
1343
1345
|
"ticker": "ANT-ARDRIVE",
|
|
1346
|
+
"description": "This is the ANT for the ArDrive decentralized web app.",
|
|
1347
|
+
"keywords": ["File-sharing", "Publishing", "dApp"],
|
|
1344
1348
|
"owner": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ"
|
|
1345
1349
|
}
|
|
1346
1350
|
```
|
|
@@ -1381,6 +1385,8 @@ const state = await ant.getState();
|
|
|
1381
1385
|
},
|
|
1382
1386
|
"Initialized": true,
|
|
1383
1387
|
"Ticker": "ANT-AR-IO",
|
|
1388
|
+
"Description": "A friendly description for this ANT.",
|
|
1389
|
+
"Keywords": ["keyword1", "keyword2", "keyword3"],
|
|
1384
1390
|
"Logo": "Sie_26dvgyok0PZD_-iQAFOhOd5YxDTkczOLoqTTL_A",
|
|
1385
1391
|
"Denomination": 0,
|
|
1386
1392
|
"Name": "AR.IO Foundation",
|
|
@@ -1574,6 +1580,34 @@ const { id: txId } = await ant.setTicker(
|
|
|
1574
1580
|
);
|
|
1575
1581
|
```
|
|
1576
1582
|
|
|
1583
|
+
#### `setDescription({ description })`
|
|
1584
|
+
|
|
1585
|
+
Sets the description of the ANT process.
|
|
1586
|
+
|
|
1587
|
+
_Note: Requires `signer` to be provided on `ANT.init` to sign the transaction._
|
|
1588
|
+
|
|
1589
|
+
```typescript
|
|
1590
|
+
const { id: txId } = await ant.setDescription(
|
|
1591
|
+
{ description: 'A friendly description of this ANT' },
|
|
1592
|
+
// optional tags
|
|
1593
|
+
{ tags: [{ name: 'App-Name', value: 'My-Awesome-App' }] },
|
|
1594
|
+
);
|
|
1595
|
+
```
|
|
1596
|
+
|
|
1597
|
+
#### `setKeywords({ keywords })`
|
|
1598
|
+
|
|
1599
|
+
Sets the keywords of the ANT process.
|
|
1600
|
+
|
|
1601
|
+
_Note: Requires `signer` to be provided on `ANT.init` to sign the transaction._
|
|
1602
|
+
|
|
1603
|
+
```typescript
|
|
1604
|
+
const { id: txId } = await ant.setDescription(
|
|
1605
|
+
{ keywords: ['Game', 'FPS', 'AO'] },
|
|
1606
|
+
// optional tags
|
|
1607
|
+
{ tags: [{ name: 'App-Name', value: 'My-Awesome-App' }] },
|
|
1608
|
+
);
|
|
1609
|
+
```
|
|
1610
|
+
|
|
1577
1611
|
#### `releaseName({ name, ioProcessId })`
|
|
1578
1612
|
|
|
1579
1613
|
Releases a name from the auction and makes it available for auction on the IO contract. The name must be permanently owned by the releasing wallet. 50% of the winning bid will be distributed to the ANT owner at the time of release. If no bids, the name will be released and can be reregistered by anyone.
|