@argonprotocol/testing 1.4.11 → 1.4.12-dev.2afa6e4a

package/lib/index.d.cts

@@ -1,5 +1,5 @@
 import * as _argonprotocol_mainchain from '@argonprotocol/mainchain';
-import { KeyringPair, ArgonClient, EthereumReceipt, EthereumBeaconHeaderDetailsResponse, EthereumBeaconBlockResponse, EvmContracts, IArgonQueryable } from '@argonprotocol/mainchain';
+import { KeyringPair, ArgonClient, GenericEvent, SubmittableExtrinsic, EthereumReceipt, EthereumBeaconHeaderDetailsResponse, EthereumBeaconBlockResponse, EvmContracts, IArgonQueryable } from '@argonprotocol/mainchain';
 import { Client } from 'pg';
 import * as viem from 'viem';
 import { Hex, createWalletClient, defineChain, Address, ContractFunctionArgs } from 'viem';
@@ -189,6 +189,14 @@ declare function startNetwork(testName: string, options?: {
     notaryUrl: string;
 }>;
 
+type TestTxResult = {
+    blockHash: string;
+    events: GenericEvent[];
+    finalFee?: bigint;
+};
+/** Sign a test transaction and resolve once it is included successfully in a block. */
+declare function submitTx(client: ArgonClient, tx: SubmittableExtrinsic, signer: KeyringPair): Promise<TestTxResult>;
+
 declare function signGatewayPermit(args: {
     account: ReturnType<typeof privateKeyToAccount>;
     chainId: number;
@@ -291,20 +299,20 @@ declare class EthereumProofE2eHarness {
         };
         proofRelayerUri: string;
     }): Promise<EthereumProofE2eHarness>;
-    submit(tx: unknown, signer: KeyringPair): Promise<_argonprotocol_mainchain.TxResult>;
-    sudoSubmit(tx: unknown): Promise<_argonprotocol_mainchain.TxResult>;
+    submit(tx: SubmittableExtrinsic, signer: KeyringPair): Promise<TestTxResult>;
+    sudoSubmit(tx: SubmittableExtrinsic): Promise<TestTxResult>;
     syncVerifierThrough(minimumExecutionBlockNumber: bigint): Promise<void>;
     proveGatewayActivity(gatewayAddress: Hex, throughExecutionBlockNumber: bigint): Promise<{
         payload: _argonprotocol_mainchain.EthereumGatewayActivityProofPayload;
-        result: _argonprotocol_mainchain.TxResult;
+        result: TestTxResult;
     }>;
     configureEthereumRuntime(gateway: TestMintingGateway, mode: RuntimeSetupMode): Promise<{
-        result: _argonprotocol_mainchain.TxResult;
+        result: TestTxResult;
     }>;
-    fundBurnAccount(amount: bigint): Promise<_argonprotocol_mainchain.TxResult>;
-    fundProofRelayer(amount?: bigint): Promise<_argonprotocol_mainchain.TxResult>;
-    forceSetBalance(address: string, amount: bigint): Promise<_argonprotocol_mainchain.TxResult>;
-    forceSetOwnership(address: string, amount: bigint): Promise<_argonprotocol_mainchain.TxResult>;
+    fundBurnAccount(amount: bigint): Promise<TestTxResult>;
+    fundProofRelayer(amount?: bigint): Promise<TestTxResult>;
+    forceSetBalance(address: string, amount: bigint): Promise<TestTxResult>;
+    forceSetOwnership(address: string, amount: bigint): Promise<TestTxResult>;
     waitForExecutionFinalizedAfter(minimumExecutionBlockNumber: bigint): Promise<viem.TransactionReceipt>;
 }
 declare class TestMintingGateway {
@@ -375,9 +383,9 @@ declare class TestMintingAuthorityActor {
         freeBalance: bigint;
         ownershipBalance: bigint;
         committedArgonots: bigint;
-        bitcoinXpub: string;
+        bitcoinXpubBytesHex: string;
     }): Promise<void>;
-    registerCouncilSigner(): Promise<_argonprotocol_mainchain.TxResult>;
+    registerCouncilSigner(): Promise<TestTxResult>;
     forceSingleMemberCouncil(): Promise<{
         activeCouncilHash: `0x${string}`;
         activeCouncil: _argonprotocol_mainchain.PalletCrosschainTransferGlobalIssuanceCouncil;
@@ -386,7 +394,7 @@ declare class TestMintingAuthorityActor {
             weights: bigint[];
         };
     }>;
-    registerMintingAuthority(micronotCollateral: bigint): Promise<_argonprotocol_mainchain.TxResult>;
+    registerMintingAuthority(micronotCollateral: bigint): Promise<TestTxResult>;
     approveActivationQueueEntry(queueNonce?: bigint): Promise<{
         approvalQueueEntry: _polkadot_types_codec.Option<_argonprotocol_mainchain.PalletCrosschainTransferCouncilApprovalQueueEntry>;
         councilApprovalSignature: `0x${string}`;
@@ -408,7 +416,7 @@ declare class TestMintingAuthorityActor {
         };
         micronotCollateral: bigint;
         collateralizationSignature: `0x${string}`;
-        result: _argonprotocol_mainchain.TxResult;
+        result: TestTxResult;
     }>;
     private registrationMessage;
     private requireGateway;
@@ -418,4 +426,4 @@ declare function stringifyExt(obj: any): any;
 declare function sudo(): KeyringPair;
 declare function activateNotary(sudo: KeyringPair, client: ArgonClient, notary: TestNotary): Promise<void>;
 
-export { type EthereumGatewayUpdateBatch, EthereumProofE2eHarness, type ITeardownable, SKIP_E2E, TestEthereum, TestMainchain, TestMintingAuthorityActor, TestMintingGateway, TestNotary, TestOracle, activateNotary, addTeardown, cleanHostForDocker, closeOnTeardown, disconnectOnTeardown, getDockerPortMapping, getProxy, getReadyEthereumGatewayUpdates, mineLaterExecutionAnchorReceipt, projectRoot, runOnTeardown, runTestScript, signGatewayPermit, startNetwork, stringifyExt, sudo, syncEthereumVerifierUntilAnchorCovers, teardown, toArgonKeccakSignature, toEvmRecoverableSignature, waitForExecutionReceipt, waitForFinalizedBeaconExecutionAtOrAbove };
+export { type EthereumGatewayUpdateBatch, EthereumProofE2eHarness, type ITeardownable, SKIP_E2E, TestEthereum, TestMainchain, TestMintingAuthorityActor, TestMintingGateway, TestNotary, TestOracle, type TestTxResult, activateNotary, addTeardown, cleanHostForDocker, closeOnTeardown, disconnectOnTeardown, getDockerPortMapping, getProxy, getReadyEthereumGatewayUpdates, mineLaterExecutionAnchorReceipt, projectRoot, runOnTeardown, runTestScript, signGatewayPermit, startNetwork, stringifyExt, submitTx, sudo, syncEthereumVerifierUntilAnchorCovers, teardown, toArgonKeccakSignature, toEvmRecoverableSignature, waitForExecutionReceipt, waitForFinalizedBeaconExecutionAtOrAbove };

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 import * as _argonprotocol_mainchain from '@argonprotocol/mainchain';
-import { KeyringPair, ArgonClient, EthereumReceipt, EthereumBeaconHeaderDetailsResponse, EthereumBeaconBlockResponse, EvmContracts, IArgonQueryable } from '@argonprotocol/mainchain';
+import { KeyringPair, ArgonClient, GenericEvent, SubmittableExtrinsic, EthereumReceipt, EthereumBeaconHeaderDetailsResponse, EthereumBeaconBlockResponse, EvmContracts, IArgonQueryable } from '@argonprotocol/mainchain';
 import { Client } from 'pg';
 import * as viem from 'viem';
 import { Hex, createWalletClient, defineChain, Address, ContractFunctionArgs } from 'viem';
@@ -189,6 +189,14 @@ declare function startNetwork(testName: string, options?: {
     notaryUrl: string;
 }>;
 
+type TestTxResult = {
+    blockHash: string;
+    events: GenericEvent[];
+    finalFee?: bigint;
+};
+/** Sign a test transaction and resolve once it is included successfully in a block. */
+declare function submitTx(client: ArgonClient, tx: SubmittableExtrinsic, signer: KeyringPair): Promise<TestTxResult>;
+
 declare function signGatewayPermit(args: {
     account: ReturnType<typeof privateKeyToAccount>;
     chainId: number;
@@ -291,20 +299,20 @@ declare class EthereumProofE2eHarness {
         };
         proofRelayerUri: string;
     }): Promise<EthereumProofE2eHarness>;
-    submit(tx: unknown, signer: KeyringPair): Promise<_argonprotocol_mainchain.TxResult>;
-    sudoSubmit(tx: unknown): Promise<_argonprotocol_mainchain.TxResult>;
+    submit(tx: SubmittableExtrinsic, signer: KeyringPair): Promise<TestTxResult>;
+    sudoSubmit(tx: SubmittableExtrinsic): Promise<TestTxResult>;
     syncVerifierThrough(minimumExecutionBlockNumber: bigint): Promise<void>;
     proveGatewayActivity(gatewayAddress: Hex, throughExecutionBlockNumber: bigint): Promise<{
         payload: _argonprotocol_mainchain.EthereumGatewayActivityProofPayload;
-        result: _argonprotocol_mainchain.TxResult;
+        result: TestTxResult;
     }>;
     configureEthereumRuntime(gateway: TestMintingGateway, mode: RuntimeSetupMode): Promise<{
-        result: _argonprotocol_mainchain.TxResult;
+        result: TestTxResult;
     }>;
-    fundBurnAccount(amount: bigint): Promise<_argonprotocol_mainchain.TxResult>;
-    fundProofRelayer(amount?: bigint): Promise<_argonprotocol_mainchain.TxResult>;
-    forceSetBalance(address: string, amount: bigint): Promise<_argonprotocol_mainchain.TxResult>;
-    forceSetOwnership(address: string, amount: bigint): Promise<_argonprotocol_mainchain.TxResult>;
+    fundBurnAccount(amount: bigint): Promise<TestTxResult>;
+    fundProofRelayer(amount?: bigint): Promise<TestTxResult>;
+    forceSetBalance(address: string, amount: bigint): Promise<TestTxResult>;
+    forceSetOwnership(address: string, amount: bigint): Promise<TestTxResult>;
     waitForExecutionFinalizedAfter(minimumExecutionBlockNumber: bigint): Promise<viem.TransactionReceipt>;
 }
 declare class TestMintingGateway {
@@ -375,9 +383,9 @@ declare class TestMintingAuthorityActor {
         freeBalance: bigint;
         ownershipBalance: bigint;
         committedArgonots: bigint;
-        bitcoinXpub: string;
+        bitcoinXpubBytesHex: string;
     }): Promise<void>;
-    registerCouncilSigner(): Promise<_argonprotocol_mainchain.TxResult>;
+    registerCouncilSigner(): Promise<TestTxResult>;
     forceSingleMemberCouncil(): Promise<{
         activeCouncilHash: `0x${string}`;
         activeCouncil: _argonprotocol_mainchain.PalletCrosschainTransferGlobalIssuanceCouncil;
@@ -386,7 +394,7 @@ declare class TestMintingAuthorityActor {
             weights: bigint[];
         };
     }>;
-    registerMintingAuthority(micronotCollateral: bigint): Promise<_argonprotocol_mainchain.TxResult>;
+    registerMintingAuthority(micronotCollateral: bigint): Promise<TestTxResult>;
     approveActivationQueueEntry(queueNonce?: bigint): Promise<{
         approvalQueueEntry: _polkadot_types_codec.Option<_argonprotocol_mainchain.PalletCrosschainTransferCouncilApprovalQueueEntry>;
         councilApprovalSignature: `0x${string}`;
@@ -408,7 +416,7 @@ declare class TestMintingAuthorityActor {
         };
         micronotCollateral: bigint;
         collateralizationSignature: `0x${string}`;
-        result: _argonprotocol_mainchain.TxResult;
+        result: TestTxResult;
     }>;
     private registrationMessage;
     private requireGateway;
@@ -418,4 +426,4 @@ declare function stringifyExt(obj: any): any;
 declare function sudo(): KeyringPair;
 declare function activateNotary(sudo: KeyringPair, client: ArgonClient, notary: TestNotary): Promise<void>;
 
-export { type EthereumGatewayUpdateBatch, EthereumProofE2eHarness, type ITeardownable, SKIP_E2E, TestEthereum, TestMainchain, TestMintingAuthorityActor, TestMintingGateway, TestNotary, TestOracle, activateNotary, addTeardown, cleanHostForDocker, closeOnTeardown, disconnectOnTeardown, getDockerPortMapping, getProxy, getReadyEthereumGatewayUpdates, mineLaterExecutionAnchorReceipt, projectRoot, runOnTeardown, runTestScript, signGatewayPermit, startNetwork, stringifyExt, sudo, syncEthereumVerifierUntilAnchorCovers, teardown, toArgonKeccakSignature, toEvmRecoverableSignature, waitForExecutionReceipt, waitForFinalizedBeaconExecutionAtOrAbove };
+export { type EthereumGatewayUpdateBatch, EthereumProofE2eHarness, type ITeardownable, SKIP_E2E, TestEthereum, TestMainchain, TestMintingAuthorityActor, TestMintingGateway, TestNotary, TestOracle, type TestTxResult, activateNotary, addTeardown, cleanHostForDocker, closeOnTeardown, disconnectOnTeardown, getDockerPortMapping, getProxy, getReadyEthereumGatewayUpdates, mineLaterExecutionAnchorReceipt, projectRoot, runOnTeardown, runTestScript, signGatewayPermit, startNetwork, stringifyExt, submitTx, sudo, syncEthereumVerifierUntilAnchorCovers, teardown, toArgonKeccakSignature, toEvmRecoverableSignature, waitForExecutionReceipt, waitForFinalizedBeaconExecutionAtOrAbove };

package/lib/index.js

@@ -6,13 +6,13 @@ var getDirname = () => path.dirname(getFilename());
 var __dirname = /* @__PURE__ */ getDirname();
 
 // src/index.ts
-import { Keyring as Keyring4, TxSubmitter as TxSubmitter4 } from "@argonprotocol/mainchain";
+import { Keyring as Keyring4 } from "@argonprotocol/mainchain";
 
 // src/TestNotary.ts
 import { customAlphabet } from "nanoid";
 import pg from "pg";
 import * as child_process2 from "child_process";
-import { Keyring, TxSubmitter } from "@argonprotocol/mainchain";
+import { Keyring } from "@argonprotocol/mainchain";
 import * as fs from "fs";
 import * as readline from "readline";
 
@@ -114,6 +114,50 @@ function disconnectOnTeardown(closeable) {
 // src/TestNotary.ts
 import * as process3 from "process";
 import * as Path2 from "path";
+
+// src/submitTx.ts
+import {
+  checkForExtrinsicSuccess
+} from "@argonprotocol/mainchain";
+function submitTx(client, tx, signer) {
+  return new Promise((resolve3, reject) => {
+    let unsubscribe;
+    let completed = false;
+    const finish = (callback) => {
+      completed = true;
+      unsubscribe?.();
+      callback();
+    };
+    tx.signAndSend(signer, (result) => {
+      if (completed) return;
+      if (result.status.isDropped || result.status.isInvalid || result.status.isUsurped) {
+        finish(() => reject(new Error(`Transaction ${result.status.type.toLowerCase()}`)));
+        return;
+      }
+      if (!result.status.isInBlock) return;
+      void checkForExtrinsicSuccess(result.events, client).then(
+        () => {
+          const feePaid = result.events.find(
+            ({ event }) => client.events.transactionPayment.TransactionFeePaid.is(event)
+          );
+          finish(
+            () => resolve3({
+              blockHash: result.status.asInBlock.toHex(),
+              events: result.events.map(({ event }) => event),
+              finalFee: feePaid && client.events.transactionPayment.TransactionFeePaid.is(feePaid.event) ? feePaid.event.data.actualFee.toBigInt() : void 0
+            })
+          );
+        },
+        (error) => finish(() => reject(error))
+      );
+    }).then((stop) => {
+      unsubscribe = stop;
+      if (completed) unsubscribe();
+    }).catch((error) => finish(() => reject(error)));
+  });
+}
+
+// src/TestNotary.ts
 var { Client: PgClient } = pg;
 var nanoid = customAlphabet("0123456789abcdefghijklmnopqrstuvwxyz", 4);
 function createUid() {
@@ -246,7 +290,7 @@ var TestNotary = class {
   }
   async register(client) {
     const address = new URL(this.address);
-    const result = await new TxSubmitter(
+    await submitTx(
       client,
       client.tx.notaries.propose({
         public: this.registeredPublicKey,
@@ -254,8 +298,7 @@ var TestNotary = class {
         name: "Test Notary"
       }),
       this.operator
-    ).submit();
-    await result.waitForInFirstBlock;
+    );
   }
   async teardown() {
     this.#childProcess?.kill();
@@ -1128,7 +1171,6 @@ import {
   getNextEthereumBeaconSyncTxs,
   hexToU8a,
   isOutdatedTransactionError,
-  TxSubmitter as TxSubmitter2,
   u8aToHex
 } from "@argonprotocol/mainchain";
 import { parseSignature } from "viem";
@@ -1263,8 +1305,7 @@ async function syncEthereumVerifierUntilAnchorCovers(mainchainClient, relayer, b
     let shouldRetry = false;
     for (const tx of txs) {
       try {
-        const result = await new TxSubmitter2(mainchainClient, tx, relayer).submit();
-        await result.waitForInFirstBlock;
+        await submitTx(mainchainClient, tx, relayer);
         lastRetryableError = void 0;
       } catch (error) {
         if (isRetryableEthereumVerifierSyncError(error)) {
@@ -1605,12 +1646,13 @@ import {
   decodeAddress,
   dispatchErrorToString,
   EvmContracts as EvmContracts3,
+  FIXED_U128_DECIMALS,
   getEthereumBeaconSyncBootstrapTx,
+  hexToU8a as hexToU8a2,
   Keyring as Keyring3,
+  PERMILL_DECIMALS,
   toFixedNumber,
-  TxSubmitter as TxSubmitter3,
   U8aFixed,
-  Vault,
   Vec
 } from "@argonprotocol/mainchain";
 import { privateKeyToAccount as privateKeyToAccount2 } from "viem/accounts";
@@ -1688,15 +1730,10 @@ var EthereumProofE2eHarness = class _EthereumProofE2eHarness {
     );
   }
   async submit(tx, signer) {
-    const result = await new TxSubmitter3(this.mainchainClient, tx, signer).submit();
-    await result.waitForInFirstBlock;
-    return result;
+    return submitTx(this.mainchainClient, tx, signer);
   }
   async sudoSubmit(tx) {
-    const result = await this.submit(
-      this.mainchainClient.tx.sudo.sudo(tx),
-      this.sudoSigner
-    );
+    const result = await this.submit(this.mainchainClient.tx.sudo.sudo(tx.method), this.sudoSigner);
     const sudoEvent = result.events.find((event) => this.mainchainClient.events.sudo.Sudid.is(event));
     if (!sudoEvent || !this.mainchainClient.events.sudo.Sudid.is(sudoEvent)) {
       throw new Error("sudo did not emit sudo.Sudid");
@@ -1992,16 +2029,21 @@ var TestMintingAuthorityActor = class {
   async prepareOperator(args) {
     await this.harness.forceSetBalance(this.operator.address, args.freeBalance);
     await this.harness.forceSetOwnership(this.operator.address, args.ownershipBalance);
-    const vault = await Vault.create(this.harness.mainchainClient, this.operator, {
-      securitization: 1000000000n,
-      securitizationRatio: 1,
-      annualPercentRate: 0.05,
-      baseFee: 0n,
-      bitcoinXpub: args.bitcoinXpub,
-      treasuryProfitSharing: 0,
-      treasuryBonusProfitSharing: 0
-    });
-    await vault.getVault();
+    await this.harness.submit(
+      this.harness.mainchainClient.tx.vaults.create({
+        terms: {
+          bitcoinAnnualPercentRate: toFixedNumber(0.05, FIXED_U128_DECIMALS),
+          bitcoinBaseFee: 0n,
+          treasuryProfitSharing: toFixedNumber(0, PERMILL_DECIMALS),
+          treasuryBonusProfitSharing: toFixedNumber(0, PERMILL_DECIMALS)
+        },
+        securitizationRatio: toFixedNumber(1, FIXED_U128_DECIMALS),
+        securitization: 1000000000n,
+        bitcoinXpubkey: hexToU8a2(args.bitcoinXpubBytesHex),
+        delegateAccountId: null
+      }),
+      this.operator
+    );
     await this.harness.sudoSubmit(
       this.harness.mainchainClient.tx.priceIndex.setOperator(this.operator.address)
     );
@@ -2230,12 +2272,11 @@ function sudo() {
 }
 async function activateNotary(sudo2, client, notary) {
   await notary.register(client);
-  const txResult = await new TxSubmitter4(
+  await submitTx(
     client,
     client.tx.sudo.sudo(client.tx.notaries.activate(notary.operator.publicKey)),
     sudo2
-  ).submit();
-  await txResult.waitForInFirstBlock;
+  );
 }
 export {
   EthereumProofE2eHarness,
@@ -2261,6 +2302,7 @@ export {
   signGatewayPermit,
   startNetwork,
   stringifyExt,
+  submitTx,
   sudo,
   syncEthereumVerifierUntilAnchorCovers,
   teardown,