@ar.io/sdk 3.19.0-alpha.2 → 3.19.0-alpha.4

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

@@ -72,9 +72,16 @@ async function upgradeAntCLICommand(o) {
             `ANT Process ID: ${writeAnt.processId}\n` +
             `Names that will be reassigned (${names.length}): ${names.join(', ')}`, o);
     }
-    return (0, utils_js_1.writeANTFromOptions)(o).upgrade({
-        reassignAffiliatedNames,
-        names,
-        arioProcessId,
-    });
+    if (reassignAffiliatedNames) {
+        return (0, utils_js_1.writeANTFromOptions)(o).upgrade({
+            reassignAffiliatedNames,
+            arioProcessId,
+        });
+    }
+    else {
+        return (0, utils_js_1.writeANTFromOptions)(o).upgrade({
+            names,
+            arioProcessId,
+        });
+    }
 }

package/lib/cjs/common/ant.js

@@ -52,17 +52,17 @@ class ANT {
      * @param config Configuration object for the upgrade process
      * @returns Promise resolving to the forked process ID and successfully reassigned names
      */
-    static async upgrade({ signer, antProcessId, reassignAffiliatedNames = true, // if true, will reassign all affiliated names, otherwise will use the names parameter
-    names = [], arioProcessId = constants_js_1.ARIO_MAINNET_PROCESS_ID, antRegistryId = constants_js_2.ANT_REGISTRY_ID, ao, logger = index_js_2.Logger.default, skipVersionCheck = false, onSigningProgress, hyperbeamUrl, }) {
-        // if names is not empty but reassignAffiliatedNames it true, throw
-        if (names.length > 0 && reassignAffiliatedNames) {
+    static async upgrade({ signer, antProcessId, reassignAffiliatedNames = false, names = [], arioProcessId = constants_js_1.ARIO_MAINNET_PROCESS_ID, antRegistryId = constants_js_2.ANT_REGISTRY_ID, ao, logger = index_js_2.Logger.default, skipVersionCheck = false, onSigningProgress, hyperbeamUrl, }) {
+        // run time check if names is not empty but reassignAffiliatedNames it true, throw
+        if (names.length > 0 && reassignAffiliatedNames !== undefined) {
             throw new Error('Cannot reassign all affiliated names and provide specific names');
         }
+        const namesToReassign = names.length > 0 ? names : [];
+        const ario = index_js_2.ARIO.init({
+            process: new index_js_2.AOProcess({ processId: arioProcessId, ao }),
+        });
         // get all the affiliated names if reassign all affiliated names is true
         if (reassignAffiliatedNames) {
-            const ario = index_js_2.ARIO.init({
-                process: new index_js_2.AOProcess({ processId: arioProcessId, ao }),
-            });
             onSigningProgress?.('fetching-affiliated-names', {
                 arioProcessId,
                 antProcessId,
@@ -72,7 +72,25 @@ class ANT {
                     processId: antProcessId,
                 },
             });
-            names.push(...allAffiliatedNames.items.map((record) => record.name));
+            namesToReassign.push(...allAffiliatedNames.items.map((record) => record.name));
+        }
+        else {
+            onSigningProgress?.('validating-names', {
+                arioProcessId,
+                antProcessId,
+                names,
+            });
+            // confirm all names are affiliated with the ANT
+            const allAffiliatedNames = await ario.getArNSRecords({
+                filters: {
+                    processId: antProcessId,
+                },
+            });
+            if (!names.every((name) => allAffiliatedNames.items.some((record) => record.name === name))) {
+                // find any that are not affiliated with the ANT
+                const notAffiliatedNames = names.filter((name) => !allAffiliatedNames.items.some((record) => record.name === name));
+                throw new Error(`All names must be affiliated with the ANT on the provided ARIO process. The following names are not affiliated to this ANT: ${notAffiliatedNames.join(', ')}`);
+            }
         }
         // if names is empty and reassign all affiliated names is false, throw an error
         if (names.length === 0) {
@@ -114,7 +132,7 @@ class ANT {
         // we could parallelize this, but then signing progress would be harder to track
         const reassignedNames = [];
         const failedReassignedNames = [];
-        for (const name of names) {
+        for (const name of namesToReassign) {
             try {
                 onSigningProgress?.('reassigning-name', {
                     name,
@@ -147,8 +165,8 @@ exports.ANT = ANT;
 class AoANTReadable {
     process;
     processId;
-    strict;
     hyperbeamUrl;
+    strict;
     checkHyperBeamPromise;
     moduleId;
     moduleIdPromise;
@@ -1000,7 +1018,6 @@ class AoANTWriteable extends AoANTReadable {
      * This is a convenience method that calls the static ANT.upgrade() method
      * using this instance's process ID and signer.
      *
-     * TODO: Add version checking by implementing a getVersion API on ANTs to compare
      * current version with latest ANT registry version and skip if already up to date.
      *
      * @param names @type {string[]} The ArNS names to reassign to the upgraded ANT.
@@ -1017,18 +1034,34 @@ class AoANTWriteable extends AoANTReadable {
      * console.log(`Upgraded to process: ${result.forkedProcessId}`);
      * ```
      */
-    async upgrade({ names, reassignAffiliatedNames, arioProcessId, antRegistryId, onSigningProgress, skipVersionCheck = false, }) {
-        return ANT.upgrade({
-            signer: this.signer,
-            antProcessId: this.processId,
-            ao: this.process.ao,
-            names,
-            reassignAffiliatedNames,
-            arioProcessId,
-            antRegistryId,
-            onSigningProgress,
-            skipVersionCheck,
-        });
+    async upgrade({ names, reassignAffiliatedNames, arioProcessId, antRegistryId, skipVersionCheck, onSigningProgress, }) {
+        if (reassignAffiliatedNames) {
+            return ANT.upgrade({
+                signer: this.signer,
+                antProcessId: this.processId,
+                ao: this.process.ao,
+                hyperbeamUrl: this.hyperbeamUrl?.toString(),
+                reassignAffiliatedNames: true,
+                arioProcessId: arioProcessId,
+                antRegistryId: antRegistryId,
+                onSigningProgress: onSigningProgress,
+                skipVersionCheck: skipVersionCheck,
+            });
+        }
+        else {
+            return ANT.upgrade({
+                signer: this.signer,
+                antProcessId: this.processId,
+                ao: this.process.ao,
+                hyperbeamUrl: this.hyperbeamUrl?.toString(),
+                names: names,
+                reassignAffiliatedNames: false,
+                arioProcessId: arioProcessId,
+                antRegistryId: antRegistryId,
+                onSigningProgress: onSigningProgress,
+                skipVersionCheck: skipVersionCheck,
+            });
+        }
     }
 }
 exports.AoANTWriteable = AoANTWriteable;

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.19.0-alpha.2';
+exports.version = '3.19.0-alpha.4';

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

@@ -66,9 +66,16 @@ export async function upgradeAntCLICommand(o) {
             `ANT Process ID: ${writeAnt.processId}\n` +
             `Names that will be reassigned (${names.length}): ${names.join(', ')}`, o);
     }
-    return writeANTFromOptions(o).upgrade({
-        reassignAffiliatedNames,
-        names,
-        arioProcessId,
-    });
+    if (reassignAffiliatedNames) {
+        return writeANTFromOptions(o).upgrade({
+            reassignAffiliatedNames,
+            arioProcessId,
+        });
+    }
+    else {
+        return writeANTFromOptions(o).upgrade({
+            names,
+            arioProcessId,
+        });
+    }
 }

package/lib/esm/common/ant.js

@@ -49,17 +49,17 @@ export class ANT {
      * @param config Configuration object for the upgrade process
      * @returns Promise resolving to the forked process ID and successfully reassigned names
      */
-    static async upgrade({ signer, antProcessId, reassignAffiliatedNames = true, // if true, will reassign all affiliated names, otherwise will use the names parameter
-    names = [], arioProcessId = ARIO_MAINNET_PROCESS_ID, antRegistryId = ANT_REGISTRY_ID, ao, logger = Logger.default, skipVersionCheck = false, onSigningProgress, hyperbeamUrl, }) {
-        // if names is not empty but reassignAffiliatedNames it true, throw
-        if (names.length > 0 && reassignAffiliatedNames) {
+    static async upgrade({ signer, antProcessId, reassignAffiliatedNames = false, names = [], arioProcessId = ARIO_MAINNET_PROCESS_ID, antRegistryId = ANT_REGISTRY_ID, ao, logger = Logger.default, skipVersionCheck = false, onSigningProgress, hyperbeamUrl, }) {
+        // run time check if names is not empty but reassignAffiliatedNames it true, throw
+        if (names.length > 0 && reassignAffiliatedNames !== undefined) {
             throw new Error('Cannot reassign all affiliated names and provide specific names');
         }
+        const namesToReassign = names.length > 0 ? names : [];
+        const ario = ARIO.init({
+            process: new AOProcess({ processId: arioProcessId, ao }),
+        });
         // get all the affiliated names if reassign all affiliated names is true
         if (reassignAffiliatedNames) {
-            const ario = ARIO.init({
-                process: new AOProcess({ processId: arioProcessId, ao }),
-            });
             onSigningProgress?.('fetching-affiliated-names', {
                 arioProcessId,
                 antProcessId,
@@ -69,7 +69,25 @@ export class ANT {
                     processId: antProcessId,
                 },
             });
-            names.push(...allAffiliatedNames.items.map((record) => record.name));
+            namesToReassign.push(...allAffiliatedNames.items.map((record) => record.name));
+        }
+        else {
+            onSigningProgress?.('validating-names', {
+                arioProcessId,
+                antProcessId,
+                names,
+            });
+            // confirm all names are affiliated with the ANT
+            const allAffiliatedNames = await ario.getArNSRecords({
+                filters: {
+                    processId: antProcessId,
+                },
+            });
+            if (!names.every((name) => allAffiliatedNames.items.some((record) => record.name === name))) {
+                // find any that are not affiliated with the ANT
+                const notAffiliatedNames = names.filter((name) => !allAffiliatedNames.items.some((record) => record.name === name));
+                throw new Error(`All names must be affiliated with the ANT on the provided ARIO process. The following names are not affiliated to this ANT: ${notAffiliatedNames.join(', ')}`);
+            }
         }
         // if names is empty and reassign all affiliated names is false, throw an error
         if (names.length === 0) {
@@ -111,7 +129,7 @@ export class ANT {
         // we could parallelize this, but then signing progress would be harder to track
         const reassignedNames = [];
         const failedReassignedNames = [];
-        for (const name of names) {
+        for (const name of namesToReassign) {
             try {
                 onSigningProgress?.('reassigning-name', {
                     name,
@@ -143,8 +161,8 @@ export class ANT {
 export class AoANTReadable {
     process;
     processId;
-    strict;
     hyperbeamUrl;
+    strict;
     checkHyperBeamPromise;
     moduleId;
     moduleIdPromise;
@@ -995,7 +1013,6 @@ export class AoANTWriteable extends AoANTReadable {
      * This is a convenience method that calls the static ANT.upgrade() method
      * using this instance's process ID and signer.
      *
-     * TODO: Add version checking by implementing a getVersion API on ANTs to compare
      * current version with latest ANT registry version and skip if already up to date.
      *
      * @param names @type {string[]} The ArNS names to reassign to the upgraded ANT.
@@ -1012,17 +1029,33 @@ export class AoANTWriteable extends AoANTReadable {
      * console.log(`Upgraded to process: ${result.forkedProcessId}`);
      * ```
      */
-    async upgrade({ names, reassignAffiliatedNames, arioProcessId, antRegistryId, onSigningProgress, skipVersionCheck = false, }) {
-        return ANT.upgrade({
-            signer: this.signer,
-            antProcessId: this.processId,
-            ao: this.process.ao,
-            names,
-            reassignAffiliatedNames,
-            arioProcessId,
-            antRegistryId,
-            onSigningProgress,
-            skipVersionCheck,
-        });
+    async upgrade({ names, reassignAffiliatedNames, arioProcessId, antRegistryId, skipVersionCheck, onSigningProgress, }) {
+        if (reassignAffiliatedNames) {
+            return ANT.upgrade({
+                signer: this.signer,
+                antProcessId: this.processId,
+                ao: this.process.ao,
+                hyperbeamUrl: this.hyperbeamUrl?.toString(),
+                reassignAffiliatedNames: true,
+                arioProcessId: arioProcessId,
+                antRegistryId: antRegistryId,
+                onSigningProgress: onSigningProgress,
+                skipVersionCheck: skipVersionCheck,
+            });
+        }
+        else {
+            return ANT.upgrade({
+                signer: this.signer,
+                antProcessId: this.processId,
+                ao: this.process.ao,
+                hyperbeamUrl: this.hyperbeamUrl?.toString(),
+                names: names,
+                reassignAffiliatedNames: false,
+                arioProcessId: arioProcessId,
+                antRegistryId: antRegistryId,
+                onSigningProgress: onSigningProgress,
+                skipVersionCheck: skipVersionCheck,
+            });
+        }
     }
 }

package/lib/esm/version.js

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

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

@@ -32,12 +32,9 @@ export declare class ANT {
      * @param config Configuration object for the upgrade process
      * @returns Promise resolving to the forked process ID and successfully reassigned names
      */
-    static upgrade({ signer, antProcessId, reassignAffiliatedNames, // if true, will reassign all affiliated names, otherwise will use the names parameter
-    names, arioProcessId, antRegistryId, ao, logger, skipVersionCheck, onSigningProgress, hyperbeamUrl, }: {
+    static upgrade({ signer, antProcessId, reassignAffiliatedNames, names, arioProcessId, antRegistryId, ao, logger, skipVersionCheck, onSigningProgress, hyperbeamUrl, }: {
         signer: AoSigner;
         antProcessId: string;
-        names?: string[];
-        reassignAffiliatedNames?: boolean;
         arioProcessId?: string;
         skipVersionCheck?: boolean;
         ao?: AoClient;
@@ -45,7 +42,13 @@ export declare class ANT {
         antRegistryId?: string;
         hyperbeamUrl?: string;
         onSigningProgress?: (name: keyof UpgradeAntProgressEvent, payload: UpgradeAntProgressEvent[keyof UpgradeAntProgressEvent]) => void;
-    }): Promise<{
+    } & ({
+        names: string[];
+        reassignAffiliatedNames?: false;
+    } | {
+        reassignAffiliatedNames: true;
+        names?: never[];
+    })): Promise<{
         forkedProcessId: string;
         reassignedNames: string[];
         failedReassignedNames: string[];
@@ -61,8 +64,8 @@ export declare class ANT {
 export declare class AoANTReadable implements AoANTRead {
     protected process: AOProcess;
     readonly processId: string;
+    readonly hyperbeamUrl: URL | undefined;
     private strict;
-    private hyperbeamUrl;
     private checkHyperBeamPromise;
     private moduleId;
     private moduleIdPromise;
@@ -463,7 +466,6 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
      * This is a convenience method that calls the static ANT.upgrade() method
      * using this instance's process ID and signer.
      *
-     * TODO: Add version checking by implementing a getVersion API on ANTs to compare
      * current version with latest ANT registry version and skip if already up to date.
      *
      * @param names @type {string[]} The ArNS names to reassign to the upgraded ANT.
@@ -480,14 +482,18 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
      * console.log(`Upgraded to process: ${result.forkedProcessId}`);
      * ```
      */
-    upgrade({ names, reassignAffiliatedNames, arioProcessId, antRegistryId, onSigningProgress, skipVersionCheck, }: {
-        names?: string[];
+    upgrade({ names, reassignAffiliatedNames, arioProcessId, antRegistryId, skipVersionCheck, onSigningProgress, }: {
         arioProcessId?: string;
         antRegistryId?: string;
         skipVersionCheck?: boolean;
-        reassignAffiliatedNames?: boolean;
         onSigningProgress?: (name: keyof UpgradeAntProgressEvent, payload: UpgradeAntProgressEvent[keyof UpgradeAntProgressEvent]) => void;
-    }): Promise<{
+    } & ({
+        reassignAffiliatedNames?: false;
+        names: string[];
+    } | {
+        reassignAffiliatedNames: true;
+        names?: never[];
+    })): Promise<{
         forkedProcessId: string;
         reassignedNames: string[];
         failedReassignedNames: string[];

package/lib/types/types/ant.d.ts

@@ -335,12 +335,16 @@ export interface AoANTWrite extends AoANTRead {
         notifyOwners?: boolean;
     }>;
     upgrade(params: {
-        names?: string[];
-        reassignAffiliatedNames?: boolean;
         arioProcessId?: string;
         antRegistryId?: string;
         onSigningProgress?: (name: keyof UpgradeAntProgressEvent, payload: UpgradeAntProgressEvent[keyof UpgradeAntProgressEvent]) => void;
-    }): Promise<{
+    } & ({
+        reassignAffiliatedNames?: false;
+        names: string[];
+    } | {
+        reassignAffiliatedNames: true;
+        names?: never[];
+    })): Promise<{
         forkedProcessId: string;
         reassignedNames: string[];
         failedReassignedNames: string[];

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

@@ -140,6 +140,11 @@ export type UpgradeAntProgressEvent = SpawnAntProgressEvent & {
         arioProcessId: string;
         antProcessId: string;
     };
+    'validating-names': {
+        arioProcessId: string;
+        antProcessId: string;
+        names: string[];
+    };
 };
 export type BuyArNSNameProgressEvents = SpawnAntProgressEvent & {
     'buying-name': AoBuyRecordParams;

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.19.0-alpha.1";
+export declare const version = "3.19.0-alpha.3";

package/package.json

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