Make gasLimit mandatory when creating a world

Author: lcswillems

xsuite/src/data/TupleDecoder.ts

@@ -1,3 +1,4 @@
+import { Prettify } from "../helpers";
 import { ByteReader } from "./ByteReader";
 import { AbstractDecoder, Decoder } from "./Decoder";
 
@@ -25,8 +26,6 @@ export class TupleDecoder<T extends DecoderMap<any>> extends AbstractDecoder<
 
 export type DecoderMap<T> = Record<string, Decoder<T>>;
 
-type DecoderMapToValueMap<T> = {
+type DecoderMapToValueMap<T> = Prettify<{
   [K in keyof T]: T[K] extends Decoder<infer U> ? U : never;
-} & {
-  // Pretiffy type: https://twitter.com/mattpocockuk/status/1622730173446557697
-};
+}>;

xsuite/src/helpers.ts

@@ -0,0 +1,5 @@
+// Pretiffy type: https://twitter.com/mattpocockuk/status/1622730173446557697
+// eslint-disable-next-line @typescript-eslint/ban-types
+export type Prettify<T> = { [K in keyof T]: T[K] } & {};
+
+export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

xsuite/src/proxy/proxy.ts

@@ -241,7 +241,7 @@ export class Tx {
       value: (params.value ?? 0n).toString(),
       receiver: params.receiver.toString(),
       sender: params.sender.toString(),
-      gasPrice: params.gasPrice ?? 0,
+      gasPrice: params.gasPrice,
       gasLimit: params.gasLimit,
       data: params.data === undefined ? undefined : btoa(params.data),
       chainID: params.chainId,
@@ -469,7 +469,7 @@ export type TxParams = {
   value?: number | bigint;
   receiver: Address;
   sender: Address;
-  gasPrice?: number;
+  gasPrice: number;
   gasLimit: number;
   data?: string;
   chainId: string;
@@ -480,7 +480,7 @@ export type DeployContractTxParams = {
   nonce: number;
   value?: number | bigint;
   sender: Address;
-  gasPrice?: number;
+  gasPrice: number;
   gasLimit: number;
   code: string;
   codeMetadata: CodeMetadata;
@@ -498,7 +498,7 @@ export type UpgradeContractTxParams = {
   value?: number | bigint;
   callee: Address;
   sender: Address;
-  gasPrice?: number;
+  gasPrice: number;
   gasLimit: number;
   code: string;
   codeMetadata: CodeMetadata;
@@ -512,7 +512,7 @@ export type TransferTxParams = {
   value?: number | bigint;
   receiver: Address;
   sender: Address;
-  gasPrice?: number;
+  gasPrice: number;
   gasLimit: number;
   esdts?: { id: string; nonce?: number; amount: number | bigint }[];
   chainId: string;
@@ -524,7 +524,7 @@ export type CallContractTxParams = {
   value?: number | bigint;
   callee: Address;
   sender: Address;
-  gasPrice?: number;
+  gasPrice: number;
   gasLimit: number;
   funcName: string;
   funcArgs?: Hex[];

xsuite/src/world/sworld.ts

@@ -1,10 +1,16 @@
+import { Prettify } from "../helpers";
 import { SProxy } from "../proxy";
-import { DeployContractTxParams } from "../proxy/proxy";
 import { Account, Block } from "../proxy/sproxy";
 import { DummySigner, Signer } from "./signer";
 import { startSimulnet } from "./simulnet";
 import { isContractAddress, numberToBytesAddress } from "./utils";
-import { World, Contract, Wallet, expandCode } from "./world";
+import {
+  World,
+  Contract,
+  Wallet,
+  expandCode,
+  WorldDeployContractParams,
+} from "./world";
 
 let walletCounter = 0;
 let contractCounter = 0;
@@ -13,7 +19,7 @@ export class SWorld extends World {
   proxy: SProxy;
   sysAcc: SContract;
 
-  constructor({ proxy, gasPrice }: { proxy: SProxy; gasPrice?: number }) {
+  constructor({ proxy, gasPrice }: { proxy: SProxy; gasPrice: number }) {
     super({ proxy, chainId: "S", gasPrice });
     this.proxy = proxy;
     this.sysAcc = new SContract({
@@ -23,7 +29,7 @@ export class SWorld extends World {
   }
 
   static new({ proxyUrl, gasPrice }: { proxyUrl: string; gasPrice?: number }) {
-    return new SWorld({ proxy: new SProxy(proxyUrl), gasPrice });
+    return new SWorld({ proxy: new SProxy(proxyUrl), gasPrice: gasPrice ?? 0 });
   }
 
   static async start({
@@ -46,7 +52,7 @@ export class SWorld extends World {
     return new SContract({ address, proxy: this.proxy });
   }
 
-  async createWallet(account: Omit<Account, "address"> = {}) {
+  async createWallet(account: SWorldCreateWalletAccount = {}) {
     walletCounter += 1;
     const address = numberToBytesAddress(walletCounter, false);
     const wallet = new SWallet({
@@ -59,7 +65,7 @@ export class SWorld extends World {
     return wallet;
   }
 
-  createContract(account: Omit<Account, "address"> = {}) {
+  createContract(account: SWorldCreateContractAccount = {}) {
     return createContract(this.proxy, account);
   }
 
@@ -84,24 +90,22 @@ export class SWallet extends Wallet {
     signer: Signer;
     proxy: SProxy;
     chainId: string;
-    gasPrice?: number;
+    gasPrice: number;
   }) {
     super({ signer, proxy, chainId, gasPrice });
     this.proxy = proxy;
   }
 
-  setAccount(account: Omit<Account, "address">) {
+  setAccount(account: SWalletSetAccountAccount) {
     return setAccount(this.proxy, { address: this, ...account });
   }
 
-  createContract(account: Omit<Account, "address" | "owner">) {
+  createContract(account: SWalletCreateContractAccount = {}) {
     return createContract(this.proxy, { ...account, owner: this });
   }
 
-  deployContract(
-    txParams: Omit<DeployContractTxParams, "sender" | "nonce" | "chainId">,
-  ) {
-    return super.deployContract(txParams).then((data) => ({
+  deployContract(params: WorldDeployContractParams) {
+    return super.deployContract(params).then((data) => ({
       ...data,
       contract: new SContract({
         address: data.address,
@@ -125,7 +129,7 @@ export class SContract extends Contract {
     this.proxy = proxy;
   }
 
-  setAccount(account: Omit<Account, "address">) {
+  setAccount(account: SContractSetAccountAccount) {
     return setAccount(this.proxy, { address: this, ...account });
   }
 }
@@ -151,3 +155,15 @@ const createContract = async (
   await contract.setAccount(account);
   return contract;
 };
+
+type SWorldCreateWalletAccount = Prettify<Omit<Account, "address">>;
+
+type SWorldCreateContractAccount = Prettify<Omit<Account, "address">>;
+
+type SWalletSetAccountAccount = Prettify<Omit<Account, "address">>;
+
+type SWalletCreateContractAccount = Prettify<
+  Omit<Account, "address" | "owner">
+>;
+
+type SContractSetAccountAccount = Omit<Account, "address">;

xsuite/src/world/world.test.ts

@@ -6,7 +6,7 @@ import { World } from "./world";
 
 test("World.new, World.newWallet, World.newContract", async () => {
   const proxyUrl = await startSimulnet();
-  const world = World.new({ proxyUrl, chainId: "S" });
+  const world = World.new({ proxyUrl, chainId: "S", gasPrice: 0 });
   const wallet = world.newWallet(new DummySigner(new Uint8Array(32)));
   const contract = world.newContract(new Uint8Array(32));
   expect(wallet.toTopBytes()).toEqual(new Uint8Array(32));