@ar.io/sdk 2.4.0-alpha.5 → 2.4.0-alpha.7

package/lib/cjs/common/io.js

@@ -575,16 +575,26 @@ class IOWriteable extends IOReadable {
             ],
         });
     }
-    async instantDelegateWithdrawal(params, options) {
+    /**
+     * Initiates an instant withdrawal from a gateway.
+     *
+     * @param {Object} params - The parameters for initiating an instant withdrawal
+     * @param {string} params.address - The gateway address of the withdrawal, if not provided, the signer's address will be used
+     * @param {string} params.vaultId - The vault ID of the withdrawal
+     * @returns {Promise<AoMessageResult>} The result of the withdrawal
+     */
+    async instantWithdrawal(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Instant-Withdrawal' },
+            { name: 'Vault-Id', value: params.vaultId },
+            { name: 'Address', value: params.gatewayAddress },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Decrease-Delegate-Stake' },
-                { name: 'Target', value: params.target },
-                { name: 'Vault-Id', value: params.vaultId },
-            ],
+            tags: prunedTags,
         });
     }
     async increaseOperatorStake(params, options) {
@@ -643,6 +653,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({
@@ -681,8 +719,8 @@ class IOWriteable extends IOReadable {
         const allTags = [
             ...tags,
             { name: 'Action', value: 'Cancel-Withdrawal' },
-            { name: 'Address', value: params.address },
             { name: 'Vault-Id', value: params.vaultId },
+            { name: 'Address', value: params.gatewayAddress },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({

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

package/lib/esm/common/io.js

@@ -570,16 +570,26 @@ export class IOWriteable extends IOReadable {
             ],
         });
     }
-    async instantDelegateWithdrawal(params, options) {
+    /**
+     * Initiates an instant withdrawal from a gateway.
+     *
+     * @param {Object} params - The parameters for initiating an instant withdrawal
+     * @param {string} params.address - The gateway address of the withdrawal, if not provided, the signer's address will be used
+     * @param {string} params.vaultId - The vault ID of the withdrawal
+     * @returns {Promise<AoMessageResult>} The result of the withdrawal
+     */
+    async instantWithdrawal(params, options) {
         const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Instant-Withdrawal' },
+            { name: 'Vault-Id', value: params.vaultId },
+            { name: 'Address', value: params.gatewayAddress },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({
             signer: this.signer,
-            tags: [
-                ...tags,
-                { name: 'Action', value: 'Decrease-Delegate-Stake' },
-                { name: 'Target', value: params.target },
-                { name: 'Vault-Id', value: params.vaultId },
-            ],
+            tags: prunedTags,
         });
     }
     async increaseOperatorStake(params, options) {
@@ -638,6 +648,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({
@@ -676,8 +714,8 @@ export class IOWriteable extends IOReadable {
         const allTags = [
             ...tags,
             { name: 'Action', value: 'Cancel-Withdrawal' },
-            { name: 'Address', value: params.address },
             { name: 'Vault-Id', value: params.vaultId },
+            { name: 'Address', value: params.gatewayAddress },
         ];
         const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.send({

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

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

@@ -138,8 +138,16 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
         decreaseQty: number | mIOToken;
         instant?: boolean;
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    instantDelegateWithdrawal(params: {
-        target: string;
+    /**
+     * Initiates an instant withdrawal from a gateway.
+     *
+     * @param {Object} params - The parameters for initiating an instant withdrawal
+     * @param {string} params.address - The gateway address of the withdrawal, if not provided, the signer's address will be used
+     * @param {string} params.vaultId - The vault ID of the withdrawal
+     * @returns {Promise<AoMessageResult>} The result of the withdrawal
+     */
+    instantWithdrawal(params: {
+        gatewayAddress?: string;
         vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     increaseOperatorStake(params: {
@@ -158,6 +166,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;
@@ -176,7 +204,7 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
      * @returns {Promise<AoMessageResult>} The result of the cancellation
      */
     cancelWithdrawal(params: {
-        address?: WalletAddress;
+        gatewayAddress?: WalletAddress;
         vaultId: string;
     }, options?: WriteOptions | undefined): Promise<AoMessageResult>;
     submitAuctionBid(params: {

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

@@ -303,8 +303,8 @@ export interface AoIOWrite extends AoIORead {
         decreaseQty: number | mIOToken;
         instant?: boolean;
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    instantDelegateWithdrawal(params: {
-        target: WalletAddress;
+    instantWithdrawal(params: {
+        gatewayAddress?: WalletAddress;
         vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     saveObservations(params: {
@@ -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;
@@ -326,7 +329,7 @@ export interface AoIOWrite extends AoIORead {
         increaseCount: number;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     cancelWithdrawal(params: {
-        address?: WalletAddress;
+        gatewayAddress?: WalletAddress;
         vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     submitAuctionBid(params: {

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

package/package.json

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