Merge pull request #49 from arda-org/new-default-values

Default options for new methods

Author: lcswillems

contracts/blank/interact/index.ts

@@ -4,9 +4,6 @@ import data from "./data.json";
 
 const world = World.new({
   chainId: envChain.id(),
-  proxyUrl: envChain.publicProxyUrl(),
-  gasPrice: 1_000_000_000,
-  explorerUrl: envChain.explorerUrl(),
 });
 
 const loadWallet = () => world.newWalletFromFile("wallet.json");

contracts/vested-transfers/interact/index.ts

@@ -4,8 +4,6 @@ import data from "./data.json";
 
 const world = World.new({
   chainId: envChain.id(),
-  proxyUrl: envChain.publicProxyUrl(),
-  gasPrice: 1_000_000_000,
 });
 
 const loadWallet = () => world.newWalletFromFile("wallet.json");
@@ -19,7 +17,8 @@ program.command("deploy").action(async () => {
     codeMetadata: ["upgradeable"],
     gasLimit: 100_000_000,
   });
-  console.log("Result:", result);
+  console.log("Transaction:", result.tx.explorerUrl);
+  console.log("Contract:", result.contract.explorerUrl);
 });
 
 program.command("upgrade").action(async () => {
@@ -30,7 +29,7 @@ program.command("upgrade").action(async () => {
     codeMetadata: ["upgradeable"],
     gasLimit: 100_000_000,
   });
-  console.log("Result:", result);
+  console.log("Transaction:", result.tx.explorerUrl);
 });
 
 program.command("ClaimDeveloperRewards").action(async () => {
@@ -40,7 +39,7 @@ program.command("ClaimDeveloperRewards").action(async () => {
     funcName: "ClaimDeveloperRewards",
     gasLimit: 10_000_000,
   });
-  console.log("Result:", result);
+  console.log("Transaction:", result.tx.explorerUrl);
 });
 
 program.parse(process.argv);

xsuite/src/interact/envChain.ts

@@ -1,11 +1,15 @@
-export const devnetId = "D";
-export const testnetId = "T";
-export const mainnetId = "1";
+export const devnetChainId = "D";
+export const testnetChainId = "T";
+export const mainnetChainId = "1";
 
 export const devnetPublicProxyUrl = "https://devnet-gateway.multiversx.com";
 export const testnetPublicProxyUrl = "https://testnet-gateway.multiversx.com";
 export const mainnetPublicProxyUrl = "https://gateway.multiversx.com";
 
+export const devnetMinGasPrice = 1_000_000_000;
+export const testnetMinGasPrice = 1_000_000_000;
+export const mainnetMinGasPrice = 1_000_000_000;
+
 export const devnetExplorerUrl = "https://devnet-explorer.multiversx.com";
 export const testnetExplorerUrl = "https://testnet-explorer.multiversx.com";
 export const mainnetExplorerUrl = "https://mainnet-explorer.multiversx.com";
@@ -30,22 +34,28 @@ export const envChain = {
   },
   id: () =>
     envChain.select({
-      devnet: devnetId,
-      testnet: testnetId,
-      mainnet: mainnetId,
-    }),
+      devnet: devnetChainId,
+      testnet: testnetChainId,
+      mainnet: mainnetChainId,
+    } as const),
   publicProxyUrl: () =>
     envChain.select({
       devnet: devnetPublicProxyUrl,
       testnet: testnetPublicProxyUrl,
       mainnet: mainnetPublicProxyUrl,
-    }),
+    } as const),
+  minGasPrice: () =>
+    envChain.select({
+      devnet: devnetMinGasPrice,
+      testnet: testnetMinGasPrice,
+      mainnet: mainnetMinGasPrice,
+    } as const),
   explorerUrl: () =>
     envChain.select({
       devnet: devnetExplorerUrl,
       testnet: testnetExplorerUrl,
       mainnet: mainnetExplorerUrl,
-    }),
+    } as const),
 };
 
 const isChainName = (chain: any): chain is ChainName => {

xsuite/src/world/sworld.test.ts

@@ -93,6 +93,24 @@ test("SWorld.proxy.getAccountWithKvs on empty bytes address", async () => {
   );
 });
 
+test("SWorld.new with defined chainId", () => {
+  expect(() => SWorld.new({ chainId: "D" })).toThrow(
+    "chainId is not undefined.",
+  );
+});
+
+test("SWorld.newDevnet", () => {
+  expect(() => SWorld.newDevnet()).toThrow("newDevnet is not implemented.");
+});
+
+test("SWorld.newTestnet", () => {
+  expect(() => SWorld.newTestnet()).toThrow("newTestnet is not implemented.");
+});
+
+test("SWorld.newMainnet", () => {
+  expect(() => SWorld.newMainnet()).toThrow("newMainnet is not implemented.");
+});
+
 test("SWorld.createWallet", async () => {
   const wallet = await world.createWallet();
   expect(wallet.explorerUrl).toEqual(`${explorerUrl}/accounts/${wallet}`);

xsuite/src/world/sworld.ts

@@ -10,6 +10,7 @@ import {
   Wallet,
   expandCode,
   WorldDeployContractParams,
+  WorldNewOptions,
 } from "./world";
 
 let walletCounter = 0;
@@ -28,27 +29,34 @@ export class SWorld extends World {
     gasPrice: number;
     explorerUrl?: string;
   }) {
-    super({ proxy, chainId: "S", gasPrice, explorerUrl });
+    super({ chainId: "S", proxy, gasPrice, explorerUrl });
     this.proxy = proxy;
     this.sysAcc = this.newContract(new Uint8Array(32).fill(255));
   }
 
-  static new({
-    proxyUrl,
-    gasPrice,
-    explorerUrl,
-  }: {
-    proxyUrl: string;
-    gasPrice?: number;
-    explorerUrl?: string;
-  }) {
+  static new(options: SWorldNewOptions) {
+    if (options.chainId !== undefined) {
+      throw new Error("chainId is not undefined.");
+    }
     return new SWorld({
-      proxy: new SProxy(proxyUrl),
-      gasPrice: gasPrice ?? 0,
-      explorerUrl,
+      proxy: new SProxy(options.proxyUrl),
+      gasPrice: options.gasPrice ?? 0,
+      explorerUrl: options.explorerUrl,
     });
   }
 
+  static newDevnet(): World {
+    throw new Error("newDevnet is not implemented.");
+  }
+
+  static newTestnet(): World {
+    throw new Error("newTestnet is not implemented.");
+  }
+
+  static newMainnet(): World {
+    throw new Error("newMainnet is not implemented.");
+  }
+
   static async start({
     gasPrice,
     explorerUrl,
@@ -184,6 +192,15 @@ const createContract = async (
   return contract;
 };
 
+type SWorldNewOptions =
+  | {
+      chainId?: undefined;
+      proxyUrl: string;
+      gasPrice?: number;
+      explorerUrl?: string;
+    }
+  | WorldNewOptions;
+
 type SWorldCreateWalletAccount = Prettify<Omit<Account, "address">>;
 
 type SWorldCreateContractAccount = Prettify<Omit<Account, "address">>;

xsuite/src/world/world.ts

@@ -1,6 +1,20 @@
 import { AddressEncodable } from "../data/AddressEncodable";
 import { b64ToHexString } from "../data/utils";
 import { Optional, Prettify } from "../helpers";
+import {
+  devnetMinGasPrice,
+  devnetExplorerUrl,
+  devnetPublicProxyUrl,
+  mainnetMinGasPrice,
+  mainnetChainId,
+  mainnetExplorerUrl,
+  mainnetPublicProxyUrl,
+  testnetMinGasPrice,
+  testnetExplorerUrl,
+  testnetPublicProxyUrl,
+  devnetChainId,
+  testnetChainId,
+} from "../interact/envChain";
 import {
   CallContractTxParams,
   DeployContractTxParams,
@@ -37,17 +51,26 @@ export class World {
     this.explorerUrl = explorerUrl;
   }
 
-  static new({
-    chainId,
-    proxyUrl,
-    gasPrice,
-    explorerUrl,
-  }: {
-    chainId: string;
-    proxyUrl: string;
-    gasPrice: number;
-    explorerUrl?: string;
-  }) {
+  static new({ chainId, proxyUrl, gasPrice, explorerUrl }: WorldNewOptions) {
+    if (chainId === "D") {
+      proxyUrl ??= devnetPublicProxyUrl;
+      gasPrice ??= devnetMinGasPrice;
+      explorerUrl ??= devnetExplorerUrl;
+    } else if (chainId === "T") {
+      proxyUrl ??= testnetPublicProxyUrl;
+      gasPrice ??= testnetMinGasPrice;
+      explorerUrl ??= testnetExplorerUrl;
+    } else if (chainId === "1") {
+      proxyUrl ??= mainnetPublicProxyUrl;
+      gasPrice ??= mainnetMinGasPrice;
+      explorerUrl ??= mainnetExplorerUrl;
+    }
+    if (proxyUrl === undefined) {
+      throw new Error("proxyUrl is not defined.");
+    }
+    if (gasPrice === undefined) {
+      throw new Error("gasPrice is not defined.");
+    }
     return new World({
       chainId,
       proxy: new Proxy(proxyUrl),
@@ -56,6 +79,18 @@ export class World {
     });
   }
 
+  static newDevnet(options: WorldNewRealnetOptions = {}) {
+    return World.new({ chainId: devnetChainId, ...options });
+  }
+
+  static newTestnet(options: WorldNewRealnetOptions = {}) {
+    return World.new({ chainId: testnetChainId, ...options });
+  }
+
+  static newMainnet(options: WorldNewRealnetOptions = {}) {
+    return World.new({ chainId: mainnetChainId, ...options });
+  }
+
   newWallet(signer: Signer) {
     return new Wallet({
       signer,
@@ -431,6 +466,24 @@ export const expandCode = (code: string) => {
   return code;
 };
 
+export type WorldNewOptions = Prettify<
+  | ({
+      chainId: "D" | "T" | "1";
+    } & WorldNewRealnetOptions)
+  | {
+      chainId: string;
+      proxyUrl: string;
+      gasPrice: number;
+      explorerUrl?: string;
+    }
+>;
+
+type WorldNewRealnetOptions = {
+  proxyUrl?: string;
+  gasPrice?: number;
+  explorerUrl?: string;
+};
+
 type WorldExecuteTxParams = Prettify<
   Optional<Omit<TxParams, "sender" | "nonce" | "chainId">, "gasPrice">
 >;