@ar.io/sdk 2.4.0-alpha.1 → 2.4.0-alpha.3

package/lib/cjs/common/ant.js

@@ -331,7 +331,7 @@ class AoANTWriteable extends AoANTReadable {
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
      * ```ts
-     * ant.setName({ name: "ships at sea" });
+     * ant.setName({ name: "test" }); // results in the resolution of `test_<apexName>.ar.io`
      * ```
      */
     async setName({ name }, options) {
@@ -344,5 +344,25 @@ class AoANTWriteable extends AoANTReadable {
             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.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.releaseName({ name: "ardrive", ioProcessId: IO_TESTNET_PROCESS_ID });
+     * ```
+     */
+    async releaseName({ name, ioProcessId }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Release-Name' },
+                { name: 'Name', value: name },
+                { name: 'IO-Process-Id', value: ioProcessId },
+            ],
+            signer: this.signer,
+        });
+    }
 }
 exports.AoANTWriteable = AoANTWriteable;

package/lib/cjs/common/io.js

@@ -296,7 +296,7 @@ class IOReadable {
             tags: prunedTags,
         });
     }
-    async getTokenCost({ intent, purchaseType, years, name, quantity, }) {
+    async getTokenCost({ intent, type, years, name, quantity, }) {
         const allTags = [
             { name: 'Action', value: 'Token-Cost' },
             {
@@ -317,7 +317,7 @@ class IOReadable {
             },
             {
                 name: 'Purchase-Type',
-                value: purchaseType,
+                value: type,
             },
             {
                 name: 'Timestamp',
@@ -346,6 +346,64 @@ class IOReadable {
             tags: [{ name: 'Action', value: 'Demand-Factor' }],
         });
     }
+    // Auctions
+    async getAuctions(params) {
+        const allTags = [
+            { name: 'Action', value: 'Auctions' },
+            { name: 'Cursor', value: params?.cursor?.toString() },
+            { name: 'Limit', value: params?.limit?.toString() },
+            { name: 'Sort-By', value: params?.sortBy },
+            { name: 'Sort-Order', value: params?.sortOrder },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
+        return this.process.read({
+            tags: prunedTags,
+        });
+    }
+    async getAuction({ name }) {
+        const allTags = [
+            { name: 'Action', value: 'Auction-Info' },
+            { name: 'Name', value: name },
+        ];
+        return this.process.read({
+            tags: allTags,
+        });
+    }
+    /**
+     * Get auction prices for a given auction at the provided intervals
+     *
+     * @param {Object} params - The parameters for fetching auction prices
+     * @param {string} params.name - The name of the auction
+     * @param {('permabuy'|'lease')} [params.type='lease'] - The type of purchase
+     * @param {number} [params.years=1] - The number of years for lease (only applicable if type is 'lease')
+     * @param {number} [params.timestamp=Date.now()] - The timestamp to fetch prices for
+     * @param {number} [params.intervalMs=900000] - The interval in milliseconds between price points (default is 15 minutes)
+     * @returns {Promise<AoAuctionPriceData>} The auction price data
+     */
+    async getAuctionPrices({ name, type, years, timestamp, intervalMs, }) {
+        const prunedPriceTags = [
+            { name: 'Action', value: 'Auction-Prices' },
+            { name: 'Name', value: name },
+            {
+                name: 'Timestamp',
+                value: timestamp?.toString() ?? Date.now().toString(),
+            },
+            { name: 'Purchase-Type', value: type ?? 'lease' },
+            {
+                name: 'Years',
+                value: type == undefined || type === 'lease'
+                    ? years?.toString() ?? '1'
+                    : undefined,
+            },
+            {
+                name: 'Price-Interval-Ms',
+                value: intervalMs?.toString() ?? '900000',
+            },
+        ].filter((tag) => tag.value !== undefined);
+        return this.process.read({
+            tags: prunedPriceTags,
+        });
+    }
 }
 exports.IOReadable = IOReadable;
 class IOWriteable extends IOReadable {
@@ -621,5 +679,22 @@ class IOWriteable extends IOReadable {
             ],
         });
     }
+    async submitAuctionBid(params, options) {
+        const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Auction-Bid' },
+            { name: 'Name', value: params.name },
+            { name: 'Process-Id', value: params.processId },
+            { name: 'Quantity', value: params.quantity?.toString() ?? undefined },
+            { name: 'Purchase-Type', value: params.type || 'lease' },
+            { name: 'Years', value: params.years?.toString() ?? undefined },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
+        return this.process.send({
+            signer: this.signer,
+            tags: prunedTags,
+        });
+    }
 }
 exports.IOWriteable = IOWriteable;

package/lib/cjs/types/ant.js

@@ -93,6 +93,7 @@ exports.AntHandlerNames = [
     'setTicker',
     'initializeState',
     'state',
+    'releaseName',
 ];
 exports.AntHandlersSchema = zod_1.z
     .array(zod_1.z.string({ description: 'Handler Name' }))

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

package/lib/esm/common/ant.js

@@ -326,7 +326,7 @@ export class AoANTWriteable extends AoANTReadable {
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
      * ```ts
-     * ant.setName({ name: "ships at sea" });
+     * ant.setName({ name: "test" }); // results in the resolution of `test_<apexName>.ar.io`
      * ```
      */
     async setName({ name }, options) {
@@ -339,4 +339,24 @@ export class AoANTWriteable extends AoANTReadable {
             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.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.releaseName({ name: "ardrive", ioProcessId: IO_TESTNET_PROCESS_ID });
+     * ```
+     */
+    async releaseName({ name, ioProcessId }, options) {
+        return this.process.send({
+            tags: [
+                ...(options?.tags ?? []),
+                { name: 'Action', value: 'Release-Name' },
+                { name: 'Name', value: name },
+                { name: 'IO-Process-Id', value: ioProcessId },
+            ],
+            signer: this.signer,
+        });
+    }
 }

package/lib/esm/common/io.js

@@ -292,7 +292,7 @@ export class IOReadable {
             tags: prunedTags,
         });
     }
-    async getTokenCost({ intent, purchaseType, years, name, quantity, }) {
+    async getTokenCost({ intent, type, years, name, quantity, }) {
         const allTags = [
             { name: 'Action', value: 'Token-Cost' },
             {
@@ -313,7 +313,7 @@ export class IOReadable {
             },
             {
                 name: 'Purchase-Type',
-                value: purchaseType,
+                value: type,
             },
             {
                 name: 'Timestamp',
@@ -342,6 +342,64 @@ export class IOReadable {
             tags: [{ name: 'Action', value: 'Demand-Factor' }],
         });
     }
+    // Auctions
+    async getAuctions(params) {
+        const allTags = [
+            { name: 'Action', value: 'Auctions' },
+            { name: 'Cursor', value: params?.cursor?.toString() },
+            { name: 'Limit', value: params?.limit?.toString() },
+            { name: 'Sort-By', value: params?.sortBy },
+            { name: 'Sort-Order', value: params?.sortOrder },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
+        return this.process.read({
+            tags: prunedTags,
+        });
+    }
+    async getAuction({ name }) {
+        const allTags = [
+            { name: 'Action', value: 'Auction-Info' },
+            { name: 'Name', value: name },
+        ];
+        return this.process.read({
+            tags: allTags,
+        });
+    }
+    /**
+     * Get auction prices for a given auction at the provided intervals
+     *
+     * @param {Object} params - The parameters for fetching auction prices
+     * @param {string} params.name - The name of the auction
+     * @param {('permabuy'|'lease')} [params.type='lease'] - The type of purchase
+     * @param {number} [params.years=1] - The number of years for lease (only applicable if type is 'lease')
+     * @param {number} [params.timestamp=Date.now()] - The timestamp to fetch prices for
+     * @param {number} [params.intervalMs=900000] - The interval in milliseconds between price points (default is 15 minutes)
+     * @returns {Promise<AoAuctionPriceData>} The auction price data
+     */
+    async getAuctionPrices({ name, type, years, timestamp, intervalMs, }) {
+        const prunedPriceTags = [
+            { name: 'Action', value: 'Auction-Prices' },
+            { name: 'Name', value: name },
+            {
+                name: 'Timestamp',
+                value: timestamp?.toString() ?? Date.now().toString(),
+            },
+            { name: 'Purchase-Type', value: type ?? 'lease' },
+            {
+                name: 'Years',
+                value: type == undefined || type === 'lease'
+                    ? years?.toString() ?? '1'
+                    : undefined,
+            },
+            {
+                name: 'Price-Interval-Ms',
+                value: intervalMs?.toString() ?? '900000',
+            },
+        ].filter((tag) => tag.value !== undefined);
+        return this.process.read({
+            tags: prunedPriceTags,
+        });
+    }
 }
 export class IOWriteable extends IOReadable {
     signer;
@@ -616,4 +674,21 @@ export class IOWriteable extends IOReadable {
             ],
         });
     }
+    async submitAuctionBid(params, options) {
+        const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Auction-Bid' },
+            { name: 'Name', value: params.name },
+            { name: 'Process-Id', value: params.processId },
+            { name: 'Quantity', value: params.quantity?.toString() ?? undefined },
+            { name: 'Purchase-Type', value: params.type || 'lease' },
+            { name: 'Years', value: params.years?.toString() ?? undefined },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
+        return this.process.send({
+            signer: this.signer,
+            tags: prunedTags,
+        });
+    }
 }

package/lib/esm/types/ant.js

@@ -90,6 +90,7 @@ export const AntHandlerNames = [
     'setTicker',
     'initializeState',
     'state',
+    'releaseName',
 ];
 export const AntHandlersSchema = z
     .array(z.string({ description: 'Handler Name' }))

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.1';
+export const version = '2.4.0-alpha.3';

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

@@ -177,10 +177,23 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
      * ```ts
-     * ant.setName({ name: "ships at sea" });
+     * ant.setName({ name: "test" }); // results in the resolution of `test_<apexName>.ar.io`
      * ```
      */
     setName({ name }: {
         name: 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.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.releaseName({ name: "ardrive", ioProcessId: IO_TESTNET_PROCESS_ID });
+     * ```
+     */
+    releaseName({ name, ioProcessId }: {
+        name: string;
+        ioProcessId: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }

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

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 import Arweave from 'arweave';
-import { AoArNSNameDataWithName, AoArNSReservedNameData, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
-import { AoArNSNameData, AoEpochData, AoEpochSettings, AoGateway, AoIORead, AoIOWrite, AoRegistrationFees, EpochInput } from '../types/io.js';
+import { AoArNSNameDataWithName, AoArNSReservedNameData, AoAuction, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
+import { AoArNSNameData, AoAuctionPriceData, AoEpochData, AoEpochSettings, AoGateway, AoIORead, AoIOWrite, AoRegistrationFees, EpochInput } from '../types/io.js';
 import { mIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
 export declare class IO {
@@ -75,7 +75,7 @@ export declare class IOReadable implements AoIORead {
     getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData>;
     getTokenCost(params: {
         intent: 'Buy-Record';
-        purchaseType: 'permabuy' | 'lease';
+        type: 'permabuy' | 'lease';
         years: number;
         name: string;
     }): Promise<number>;
@@ -91,6 +91,28 @@ export declare class IOReadable implements AoIORead {
     }): Promise<number>;
     getRegistrationFees(): Promise<AoRegistrationFees>;
     getDemandFactor(): Promise<number>;
+    getAuctions(params?: PaginationParams): Promise<PaginationResult<AoAuction>>;
+    getAuction({ name }: {
+        name: string;
+    }): Promise<AoAuction | undefined>;
+    /**
+     * Get auction prices for a given auction at the provided intervals
+     *
+     * @param {Object} params - The parameters for fetching auction prices
+     * @param {string} params.name - The name of the auction
+     * @param {('permabuy'|'lease')} [params.type='lease'] - The type of purchase
+     * @param {number} [params.years=1] - The number of years for lease (only applicable if type is 'lease')
+     * @param {number} [params.timestamp=Date.now()] - The timestamp to fetch prices for
+     * @param {number} [params.intervalMs=900000] - The interval in milliseconds between price points (default is 15 minutes)
+     * @returns {Promise<AoAuctionPriceData>} The auction price data
+     */
+    getAuctionPrices({ name, type, years, timestamp, intervalMs, }: {
+        name: string;
+        type?: 'permabuy' | 'lease';
+        years?: number;
+        timestamp?: number;
+        intervalMs?: number;
+    }): Promise<AoAuctionPriceData>;
 }
 export declare class IOWriteable extends IOReadable implements AoIOWrite {
     protected process: AOProcess;
@@ -148,4 +170,11 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
         address: string;
         vaultId: string;
     }, options?: WriteOptions | undefined): Promise<AoMessageResult>;
+    submitAuctionBid(params: {
+        name: string;
+        processId: string;
+        quantity?: number;
+        type?: 'lease' | 'permabuy';
+        years?: number;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }

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

@@ -187,4 +187,8 @@ export interface AoANTWrite extends AoANTRead {
     setName({ name }: {
         name: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    releaseName({ name, ioProcessId }: {
+        name: string;
+        ioProcessId: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }

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

@@ -203,6 +203,27 @@ export type AoBalanceWithAddress = {
     address: WalletAddress;
     balance: number;
 };
+export type AoAuctionSettings = {
+    durationMs: number;
+    decayRate: number;
+    scalingExponent: number;
+    startPriceMultiplier: number;
+};
+export type AoAuction = {
+    name: string;
+    startTimestamp: Timestamp;
+    endTimestamp: Timestamp;
+    initiator: string;
+    baseFee: number;
+    demandFactor: number;
+    settings: AoAuctionSettings;
+};
+export type AoAuctionPriceData = {
+    type: 'lease' | 'permabuy';
+    years?: number;
+    prices: Record<string, number>;
+    currentPrice: number;
+};
 export type AoJoinNetworkParams = Pick<AoGateway, 'operatorStake' | 'observerAddress'> & Partial<AoGatewaySettings>;
 export type AoUpdateGatewaySettingsParams = AtLeastOne<AoJoinNetworkParams>;
 export interface AoIORead {
@@ -238,15 +259,26 @@ export interface AoIORead {
     getPrescribedNames(epoch?: EpochInput): Promise<string[]>;
     getObservations(epoch?: EpochInput): Promise<AoEpochObservationData>;
     getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData>;
-    getTokenCost({ intent, purchaseType, years, name, quantity, }: {
+    getTokenCost({ intent, type, years, name, quantity, }: {
         intent: 'Buy-Record' | 'Extend-Lease' | 'Increase-Undername-Limit';
-        purchaseType?: 'permabuy' | 'lease';
+        type?: 'permabuy' | 'lease';
         years?: number;
         name?: string;
         quantity?: number;
     }): Promise<number>;
     getRegistrationFees(): Promise<AoRegistrationFees>;
     getDemandFactor(): Promise<number>;
+    getAuctions(params?: PaginationParams): Promise<PaginationResult<AoAuction>>;
+    getAuction({ name }: {
+        name: string;
+    }): Promise<AoAuction | undefined>;
+    getAuctionPrices({ name, type, years, timestamp, intervalMs, }: {
+        name: string;
+        type: 'lease' | 'permabuy';
+        years?: number;
+        timestamp?: number;
+        intervalMs?: number;
+    }): Promise<AoAuctionPriceData>;
 }
 export interface AoIOWrite extends AoIORead {
     transfer({ target, qty, }: {
@@ -297,6 +329,13 @@ export interface AoIOWrite extends AoIORead {
         address: string;
         vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    submitAuctionBid(params: {
+        name: string;
+        processId: string;
+        quantity?: number;
+        type?: 'lease' | 'permabuy';
+        years?: number;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }
 export declare function isProcessConfiguration(config: object): config is {
     process: AOProcess;

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.3.3-alpha.1";
+export declare const version = "2.4.0-alpha.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "2.4.0-alpha.1",
+  "version": "2.4.0-alpha.3",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -73,6 +73,7 @@
     "test:link": "yarn build && yarn link",
     "test:e2e": "yarn test:cjs && yarn test:esm && yarn test:web",
     "prepare": "husky install",
+    "docs:update": "markdown-toc-gen insert README.md",
     "example:esm": "cd examples/esm && yarn && node index.mjs",
     "example:cjs": "yarn test:link && cd examples/cjs && yarn && node index.cjs",
     "example:web": "yarn test:link && build:web && http-server --port 8080 --host -o examples/web"