@ar.io/sdk 3.16.1-alpha.1 → 3.17.0

package/lib/cjs/cli/cli.js

@@ -241,6 +241,16 @@ const utils_js_1 = require("./utils.js");
     options: options_js_1.paginationOptions,
     action: readCommands_js_1.listArNSRecords,
 });
+(0, utils_js_1.makeCommand)({
+    name: 'list-arns-names-for-address',
+    description: 'List all ArNS names for an address',
+    options: [
+        ...options_js_1.paginationOptions,
+        options_js_1.optionMap.address,
+        options_js_1.optionMap.antRegistryProcessId,
+    ],
+    action: readCommands_js_1.listArNSRecordsForAddress,
+});
 (0, utils_js_1.makeCommand)({
     name: 'list-arns-reserved-names',
     description: 'Get all reserved ArNS names',

package/lib/cjs/cli/commands/readCommands.js

@@ -8,6 +8,7 @@ exports.getDelegations = getDelegations;
 exports.getAllowedDelegates = getAllowedDelegates;
 exports.getArNSRecord = getArNSRecord;
 exports.listArNSRecords = listArNSRecords;
+exports.listArNSRecordsForAddress = listArNSRecordsForAddress;
 exports.getArNSReservedName = getArNSReservedName;
 exports.listArNSReservedNames = listArNSReservedNames;
 exports.getArNSReturnedName = getArNSReturnedName;
@@ -86,6 +87,16 @@ async function listArNSRecords(o) {
     const records = await (0, utils_js_1.readARIOFromOptions)(o).getArNSRecords((0, utils_js_1.paginationParamsFromOptions)(o));
     return records.items.length ? records : { message: 'No records found' };
 }
+async function listArNSRecordsForAddress(o) {
+    const paginationParams = (0, utils_js_1.paginationParamsFromOptions)(o);
+    const address = (0, utils_js_1.requiredAddressFromOptions)(o);
+    const names = await (0, utils_js_1.readARIOFromOptions)(o).getArNSRecordsForAddress({
+        ...paginationParams,
+        address,
+        antRegistryProcessId: o.antRegistryProcessId,
+    });
+    return names.items.length ? names : { message: 'No names found' };
+}
 async function getArNSReservedName(o) {
     const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
     return ((await (0, utils_js_1.readARIOFromOptions)(o).getArNSReservedName({

package/lib/cjs/common/io.js

@@ -21,6 +21,7 @@ const constants_js_1 = require("../constants.js");
 const index_js_1 = require("../types/index.js");
 const ao_js_1 = require("../utils/ao.js");
 const arweave_js_1 = require("../utils/arweave.js");
+const ant_registry_js_1 = require("./ant-registry.js");
 const ant_js_1 = require("./ant.js");
 const arweave_js_2 = require("./arweave.js");
 const ao_process_js_1 = require("./contracts/ao-process.js");
@@ -671,6 +672,50 @@ class ARIOReadable {
             type: nameData.type,
         };
     }
+    /**
+     * Get all ARNS names associated with an address using the provided ANT registry address.
+     *
+     * By default it will use the mainnet ANT registry address.
+     *
+     * @param {Object} params - The parameters for fetching ARNS names
+     * @param {string} params.address - The address to fetch the ARNS names for
+     * @returns {Promise<AoArNSNameData[]>} The ARNS names associated with the address
+     */
+    async getArNSRecordsForAddress(params) {
+        const { antRegistryId = constants_js_1.ANT_REGISTRY_ID, address } = params;
+        const antRegistry = ant_registry_js_1.ANTRegistry.init({
+            process: new ao_process_js_1.AOProcess({
+                ao: this.process.ao,
+                processId: antRegistryId,
+            }),
+        });
+        // Note: there could be a race condition here if the ACL changes during pagination requests, resulting in different results from the `getArNSRecords`.
+        // This is an unlikely scenario, so to give the client control, and keep this API consistent with other ArNS APIs, we refetch the ACL for each page, and
+        // return paginated results.
+        const { Controlled = [], Owned = [] } = await antRegistry.accessControlList({
+            address,
+        });
+        const allProcessIds = new Set([...Controlled, ...Owned]);
+        if (allProcessIds.size === 0) {
+            return {
+                items: [],
+                hasMore: false,
+                nextCursor: undefined,
+                limit: params.limit ?? 1000,
+                totalItems: 0,
+                sortOrder: params.sortOrder ?? 'asc',
+            };
+        }
+        const currentPage = await this.getArNSRecords({
+            ...params,
+            filters: {
+                // NOTE: we confirmed that dry-runs are not limited to the same tag limits as data-items.
+                // Should this change, we'll need to batch the requests.
+                processId: Array.from(allProcessIds),
+            },
+        });
+        return currentPage;
+    }
 }
 exports.ARIOReadable = ARIOReadable;
 class ARIOWriteable extends ARIOReadable {

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.16.1-alpha.1';
+exports.version = '3.17.0';

package/lib/esm/cli/cli.js

@@ -22,7 +22,7 @@ import { version } from '../version.js';
 import { setAntBaseNameCLICommand, setAntRecordCLICommand, } from './commands/antCommands.js';
 import { buyRecordCLICommand, extendLeaseCLICommand, increaseUndernameLimitCLICommand, requestPrimaryNameCLICommand, upgradeRecordCLICommand, } from './commands/arnsPurchaseCommands.js';
 import { cancelWithdrawal, decreaseDelegateStake, decreaseOperatorStake, delegateStake, increaseOperatorStake, instantWithdrawal, joinNetwork, leaveNetwork, redelegateStake, saveObservations, updateGatewaySettings, } from './commands/gatewayWriteCommands.js';
-import { getAllGatewayVaults, getAllowedDelegates, getArNSRecord, getArNSReservedName, getArNSReturnedName, getCostDetails, getDelegations, getEpoch, getGateway, getGatewayDelegates, getGatewayVaults, getPrescribedNames, getPrescribedObservers, getPrimaryName, getTokenCost, getVault, listAllDelegatesCLICommand, listAntsForAddress, listArNSRecords, listArNSReservedNames, listArNSReturnedNames, listGateways, resolveArNSName, } from './commands/readCommands.js';
+import { getAllGatewayVaults, getAllowedDelegates, getArNSRecord, getArNSReservedName, getArNSReturnedName, getCostDetails, getDelegations, getEpoch, getGateway, getGatewayDelegates, getGatewayVaults, getPrescribedNames, getPrescribedObservers, getPrimaryName, getTokenCost, getVault, listAllDelegatesCLICommand, listAntsForAddress, listArNSRecords, listArNSRecordsForAddress, listArNSReservedNames, listArNSReturnedNames, listGateways, resolveArNSName, } from './commands/readCommands.js';
 import { createVaultCLICommand, extendVaultCLICommand, increaseVaultCLICommand, revokeVaultCLICommand, transferCLICommand, vaultedTransferCLICommand, } from './commands/transfer.js';
 import { addressAndVaultIdOptions, antStateOptions, arnsPurchaseOptions, buyRecordOptions, decreaseDelegateStakeOptions, delegateStakeOptions, epochOptions, getVaultOptions, globalOptions, joinNetworkOptions, operatorStakeOptions, optionMap, paginationAddressOptions, paginationOptions, redelegateStakeOptions, setAntBaseNameOptions, setAntUndernameOptions, tokenCostOptions, transferOptions, updateGatewaySettingsOptions, vaultedTransferOptions, writeActionOptions, } from './options.js';
 import { applyOptions, arioProcessIdFromOptions, assertConfirmationPrompt, customTagsFromOptions, epochInputFromOptions, formatARIOWithCommas, getANTStateFromOptions, getLoggerFromOptions, makeCommand, paginationParamsFromOptions, readANTFromOptions, readARIOFromOptions, requiredAddressFromOptions, requiredAoSignerFromOptions, requiredProcessIdFromOptions, requiredStringArrayFromOptions, requiredStringFromOptions, writeANTFromOptions, } from './utils.js';
@@ -239,6 +239,16 @@ makeCommand({
     options: paginationOptions,
     action: listArNSRecords,
 });
+makeCommand({
+    name: 'list-arns-names-for-address',
+    description: 'List all ArNS names for an address',
+    options: [
+        ...paginationOptions,
+        optionMap.address,
+        optionMap.antRegistryProcessId,
+    ],
+    action: listArNSRecordsForAddress,
+});
 makeCommand({
     name: 'list-arns-reserved-names',
     description: 'Get all reserved ArNS names',

package/lib/esm/cli/commands/readCommands.js

@@ -61,6 +61,16 @@ export async function listArNSRecords(o) {
     const records = await readARIOFromOptions(o).getArNSRecords(paginationParamsFromOptions(o));
     return records.items.length ? records : { message: 'No records found' };
 }
+export async function listArNSRecordsForAddress(o) {
+    const paginationParams = paginationParamsFromOptions(o);
+    const address = requiredAddressFromOptions(o);
+    const names = await readARIOFromOptions(o).getArNSRecordsForAddress({
+        ...paginationParams,
+        address,
+        antRegistryProcessId: o.antRegistryProcessId,
+    });
+    return names.items.length ? names : { message: 'No names found' };
+}
 export async function getArNSReservedName(o) {
     const name = requiredStringFromOptions(o, 'name');
     return ((await readARIOFromOptions(o).getArNSReservedName({

package/lib/esm/common/io.js

@@ -14,10 +14,11 @@
  * limitations under the License.
  */
 import { connect } from '@permaweb/aoconnect';
-import { ARIO_MAINNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, } from '../constants.js';
+import { ANT_REGISTRY_ID, ARIO_MAINNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, } from '../constants.js';
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/index.js';
 import { createAoSigner } from '../utils/ao.js';
 import { getEpochDataFromGqlWithCUFallback, paginationParamsToTags, pruneTags, removeEligibleRewardsFromEpochData, sortAndPaginateEpochDataIntoEligibleDistributions, } from '../utils/arweave.js';
+import { ANTRegistry } from './ant-registry.js';
 import { ANT } from './ant.js';
 import { defaultArweave } from './arweave.js';
 import { AOProcess } from './contracts/ao-process.js';
@@ -667,6 +668,50 @@ export class ARIOReadable {
             type: nameData.type,
         };
     }
+    /**
+     * Get all ARNS names associated with an address using the provided ANT registry address.
+     *
+     * By default it will use the mainnet ANT registry address.
+     *
+     * @param {Object} params - The parameters for fetching ARNS names
+     * @param {string} params.address - The address to fetch the ARNS names for
+     * @returns {Promise<AoArNSNameData[]>} The ARNS names associated with the address
+     */
+    async getArNSRecordsForAddress(params) {
+        const { antRegistryId = ANT_REGISTRY_ID, address } = params;
+        const antRegistry = ANTRegistry.init({
+            process: new AOProcess({
+                ao: this.process.ao,
+                processId: antRegistryId,
+            }),
+        });
+        // Note: there could be a race condition here if the ACL changes during pagination requests, resulting in different results from the `getArNSRecords`.
+        // This is an unlikely scenario, so to give the client control, and keep this API consistent with other ArNS APIs, we refetch the ACL for each page, and
+        // return paginated results.
+        const { Controlled = [], Owned = [] } = await antRegistry.accessControlList({
+            address,
+        });
+        const allProcessIds = new Set([...Controlled, ...Owned]);
+        if (allProcessIds.size === 0) {
+            return {
+                items: [],
+                hasMore: false,
+                nextCursor: undefined,
+                limit: params.limit ?? 1000,
+                totalItems: 0,
+                sortOrder: params.sortOrder ?? 'asc',
+            };
+        }
+        const currentPage = await this.getArNSRecords({
+            ...params,
+            filters: {
+                // NOTE: we confirmed that dry-runs are not limited to the same tag limits as data-items.
+                // Should this change, we'll need to batch the requests.
+                processId: Array.from(allProcessIds),
+            },
+        });
+        return currentPage;
+    }
 }
 export class ARIOWriteable extends ARIOReadable {
     signer;

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.16.1-alpha.1';
+export const version = '3.17.0';

package/lib/types/cli/commands/readCommands.d.ts

@@ -35,6 +35,9 @@ export declare function getArNSRecord(o: NameCLIOptions): Promise<import("../../
 export declare function listArNSRecords(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<AoArNSNameDataWithName> | {
     message: string;
 }>;
+export declare function listArNSRecordsForAddress(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<AoArNSNameDataWithName> | {
+    message: string;
+}>;
 export declare function getArNSReservedName(o: NameCLIOptions): Promise<import("../../types/io.js").AoArNSReservedNameData>;
 export declare function listArNSReservedNames(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoArNSReservedNameDataWithName> | {
     message: string;

package/lib/types/common/io.d.ts

@@ -140,6 +140,19 @@ export declare class ARIOReadable implements AoARIORead, ArNSNameResolver {
     resolveArNSName({ name, }: {
         name: string;
     }): Promise<ArNSNameResolutionData>;
+    /**
+     * Get all ARNS names associated with an address using the provided ANT registry address.
+     *
+     * By default it will use the mainnet ANT registry address.
+     *
+     * @param {Object} params - The parameters for fetching ARNS names
+     * @param {string} params.address - The address to fetch the ARNS names for
+     * @returns {Promise<AoArNSNameData[]>} The ARNS names associated with the address
+     */
+    getArNSRecordsForAddress(params: PaginationParams<AoArNSNameDataWithName> & {
+        antRegistryId?: string;
+        address: WalletAddress;
+    }): Promise<PaginationResult<AoArNSNameDataWithName>>;
 }
 export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
     private signer;

package/lib/types/types/io.d.ts

@@ -470,6 +470,10 @@ export interface AoARIORead extends ArNSNameResolver {
         name: string;
     }): Promise<AoArNSNameData>;
     getArNSRecords(params?: AoGetArNSRecordsParams): Promise<PaginationResult<AoArNSNameDataWithName>>;
+    getArNSRecordsForAddress(params: PaginationParams<AoArNSNameDataWithName> & {
+        address: WalletAddress;
+        antRegistryProcessId?: string;
+    }): Promise<PaginationResult<AoArNSNameDataWithName>>;
     getArNSReservedNames(params?: PaginationParams<AoArNSReservedNameDataWithName>): Promise<PaginationResult<AoArNSReservedNameDataWithName>>;
     getArNSReservedName({ name, }: {
         name: string;

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.16.0";
+export declare const version = "3.16.1-alpha.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.16.1-alpha.1",
+  "version": "3.17.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"