@ar.io/sdk 3.11.0-alpha.8 → 3.11.0-alpha.9

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
@@ -1179,6 +1179,58 @@ const delegates = await ario.getAllDelegates({
1179
1179
 
1180
1180
  ### Arweave Name System (ArNS)
1181
1181
 
1182
+ #### `resolveArNSName({ name })`
1183
+
1184
+ Resolves an ArNS name to the underlying data id stored on the names corresponding ANT id.
1185
+
1186
+ ##### Resolving a base name
1187
+
1188
+ ```typescript
1189
+ const ario = ARIO.mainnet();
1190
+ const record = await ario.resolveArNSName({ name: 'ardrive' });
1191
+ ```
1192
+
1193
+ <details>
1194
+ <summary>Output</summary>
1195
+
1196
+ ```json
1197
+ {
1198
+ "processId": "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
1199
+ "txId": "kvhEUsIY5bXe0Wu2-YUFz20O078uYFzmQIO-7brv8qw",
1200
+ "type": "lease",
1201
+ "recordIndex": 0,
1202
+ "undernameLimit": 100,
1203
+ "owner": "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
1204
+ "name": "ardrive"
1205
+ }
1206
+ ```
1207
+
1208
+ </details>
1209
+
1210
+ ##### Resolving an undername
1211
+
1212
+ ```typescript
1213
+ const ario = ARIO.mainnet();
1214
+ const record = await ario.resolveArNSName({ name: 'logo_ardrive' });
1215
+ ```
1216
+
1217
+ <details>
1218
+ <summary>Output</summary>
1219
+
1220
+ ```json
1221
+ {
1222
+ "processId": "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
1223
+ "txId": "kvhEUsIY5bXe0Wu2-YUFz20O078uYFzmQIO-7brv8qw",
1224
+ "type": "lease",
1225
+ "recordIndex": 1,
1226
+ "undernameLimit": 100,
1227
+ "owner": "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
1228
+ "name": "ardrive"
1229
+ }
1230
+ ```
1231
+
1232
+ </details>
1233
+
1182
1234
  #### `buyRecord({ name, type, years, processId })`
1183
1235
 
1184
1236
  Purchases a new ArNS record with the specified name, type, and duration.