@ar.io/sdk 2.4.0-alpha.4 → 2.4.0-alpha.6

package/lib/cjs/common/ant.js

@@ -344,6 +344,42 @@ class AoANTWriteable extends AoANTReadable {
             signer: this.signer,
         });
     }
+    /**
+     * @param description @type {string} Sets the ANT Description.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setDescription({ description: "This name is used for the ArDrive" });
+     * ```
+     */
+    async setDescription({ description }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Set-Description' },
+                { name: 'Description', value: description },
+            ],
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param keywords @type {string[]} Sets the ANT Keywords.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setKeywords({ keywords: ['keyword1', 'keyword2', 'keyword3']});
+     * ```
+     */
+    async setKeywords({ keywords }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Set-Keywords' },
+                { name: 'Description', value: JSON.stringify(keywords) },
+            ],
+            signer: this.signer,
+        });
+    }
     /**
      * @param name @type {string} The name you want to release. The name will be put up for auction on the IO contract. 50% of the winning bid will be distributed to the ANT owner at the time of release. If no bids, the name will be released and can be reregistered by anyone.
      * @param ioProcessId @type {string} The processId of the IO contract. This is where the ANT will send the message to release the name.

package/lib/cjs/common/io.js

@@ -643,6 +643,34 @@ class IOWriteable extends IOReadable {
             tags: prunedTags,
         });
     }
+    /**
+     * Upgrades an existing leased record to a permabuy.
+     *
+     * @param {Object} params - The parameters for upgrading a record
+     * @param {string} params.name - The name of the record to upgrade
+     * @param {Object} [options] - The options for the upgrade
+     * @returns {Promise<AoMessageResult>} The result of the upgrade
+     */
+    async upgradeRecord(params, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            signer: this.signer,
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Upgrade-Name' }, // TODO: align on Update-Record vs. Upgrade-Name (contract currently uses Upgrade-Name)
+                { name: 'Name', value: params.name },
+            ],
+        });
+    }
+    /**
+     * Extends the lease of an existing leased record.
+     *
+     * @param {Object} params - The parameters for extending a lease
+     * @param {string} params.name - The name of the record to extend
+     * @param {number} params.years - The number of years to extend the lease
+     * @param {Object} [options] - The options for the extension
+     * @returns {Promise<AoMessageResult>} The result of the extension
+     */
     async extendLease(params, options) {
         const { tags = [] } = options || {};
         return this.process.send({

package/lib/cjs/types/ant.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAoANTState = exports.AntInfoSchema = exports.AntHandlersSchema = exports.AntHandlerNames = exports.AntStateSchema = exports.AntBalancesSchema = exports.AntControllersSchema = exports.AntRecordsSchema = exports.AntRecordSchema = exports.IntegerStringSchema = exports.ArweaveTxIdSchema = void 0;
+exports.isAoANTState = exports.AntInfoSchema = exports.AntHandlersSchema = exports.AntHandlerNames = exports.AntStateSchema = exports.AntBalancesSchema = exports.AntControllersSchema = exports.AntRecordsSchema = exports.AntRecordSchema = exports.AntKeywordsSchema = exports.AntDescriptionSchema = exports.IntegerStringSchema = exports.ArweaveTxIdSchema = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -45,6 +45,8 @@ exports.IntegerStringSchema = zod_1.z
     const num = parseInt(val);
     return Number.isInteger(num) && num >= 0;
 }, { message: 'Must be a non negative integer string' });
+exports.AntDescriptionSchema = zod_1.z.string(); // TODO: add specific limits for description ie max length
+exports.AntKeywordsSchema = zod_1.z.array(zod_1.z.string()); // TODO: add specific limits for keywords ie max amount and max length
 exports.AntRecordSchema = zod_1.z.object({
     transactionId: exports.ArweaveTxIdSchema.describe('The Target ID of the undername'),
     ttlSeconds: zod_1.z.number(),
@@ -55,6 +57,8 @@ exports.AntBalancesSchema = zod_1.z.record(exports.ArweaveTxIdSchema.describe('H
 exports.AntStateSchema = zod_1.z.object({
     Name: zod_1.z.string().describe('The name of the ANT.'),
     Ticker: zod_1.z.string().describe('The ticker symbol for the ANT.'),
+    Description: zod_1.z.string().describe('The description for the ANT.'),
+    Keywords: exports.AntKeywordsSchema.describe('The keywords for the ANT.'),
     Denomination: zod_1.z
         .number()
         .describe('The number of decimal places to use for the ANT. Defaults to 0 if not set representing whole numbers.')
@@ -91,6 +95,8 @@ exports.AntHandlerNames = [
     'records',
     'setName',
     'setTicker',
+    'setDescription',
+    'setKeywords',
     'initializeState',
     'state',
     'releaseName',
@@ -108,6 +114,8 @@ exports.AntInfoSchema = zod_1.z.object({
     ['Source-Code-TX-ID']: exports.ArweaveTxIdSchema.describe('Transaction ID of the Source Code for the ANT.'),
     Ticker: zod_1.z.string().describe('The ticker symbol for the ANT.'),
     ['Total-Supply']: exports.IntegerStringSchema.describe('Total supply of the ANT in circulation.'),
+    Description: exports.AntDescriptionSchema.describe('The description for the ANT.'),
+    Keywords: exports.AntKeywordsSchema.describe('The keywords for the ANT.'),
     Logo: exports.ArweaveTxIdSchema.describe('Transaction ID of the ANT logo.'),
     Denomination: exports.IntegerStringSchema.describe('The number of decimal places to use for the ANT. Defaults to 0 if not set representing whole numbers.'),
     Handlers: exports.AntHandlersSchema.optional().describe('List of handlers for the ANT.'),

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 = '2.4.0-alpha.4';
+exports.version = '2.4.0-alpha.6';

package/lib/esm/common/ant.js

@@ -339,6 +339,42 @@ export class AoANTWriteable extends AoANTReadable {
             signer: this.signer,
         });
     }
+    /**
+     * @param description @type {string} Sets the ANT Description.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setDescription({ description: "This name is used for the ArDrive" });
+     * ```
+     */
+    async setDescription({ description }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Set-Description' },
+                { name: 'Description', value: description },
+            ],
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param keywords @type {string[]} Sets the ANT Keywords.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setKeywords({ keywords: ['keyword1', 'keyword2', 'keyword3']});
+     * ```
+     */
+    async setKeywords({ keywords }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Set-Keywords' },
+                { name: 'Description', value: JSON.stringify(keywords) },
+            ],
+            signer: this.signer,
+        });
+    }
     /**
      * @param name @type {string} The name you want to release. The name will be put up for auction on the IO contract. 50% of the winning bid will be distributed to the ANT owner at the time of release. If no bids, the name will be released and can be reregistered by anyone.
      * @param ioProcessId @type {string} The processId of the IO contract. This is where the ANT will send the message to release the name.

package/lib/esm/common/io.js

@@ -638,6 +638,34 @@ export class IOWriteable extends IOReadable {
             tags: prunedTags,
         });
     }
+    /**
+     * Upgrades an existing leased record to a permabuy.
+     *
+     * @param {Object} params - The parameters for upgrading a record
+     * @param {string} params.name - The name of the record to upgrade
+     * @param {Object} [options] - The options for the upgrade
+     * @returns {Promise<AoMessageResult>} The result of the upgrade
+     */
+    async upgradeRecord(params, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            signer: this.signer,
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Upgrade-Name' }, // TODO: align on Update-Record vs. Upgrade-Name (contract currently uses Upgrade-Name)
+                { name: 'Name', value: params.name },
+            ],
+        });
+    }
+    /**
+     * Extends the lease of an existing leased record.
+     *
+     * @param {Object} params - The parameters for extending a lease
+     * @param {string} params.name - The name of the record to extend
+     * @param {number} params.years - The number of years to extend the lease
+     * @param {Object} [options] - The options for the extension
+     * @returns {Promise<AoMessageResult>} The result of the extension
+     */
     async extendLease(params, options) {
         const { tags = [] } = options || {};
         return this.process.send({

package/lib/esm/types/ant.js

@@ -42,6 +42,8 @@ export const IntegerStringSchema = z
     const num = parseInt(val);
     return Number.isInteger(num) && num >= 0;
 }, { message: 'Must be a non negative integer string' });
+export const AntDescriptionSchema = z.string(); // TODO: add specific limits for description ie max length
+export const AntKeywordsSchema = z.array(z.string()); // TODO: add specific limits for keywords ie max amount and max length
 export const AntRecordSchema = z.object({
     transactionId: ArweaveTxIdSchema.describe('The Target ID of the undername'),
     ttlSeconds: z.number(),
@@ -52,6 +54,8 @@ export const AntBalancesSchema = z.record(ArweaveTxIdSchema.describe('Holder add
 export const AntStateSchema = z.object({
     Name: z.string().describe('The name of the ANT.'),
     Ticker: z.string().describe('The ticker symbol for the ANT.'),
+    Description: z.string().describe('The description for the ANT.'),
+    Keywords: AntKeywordsSchema.describe('The keywords for the ANT.'),
     Denomination: z
         .number()
         .describe('The number of decimal places to use for the ANT. Defaults to 0 if not set representing whole numbers.')
@@ -88,6 +92,8 @@ export const AntHandlerNames = [
     'records',
     'setName',
     'setTicker',
+    'setDescription',
+    'setKeywords',
     'initializeState',
     'state',
     'releaseName',
@@ -105,6 +111,8 @@ export const AntInfoSchema = z.object({
     ['Source-Code-TX-ID']: ArweaveTxIdSchema.describe('Transaction ID of the Source Code for the ANT.'),
     Ticker: z.string().describe('The ticker symbol for the ANT.'),
     ['Total-Supply']: IntegerStringSchema.describe('Total supply of the ANT in circulation.'),
+    Description: AntDescriptionSchema.describe('The description for the ANT.'),
+    Keywords: AntKeywordsSchema.describe('The keywords for the ANT.'),
     Logo: ArweaveTxIdSchema.describe('Transaction ID of the ANT logo.'),
     Denomination: IntegerStringSchema.describe('The number of decimal places to use for the ANT. Defaults to 0 if not set representing whole numbers.'),
     Handlers: AntHandlersSchema.optional().describe('List of handlers for the ANT.'),

package/lib/esm/version.js

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

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

@@ -183,6 +183,28 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
     setName({ name }: {
         name: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * @param description @type {string} Sets the ANT Description.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setDescription({ description: "This name is used for the ArDrive" });
+     * ```
+     */
+    setDescription({ description }: {
+        description: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * @param keywords @type {string[]} Sets the ANT Keywords.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setKeywords({ keywords: ['keyword1', 'keyword2', 'keyword3']});
+     * ```
+     */
+    setKeywords({ keywords }: {
+        keywords: string[];
+    }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * @param name @type {string} The name you want to release. The name will be put up for auction on the IO contract. 50% of the winning bid will be distributed to the ANT owner at the time of release. If no bids, the name will be released and can be reregistered by anyone.
      * @param ioProcessId @type {string} The processId of the IO contract. This is where the ANT will send the message to release the name.

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

@@ -158,6 +158,26 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
         type: 'lease' | 'permabuy';
         processId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * Upgrades an existing leased record to a permabuy.
+     *
+     * @param {Object} params - The parameters for upgrading a record
+     * @param {string} params.name - The name of the record to upgrade
+     * @param {Object} [options] - The options for the upgrade
+     * @returns {Promise<AoMessageResult>} The result of the upgrade
+     */
+    upgradeRecord(params: {
+        name: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * Extends the lease of an existing leased record.
+     *
+     * @param {Object} params - The parameters for extending a lease
+     * @param {string} params.name - The name of the record to extend
+     * @param {number} params.years - The number of years to extend the lease
+     * @param {Object} [options] - The options for the extension
+     * @returns {Promise<AoMessageResult>} The result of the extension
+     */
     extendLease(params: {
         name: string;
         years: number;

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

@@ -29,6 +29,8 @@ import { AoMessageResult, WalletAddress, WriteOptions } from './common.js';
  */
 export declare const ArweaveTxIdSchema: z.ZodEffects<z.ZodString, string, string>;
 export declare const IntegerStringSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const AntDescriptionSchema: z.ZodString;
+export declare const AntKeywordsSchema: z.ZodArray<z.ZodString, "many">;
 export declare const AntRecordSchema: z.ZodObject<{
     transactionId: z.ZodEffects<z.ZodString, string, string>;
     ttlSeconds: z.ZodNumber;
@@ -55,6 +57,8 @@ export declare const AntBalancesSchema: z.ZodRecord<z.ZodEffects<z.ZodString, st
 export declare const AntStateSchema: z.ZodObject<{
     Name: z.ZodString;
     Ticker: z.ZodString;
+    Description: z.ZodString;
+    Keywords: z.ZodArray<z.ZodString, "many">;
     Denomination: z.ZodNumber;
     Owner: z.ZodEffects<z.ZodString, string, string>;
     Controllers: z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">;
@@ -77,6 +81,8 @@ export declare const AntStateSchema: z.ZodObject<{
     "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
+    Description: string;
+    Keywords: string[];
     Denomination: number;
     Owner: string;
     Controllers: string[];
@@ -92,6 +98,8 @@ export declare const AntStateSchema: z.ZodObject<{
     "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
+    Description: string;
+    Keywords: string[];
     Denomination: number;
     Owner: string;
     Controllers: string[];
@@ -113,6 +121,8 @@ export declare const AntInfoSchema: z.ZodObject<{
     "Source-Code-TX-ID": z.ZodEffects<z.ZodString, string, string>;
     Ticker: z.ZodString;
     "Total-Supply": z.ZodEffects<z.ZodString, string, string>;
+    Description: z.ZodString;
+    Keywords: z.ZodArray<z.ZodString, "many">;
     Logo: z.ZodEffects<z.ZodString, string, string>;
     Denomination: z.ZodEffects<z.ZodString, string, string>;
     Handlers: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>>;
@@ -121,6 +131,8 @@ export declare const AntInfoSchema: z.ZodObject<{
     "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
+    Description: string;
+    Keywords: string[];
     Denomination: string;
     Owner: string;
     Logo: string;
@@ -131,6 +143,8 @@ export declare const AntInfoSchema: z.ZodObject<{
     "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
+    Description: string;
+    Keywords: string[];
     Denomination: string;
     Owner: string;
     Logo: string;
@@ -184,6 +198,12 @@ export interface AoANTWrite extends AoANTRead {
     setTicker({ ticker }: {
         ticker: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    setDescription({ description }: {
+        description: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    setKeywords({ keywords }: {
+        keywords: string[];
+    }, options?: WriteOptions): Promise<AoMessageResult>;
     setName({ name }: {
         name: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;

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

@@ -317,6 +317,9 @@ export interface AoIOWrite extends AoIORead {
         type: 'lease' | 'permabuy';
         processId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    upgradeRecord(params: {
+        name: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
     extendLease(params: {
         name: string;
         years: number;

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 = "2.4.0-alpha.3";
+export declare const version = "2.4.0-alpha.5";

package/package.json

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