@ar.io/sdk 3.8.3 → 3.9.0-alpha.1

package/lib/cjs/common/ant-versions.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ANTVersionsWritable = exports.ANTVersionsReadable = exports.ANTVersions = void 0;
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const constants_js_1 = require("../constants.js");
+const io_js_1 = require("../types/io.js");
+const ao_js_1 = require("../utils/ao.js");
+const arweave_js_1 = require("../utils/arweave.js");
+const ao_process_js_1 = require("./contracts/ao-process.js");
+const error_js_1 = require("./error.js");
+class ANTVersions {
+    static init(config) {
+        if (config !== undefined && 'signer' in config) {
+            return new ANTVersionsWritable(config);
+        }
+        return new ANTVersionsReadable(config);
+    }
+}
+exports.ANTVersions = ANTVersions;
+class ANTVersionsReadable {
+    process;
+    constructor(config) {
+        if (config === undefined || Object.keys(config).length === 0) {
+            this.process = new ao_process_js_1.AOProcess({
+                processId: constants_js_1.ANT_REGISTRY_ID,
+            });
+        }
+        else if ((0, io_js_1.isProcessConfiguration)(config)) {
+            this.process = config.process;
+        }
+        else if ((0, io_js_1.isProcessIdConfiguration)(config)) {
+            this.process = new ao_process_js_1.AOProcess({
+                processId: config.processId,
+            });
+        }
+        else {
+            throw new error_js_1.InvalidContractConfigurationError();
+        }
+    }
+    async getANTVersions() {
+        const res = await this.process.read({
+            tags: [{ name: 'Action', value: 'Get-Versions' }],
+        });
+        return Object.fromEntries(Object.entries(res).sort(([a], [b]) => a.localeCompare(b)));
+    }
+    async getLatestANTVersion() {
+        const versions = await this.getANTVersions();
+        const lastestVersion = Object.entries(versions).at(-1);
+        if (!lastestVersion)
+            throw new Error('No version found');
+        return {
+            version: lastestVersion[0],
+            ...lastestVersion[1],
+        };
+    }
+}
+exports.ANTVersionsReadable = ANTVersionsReadable;
+class ANTVersionsWritable extends ANTVersionsReadable {
+    signer;
+    constructor({ signer, ...config }) {
+        super(config);
+        this.signer = (0, ao_js_1.createAoSigner)(signer);
+    }
+    async addVersion(params, { tags }) {
+        return this.process.send({
+            tags: (0, arweave_js_1.pruneTags)([
+                { name: 'Action', value: 'Add-Version' },
+                { name: 'Version', value: params.version },
+                { name: 'Module-Id', value: params.moduleId },
+                { name: 'Lua-Source-Id', value: params.luaSourceId },
+                { name: 'Notes', value: params.notes },
+                ...(tags ?? []),
+            ]),
+            signer: this.signer,
+        });
+    }
+}
+exports.ANTVersionsWritable = ANTVersionsWritable;

package/lib/cjs/common/ant.js

@@ -22,8 +22,10 @@ const index_js_1 = require("../types/index.js");
 const ant_js_2 = require("../utils/ant.js");
 const ao_js_1 = require("../utils/ao.js");
 const schema_js_1 = require("../utils/schema.js");
+const ant_versions_js_1 = require("./ant-versions.js");
 const index_js_2 = require("./index.js");
 class ANT {
+    static versions = ant_versions_js_1.ANTVersions.init();
     // implementation
     static init(config) {
         if (config !== undefined && 'signer' in config) {

package/lib/cjs/common/index.js

@@ -33,6 +33,7 @@ __exportStar(require("./error.js"), exports);
 __exportStar(require("./logger.js"), exports);
 __exportStar(require("./ant.js"), exports);
 __exportStar(require("./ant-registry.js"), exports);
+__exportStar(require("./ant-versions.js"), exports);
 // ao
 __exportStar(require("./io.js"), exports);
 __exportStar(require("./contracts/ao-process.js"), exports);

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.8.3';
+exports.version = '3.9.0-alpha.1';

package/lib/esm/common/ant-versions.js

@@ -0,0 +1,86 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ANT_REGISTRY_ID } from '../constants.js';
+import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/io.js';
+import { createAoSigner } from '../utils/ao.js';
+import { pruneTags } from '../utils/arweave.js';
+import { AOProcess } from './contracts/ao-process.js';
+import { InvalidContractConfigurationError } from './error.js';
+export class ANTVersions {
+    static init(config) {
+        if (config !== undefined && 'signer' in config) {
+            return new ANTVersionsWritable(config);
+        }
+        return new ANTVersionsReadable(config);
+    }
+}
+export class ANTVersionsReadable {
+    process;
+    constructor(config) {
+        if (config === undefined || Object.keys(config).length === 0) {
+            this.process = new AOProcess({
+                processId: ANT_REGISTRY_ID,
+            });
+        }
+        else if (isProcessConfiguration(config)) {
+            this.process = config.process;
+        }
+        else if (isProcessIdConfiguration(config)) {
+            this.process = new AOProcess({
+                processId: config.processId,
+            });
+        }
+        else {
+            throw new InvalidContractConfigurationError();
+        }
+    }
+    async getANTVersions() {
+        const res = await this.process.read({
+            tags: [{ name: 'Action', value: 'Get-Versions' }],
+        });
+        return Object.fromEntries(Object.entries(res).sort(([a], [b]) => a.localeCompare(b)));
+    }
+    async getLatestANTVersion() {
+        const versions = await this.getANTVersions();
+        const lastestVersion = Object.entries(versions).at(-1);
+        if (!lastestVersion)
+            throw new Error('No version found');
+        return {
+            version: lastestVersion[0],
+            ...lastestVersion[1],
+        };
+    }
+}
+export class ANTVersionsWritable extends ANTVersionsReadable {
+    signer;
+    constructor({ signer, ...config }) {
+        super(config);
+        this.signer = createAoSigner(signer);
+    }
+    async addVersion(params, { tags }) {
+        return this.process.send({
+            tags: pruneTags([
+                { name: 'Action', value: 'Add-Version' },
+                { name: 'Version', value: params.version },
+                { name: 'Module-Id', value: params.moduleId },
+                { name: 'Lua-Source-Id', value: params.luaSourceId },
+                { name: 'Notes', value: params.notes },
+                ...(tags ?? []),
+            ]),
+            signer: this.signer,
+        });
+    }
+}

package/lib/esm/common/ant.js

@@ -19,8 +19,10 @@ import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/inde
 import { sortANTRecords } from '../utils/ant.js';
 import { createAoSigner } from '../utils/ao.js';
 import { parseSchemaResult } from '../utils/schema.js';
+import { ANTVersions } from './ant-versions.js';
 import { AOProcess, InvalidContractConfigurationError } from './index.js';
 export class ANT {
+    static versions = ANTVersions.init();
     // implementation
     static init(config) {
         if (config !== undefined && 'signer' in config) {

package/lib/esm/common/index.js

@@ -17,6 +17,7 @@ export * from './error.js';
 export * from './logger.js';
 export * from './ant.js';
 export * from './ant-registry.js';
+export * from './ant-versions.js';
 // ao
 export * from './io.js';
 export * from './contracts/ao-process.js';

package/lib/esm/version.js

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

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

@@ -0,0 +1,42 @@
+import { AoANTVersionsRead, AoANTVersionsWrite } from '../types/ant.js';
+import { WithSigner } from '../types/common.js';
+import { ProcessConfiguration } from '../types/io.js';
+import { AOProcess } from './contracts/ao-process.js';
+type ANTVersionsNoSigner = ProcessConfiguration;
+type ANTVersionsWithSigner = WithSigner<ProcessConfiguration>;
+export declare class ANTVersions {
+    static init(): AoANTVersionsRead;
+    static init(config: ANTVersionsNoSigner): AoANTVersionsRead;
+    static init(config: ANTVersionsWithSigner): AoANTVersionsWrite;
+}
+export declare class ANTVersionsReadable implements AoANTVersionsRead {
+    protected process: AOProcess;
+    constructor(config?: ProcessConfiguration);
+    getANTVersions(): Promise<Record<string, {
+        moduleId: string;
+        luaSourceId?: string;
+        notes: string;
+    }>>;
+    getLatestANTVersion(): Promise<{
+        version: string;
+        moduleId: string;
+        luaSourceId?: string;
+        notes?: string;
+    }>;
+}
+export declare class ANTVersionsWritable extends ANTVersionsReadable implements AoANTVersionsWrite {
+    private signer;
+    constructor({ signer, ...config }: WithSigner<ProcessConfiguration>);
+    addVersion(params: {
+        version: string;
+        moduleId: string;
+        luaSourceId?: string;
+        notes?: string;
+    }, { tags }: {
+        tags: any;
+    }): Promise<{
+        id: string;
+        result?: unknown;
+    }>;
+}
+export {};

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

@@ -1,4 +1,4 @@
-import { AntReadOptions, AoANTHandler, AoANTInfo, AoANTRead, AoANTRecord, AoANTSetBaseNameRecordParams, AoANTSetUndernameRecordParams, AoANTState, AoANTWrite, SortedANTRecords } from '../types/ant.js';
+import { AntReadOptions, AoANTHandler, AoANTInfo, AoANTRead, AoANTRecord, AoANTSetBaseNameRecordParams, AoANTSetUndernameRecordParams, AoANTState, AoANTVersionsRead, AoANTWrite, SortedANTRecords } from '../types/ant.js';
 import { AoMessageResult, ProcessConfiguration, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
 import { AOProcess } from './index.js';
 type ANTConfigOptionalStrict = Required<ProcessConfiguration> & {
@@ -7,6 +7,7 @@ type ANTConfigOptionalStrict = Required<ProcessConfiguration> & {
 type ANTConfigNoSigner = ANTConfigOptionalStrict;
 type ANTConfigWithSigner = WithSigner<ANTConfigOptionalStrict>;
 export declare class ANT {
+    static versions: AoANTVersionsRead;
     static init(config: ANTConfigNoSigner): AoANTRead;
     static init(config: ANTConfigWithSigner): AoANTWrite;
 }

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

@@ -17,5 +17,6 @@ export * from './error.js';
 export * from './logger.js';
 export * from './ant.js';
 export * from './ant-registry.js';
+export * from './ant-versions.js';
 export * from './io.js';
 export * from './contracts/ao-process.js';

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

@@ -260,3 +260,24 @@ export type AoANTSetBaseNameRecordParams = {
 export type AoANTSetUndernameRecordParams = AoANTSetBaseNameRecordParams & {
     undername: string;
 };
+export interface AoANTVersionsRead {
+    getANTVersions(): Promise<Record<string, {
+        moduleId: string;
+        luaSourceId?: string;
+        notes?: string;
+    }>>;
+    getLatestANTVersion(): Promise<{
+        version: string;
+        moduleId: string;
+        luaSourceId?: string;
+        notes?: string;
+    }>;
+}
+export interface AoANTVersionsWrite extends AoANTVersionsRead {
+    addVersion: AoWriteAction<{
+        version: string;
+        moduleId: string;
+        luaSourceId?: string;
+        notes?: string;
+    }>;
+}

package/package.json

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