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

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

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { AOProcess } from '../common/index.js';
-import { AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
+import { AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoWriteAction, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
 import { mARIOToken } from './token.js';
 type NestedKeys<T> = T extends object ? T extends readonly unknown[] ? never : {
     [K in keyof T & string]: T[K] extends object ? `${K}.${NestedKeys<T[K]>}` : K;
@@ -345,6 +345,18 @@ export type AoRevokeVaultParams = {
     vaultId: TransactionId;
     recipient: WalletAddress;
 };
+export type AoCreateVaultParams = {
+    quantity: mARIOToken | number;
+    lockLengthMs: number;
+};
+export type AoExtendVaultParams = {
+    vaultId: string;
+    extendLengthMs: number;
+};
+export type AoIncreaseVaultParams = {
+    vaultId: string;
+    quantity: mARIOToken | number;
+};
 export type AoGatewayRegistrySettings = {
     delegates: {
         minStake: number;
@@ -445,49 +457,49 @@ export interface AoARIORead {
     getAllGatewayVaults(params?: PaginationParams<AoAllGatewayVaults>): Promise<PaginationResult<AoAllGatewayVaults>>;
 }
 export interface AoARIOWrite extends AoARIORead {
-    transfer({ target, qty, }: {
+    transfer: AoWriteAction<{
         target: WalletAddress;
-        qty: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    vaultedTransfer({ recipient, quantity, lockLengthMs, revokable }: AoVaultedTransferParams, options?: WriteOptions): Promise<AoMessageResult>;
-    revokeVault({ vaultId, recipient }: AoRevokeVaultParams, options?: WriteOptions): Promise<AoMessageResult>;
-    joinNetwork(params: AoJoinNetworkParams, options?: WriteOptions): Promise<AoMessageResult>;
-    leaveNetwork(options?: WriteOptions): Promise<AoMessageResult>;
-    updateGatewaySettings(params: AoUpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;
-    increaseOperatorStake(params: {
+        qty: number | mARIOToken;
+    }>;
+    vaultedTransfer: AoWriteAction<AoVaultedTransferParams>;
+    revokeVault: AoWriteAction<AoRevokeVaultParams>;
+    createVault: AoWriteAction<AoCreateVaultParams>;
+    extendVault: AoWriteAction<AoExtendVaultParams>;
+    increaseVault: AoWriteAction<AoIncreaseVaultParams>;
+    joinNetwork: AoWriteAction<AoJoinNetworkParams>;
+    leaveNetwork: (options?: WriteOptions) => Promise<AoMessageResult>;
+    updateGatewaySettings: AoWriteAction<AoUpdateGatewaySettingsParams>;
+    increaseOperatorStake: AoWriteAction<{
         increaseQty: number | mARIOToken;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    decreaseOperatorStake(params: {
+    }>;
+    decreaseOperatorStake: AoWriteAction<{
         decreaseQty: number | mARIOToken;
         instant?: boolean;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    delegateStake(params: {
-        target: WalletAddress;
-        stakeQty: number | mARIOToken;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    decreaseDelegateStake(params: {
+    }>;
+    delegateStake: AoWriteAction<AoDelegateStakeParams>;
+    decreaseDelegateStake: AoWriteAction<{
         target: WalletAddress;
         decreaseQty: number | mARIOToken;
         instant?: boolean;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    instantWithdrawal(params: {
+    }>;
+    instantWithdrawal: AoWriteAction<{
         gatewayAddress?: WalletAddress;
         vaultId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    saveObservations(params: {
+    }>;
+    saveObservations: AoWriteAction<{
         reportTxId: TransactionId;
         failedGateways: WalletAddress[];
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    buyRecord(params: AoBuyRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
-    upgradeRecord(params: AoArNSPurchaseParams, options?: WriteOptions): Promise<AoMessageResult>;
-    extendLease(params: AoExtendLeaseParams, options?: WriteOptions): Promise<AoMessageResult>;
-    increaseUndernameLimit(params: AoIncreaseUndernameLimitParams, options?: WriteOptions): Promise<AoMessageResult>;
-    cancelWithdrawal(params: {
+    }>;
+    buyRecord: AoWriteAction<AoBuyRecordParams>;
+    upgradeRecord: AoWriteAction<AoArNSPurchaseParams>;
+    extendLease: AoWriteAction<AoExtendLeaseParams>;
+    increaseUndernameLimit: AoWriteAction<AoIncreaseUndernameLimitParams>;
+    cancelWithdrawal: AoWriteAction<{
         gatewayAddress?: WalletAddress;
         vaultId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    requestPrimaryName(params: AoArNSPurchaseParams, options?: WriteOptions): Promise<AoMessageResult>;
-    redelegateStake(params: AoRedelegateStakeParams, options?: WriteOptions): Promise<AoMessageResult>;
+    }>;
+    requestPrimaryName: AoWriteAction<AoArNSPurchaseParams>;
+    redelegateStake: AoWriteAction<AoRedelegateStakeParams>;
 }
 export declare function isProcessConfiguration(config: object): config is Required<ProcessConfiguration> & Record<string, never>;
 export declare function isProcessIdConfiguration(config: object): config is Required<ProcessIdConfig> & Record<string, never>;

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

package/package.json

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