@ar.io/sdk 3.2.0-alpha.2 → 3.2.0
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 +7 -8
- package/bundles/web.bundle.min.js +2 -2
- package/lib/cjs/cli/options.js +1 -1
- package/lib/cjs/common/ant.js +2 -1
- package/lib/cjs/common/io.js +4 -4
- package/lib/cjs/types/io.js +7 -2
- package/lib/cjs/version.js +1 -1
- package/lib/esm/cli/options.js +1 -1
- package/lib/esm/common/ant.js +2 -1
- package/lib/esm/common/io.js +4 -4
- package/lib/esm/types/io.js +7 -2
- package/lib/esm/version.js +1 -1
- package/lib/types/cli/utils.d.ts +1 -1
- package/lib/types/common/ant.d.ts +2 -1
- package/lib/types/common/io.d.ts +2 -1
- package/lib/types/types/ant.d.ts +2 -1
- package/lib/types/types/io.d.ts +5 -4
- package/lib/types/version.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -98,14 +98,13 @@ This is the home of [ar.io] SDK. This SDK provides functionality for interacting
|
|
|
98
98
|
- [`releaseName({ name, arioProcessId })`](#releasename-name-arioprocessid-)
|
|
99
99
|
- [`reassignName({ name, arioProcessId, antProcessId })`](#reassignname-name-arioprocessid-antprocessid-)
|
|
100
100
|
- [`approvePrimaryNameRequest({ name, address, arioProcessId })`](#approveprimarynamerequest-name-address-arioprocessid-)
|
|
101
|
-
- [`removePrimaryNames({ names, arioProcessId })`](#removeprimarynames-names-arioprocessid-)
|
|
101
|
+
- [`removePrimaryNames({ names, arioProcessId, notifyOwners })`](#removeprimarynames-names-arioprocessid-notifyowners-)
|
|
102
102
|
- [Configuration](#configuration-1)
|
|
103
103
|
- [Logging](#logging)
|
|
104
|
-
- [Configuration](#configuration-2)
|
|
105
104
|
- [Pagination](#pagination)
|
|
106
105
|
- [Resources](#resources)
|
|
107
106
|
- [Bundling](#bundling)
|
|
108
|
-
- [Gateways](#gateways
|
|
107
|
+
- [AR.IO Gateways](#ario-gateways)
|
|
109
108
|
- [Running a Gateway](#running-a-gateway)
|
|
110
109
|
- [AO](#ao)
|
|
111
110
|
- [Developers](#developers)
|
|
@@ -315,7 +314,8 @@ const info = await ario.getInfo();
|
|
|
315
314
|
"Owner": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
|
|
316
315
|
"Denomination": 6,
|
|
317
316
|
"Handlers": ["_eval", "_default_"], // full list of handlers, useful for debugging
|
|
318
|
-
"
|
|
317
|
+
"LastCreatedEpochIndex": 31, // epoch index of the last tick
|
|
318
|
+
"LastDistributedEpochIndex": 31 // epoch index of the last distribution
|
|
319
319
|
}
|
|
320
320
|
```
|
|
321
321
|
|
|
@@ -2089,7 +2089,7 @@ const { id: txId } = await ant.approvePrimaryNameRequest({
|
|
|
2089
2089
|
});
|
|
2090
2090
|
```
|
|
2091
2091
|
|
|
2092
|
-
#### `removePrimaryNames({ names, arioProcessId })`
|
|
2092
|
+
#### `removePrimaryNames({ names, arioProcessId, notifyOwners })`
|
|
2093
2093
|
|
|
2094
2094
|
Removes primary names from the ANT process.
|
|
2095
2095
|
|
|
@@ -2099,6 +2099,7 @@ _Note: Requires `signer` to be provided on `ANT.init` to sign the transaction._
|
|
|
2099
2099
|
const { id: txId } = await ant.removePrimaryNames({
|
|
2100
2100
|
names: ['arns', 'test_arns'], // any primary names associated with a base name controlled by this ANT will be removed
|
|
2101
2101
|
arioProcessId: ARIO_TESTNET_PROCESS_ID,
|
|
2102
|
+
notifyOwners: true, // if true, the owners of the removed names will be send AO messages to notify them of the removal
|
|
2102
2103
|
});
|
|
2103
2104
|
```
|
|
2104
2105
|
|
|
@@ -2125,8 +2126,6 @@ const ant = ANT.init({
|
|
|
2125
2126
|
|
|
2126
2127
|
The library uses the [Winston] logger for node based projects, and `console` logger for web based projects by default. You can configure the log level via `setLogLevel()` API. Alternatively you can set a custom logger as the default logger so long as it satisfes the `ILogger` interface.
|
|
2127
2128
|
|
|
2128
|
-
### Configuration
|
|
2129
|
-
|
|
2130
2129
|
```typescript
|
|
2131
2130
|
import { Logger } from '@ar.io/sdk';
|
|
2132
2131
|
|
|
@@ -2170,7 +2169,7 @@ while (hasMore) {
|
|
|
2170
2169
|
|
|
2171
2170
|
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.
|
|
2172
2171
|
|
|
2173
|
-
### Gateways
|
|
2172
|
+
### AR.IO Gateways
|
|
2174
2173
|
|
|
2175
2174
|
### Running a Gateway
|
|
2176
2175
|
|