@ar.io/sdk 3.23.0 → 3.23.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 +12 -12
- package/lib/cjs/version.js +1 -1
- package/lib/esm/version.js +1 -1
- package/lib/types/version.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://codecov.io/gh/ar-io/ar-io-sdk)
|
|
4
4
|
|
|
5
|
-
This is the home of
|
|
5
|
+
This is the home of the ar.io SDK. This SDK provides functionality for interacting with the ar.io ecosystem of services (e.g. gateways and observers) and protocols (e.g. ArNS and AO). It is available for both NodeJS and Web environments.
|
|
6
6
|
|
|
7
7
|
## Table of Contents
|
|
8
8
|
|
|
@@ -60,8 +60,8 @@ const gateways = await ario.getGateways();
|
|
|
60
60
|
"operatorStake": 250000000000,
|
|
61
61
|
"settings": {
|
|
62
62
|
"fqdn": "ar-io.dev",
|
|
63
|
-
"label": "
|
|
64
|
-
"note": "Test Gateway operated by PDS for the
|
|
63
|
+
"label": "ar.io Test",
|
|
64
|
+
"note": "Test Gateway operated by PDS for the ar.io ecosystem.",
|
|
65
65
|
"port": 443,
|
|
66
66
|
"properties": "raJgvbFU-YAnku-WsupIdbTsqqGLQiYpGzoqk9SCVgY",
|
|
67
67
|
"protocol": "https"
|
|
@@ -355,7 +355,7 @@ const testnet = ARIO.testnet(); // or ARIO.init({ processId: ARIO_TESTNET_PROCES
|
|
|
355
355
|
|
|
356
356
|
##### Faucet
|
|
357
357
|
|
|
358
|
-
The SDK provides APIs for claiming tokens via a faucet on the
|
|
358
|
+
The SDK provides APIs for claiming tokens via a faucet on the ar.io Testnet process (`tARIO`) via the [ar-io-testnet-faucet] service. All token requests require a captcha to be solved, and the faucet is rate limited to prevent abuse.
|
|
359
359
|
|
|
360
360
|
To claim testnet tokens from the testnet token faucet, you can use one of the following methods:
|
|
361
361
|
|
|
@@ -593,8 +593,8 @@ const gateway = await ario.getGateway({
|
|
|
593
593
|
"operatorStake": 250000000000,
|
|
594
594
|
"settings": {
|
|
595
595
|
"fqdn": "ar-io.dev",
|
|
596
|
-
"label": "
|
|
597
|
-
"note": "Test Gateway operated by PDS for the
|
|
596
|
+
"label": "ar.io Test",
|
|
597
|
+
"note": "Test Gateway operated by PDS for the ar.io ecosystem.",
|
|
598
598
|
"port": 443,
|
|
599
599
|
"properties": "raJgvbFU-YAnku-WsupIdbTsqqGLQiYpGzoqk9SCVgY",
|
|
600
600
|
"protocol": "https"
|
|
@@ -649,8 +649,8 @@ Available `sortBy` options are any of the keys on the gateway object, e.g. `oper
|
|
|
649
649
|
"operatorStake": 250000000000,
|
|
650
650
|
"settings": {
|
|
651
651
|
"fqdn": "ar-io.dev",
|
|
652
|
-
"label": "
|
|
653
|
-
"note": "Test Gateway operated by PDS for the
|
|
652
|
+
"label": "ar.io Test",
|
|
653
|
+
"note": "Test Gateway operated by PDS for the ar.io ecosystem.",
|
|
654
654
|
"port": 443,
|
|
655
655
|
"properties": "raJgvbFU-YAnku-WsupIdbTsqqGLQiYpGzoqk9SCVgY",
|
|
656
656
|
"protocol": "https"
|
|
@@ -2350,7 +2350,7 @@ const state = await ant.getState();
|
|
|
2350
2350
|
"Keywords": ["keyword1", "keyword2", "keyword3"],
|
|
2351
2351
|
"Logo": "Sie_26dvgyok0PZD_-iQAFOhOd5YxDTkczOLoqTTL_A",
|
|
2352
2352
|
"Denomination": 0,
|
|
2353
|
-
"Name": "
|
|
2353
|
+
"Name": "ar.io Foundation",
|
|
2354
2354
|
"Owner": "98O1_xqDLrBKRfQPWjF5p7xZ4Jx6GM8P5PeJn26xwUY"
|
|
2355
2355
|
}
|
|
2356
2356
|
```
|
|
@@ -3061,7 +3061,7 @@ console.log(
|
|
|
3061
3061
|
|
|
3062
3062
|
## Token Conversion
|
|
3063
3063
|
|
|
3064
|
-
The ARIO process stores all values as mARIO (
|
|
3064
|
+
The ARIO process stores all values as mARIO (micro-ARIO) to avoid floating-point arithmetic issues. The SDK provides an `ARIOToken` and `mARIOToken` classes to handle the conversion between ARIO and mARIO, along with rounding logic for precision.
|
|
3065
3065
|
|
|
3066
3066
|
**All process interactions expect values in mARIO. If numbers are provided as inputs, they are assumed to be in raw mARIO values.**
|
|
3067
3067
|
|
|
@@ -3176,7 +3176,7 @@ In the example above, the query will return ArNS records where:
|
|
|
3176
3176
|
|
|
3177
3177
|
For [ANS-104] bundling compatible with ar.io gateways, we recommend using [turbo-sdk](https://github.com/ardriveapp/turbo-sdk). Turbo SDK provides efficient and reliable methods for creating and uploading data bundles to the Arweave network, which are fully compatible with ar.io gateways. Turbo supports fiat and crypto bundling and uploading with a focus on ease of use and reliability.
|
|
3178
3178
|
|
|
3179
|
-
###
|
|
3179
|
+
### ar.io Gateways
|
|
3180
3180
|
|
|
3181
3181
|
### Running a Gateway
|
|
3182
3182
|
|
|
@@ -3254,4 +3254,4 @@ For more information on how to contribute, please see [CONTRIBUTING.md].
|
|
|
3254
3254
|
|
|
3255
3255
|
```
|
|
3256
3256
|
|
|
3257
|
-
```
|
|
3257
|
+
```
|
package/lib/cjs/version.js
CHANGED
package/lib/esm/version.js
CHANGED
package/lib/types/version.d.ts
CHANGED