Make mocknet default in tests

rkalis · rkalis · commit e1b0a92effa5 · 2025-07-10T10:51:49.000+02:00
diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml
@@ -32,7 +32,7 @@ jobs:
         run: yarn
 
       - name: Run tests
-        run: TESTS_USE_MOCKNET=true yarn test -- -- --coverage --coverageProvider=v8
+        run: yarn test -- -- --coverage --coverageProvider=v8
 
       - name: Run linter
         run: yarn lint
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -8,7 +8,7 @@ pushd ../.. && yarn build && popd
 
 ### Publishing a release
 
-To publish a new release, we use `yarn update-version 'x.x.x'` in the root directory to bump the version before release, and then `yarn publish-all` in the root directory to publish the release. In case of a tagged release (such as `next`), we use `TESTS_USE_MOCKNET=true yarn publish-all --dist-tag <tag name>` to publish the release with the specified tag.
+To publish a new release, we use `yarn update-version 'x.x.x'` in the root directory to bump the version before release, and then `yarn publish-all` in the root directory to publish the release. In case of a tagged release (such as `next`), we use `yarn publish-all --dist-tag <tag name>` to publish the release with the specified tag.
 
 ## cashc
 
@@ -60,11 +60,11 @@ python <cashproof_path> opt.equiv
 
 ### Running tests
 
-By default, running tests in the `cashscript` package uses chipnet contracts, which requires the test accounts to have some chipnet BCH. To run the tests against a local "mock network", you can use the `TESTS_USE_MOCKNET` environment variable.
+By default, running tests in the `cashscript` package runs against a local simulated `mocknet`. To run them against the real-world chipnet, you can use the `TESTS_USE_CHIPNET` environment variable. Thisuses chipnet contracts, which requires the test accounts to have some chipnet BCH.
 
 ```bash
-# Run all tests using the mock network
-TESTS_USE_MOCKNET=true yarn test
+# Run all tests using chipnet
+TESTS_USE_CHIPNET=true yarn test
 ```
 
 To run specific tests, you can use the `-t` flag to match the name mentioned in the `it` or `describe` block:
diff --git a/packages/cashscript/test/TransactionBuilder.test.ts b/packages/cashscript/test/TransactionBuilder.test.ts
@@ -19,9 +19,9 @@ import { gatherUtxos, getTxOutputs } from './test-util.js';
 import { generateWcTransactionObjectFixture } from './fixture/walletconnect/fixtures.js';
 
 describe('Transaction Builder', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
 
   let p2pkhInstance: Contract<typeof p2pkhArtifact>;
   let twtInstance: Contract<typeof twtArtifact>;
diff --git a/packages/cashscript/test/e2e/Announcement.test.ts b/packages/cashscript/test/e2e/Announcement.test.ts
@@ -6,9 +6,10 @@ import { aliceAddress } from '../fixture/vars.js';
 import artifact from '../fixture/announcement.artifact.js';
 
 describe('Announcement', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
+
   const announcement = new Contract(artifact, [], { provider });
   const minerFee = 1000n;
 
diff --git a/packages/cashscript/test/e2e/BigInt.test.ts b/packages/cashscript/test/e2e/BigInt.test.ts
@@ -11,9 +11,10 @@ import { randomUtxo } from '../../src/utils.js';
 import { gatherUtxos } from '../test-util.js';
 
 describe('BigInt', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
+
   const bigintContract = new Contract(artifact, [], { provider });
   const MAX_INT64 = BigInt('9223372036854775807');
 
diff --git a/packages/cashscript/test/e2e/HodlVault.test.ts b/packages/cashscript/test/e2e/HodlVault.test.ts
@@ -18,9 +18,10 @@ import artifact from '../fixture/hodl_vault.artifact.js';
 import { randomUtxo } from '../../src/utils.js';
 
 describe('HodlVault', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
+
   const hodlVault = new Contract(artifact, [alicePub, oraclePub, 99000n, 30000n], { provider });
 
   beforeAll(() => {
diff --git a/packages/cashscript/test/e2e/Mecenas.test.ts b/packages/cashscript/test/e2e/Mecenas.test.ts
@@ -12,9 +12,10 @@ import { randomUtxo } from '../../src/utils.js';
 
 // Mecenas has this.age check omitted for testing
 describe('Mecenas', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
+
   const pledge = 10000n;
   const mecenas = new Contract(artifact, [alicePkh, bobPkh, pledge], { provider });
   const minerFee = 1000n;
diff --git a/packages/cashscript/test/e2e/MultiContract.test.ts b/packages/cashscript/test/e2e/MultiContract.test.ts
@@ -26,9 +26,9 @@ import { getTxOutputs } from '../test-util.js';
 import SiblingIntrospectionArtifact from '../fixture/SiblingIntrospection.artifact.js';
 
 describe('Multi Contract', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
 
   const aliceSignatureTemplate = new SignatureTemplate(alicePriv);
   const bobSignatureTemplate = new SignatureTemplate(bobPriv);
diff --git a/packages/cashscript/test/e2e/P2PKH-tokens.test.ts b/packages/cashscript/test/e2e/P2PKH-tokens.test.ts
@@ -15,9 +15,10 @@ describe('P2PKH-tokens', () => {
   let p2pkhInstance: Contract<typeof artifact>;
 
   beforeAll(() => {
-    const provider = process.env.TESTS_USE_MOCKNET
-      ? new MockNetworkProvider()
-      : new ElectrumNetworkProvider(Network.CHIPNET);
+    const provider = process.env.TESTS_USE_CHIPNET
+      ? new ElectrumNetworkProvider(Network.CHIPNET)
+      : new MockNetworkProvider();
+
     p2pkhInstance = new Contract(artifact, [alicePkh], { provider });
     console.log(p2pkhInstance.tokenAddress);
     (provider as any).addUtxo?.(p2pkhInstance.address, randomUtxo());
diff --git a/packages/cashscript/test/e2e/P2PKH.test.ts b/packages/cashscript/test/e2e/P2PKH.test.ts
@@ -21,9 +21,9 @@ import {
 import artifact from '../fixture/p2pkh.artifact.js';
 
 describe('P2PKH-no-tokens', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
 
   // define contract in the describe block so artifact typings aren't lost
   const p2pkhContract = new Contract(artifact, [bobPkh], { provider });
@@ -97,7 +97,7 @@ describe('P2PKH-no-tokens', () => {
 
     // TODO: this fails on mocknet, because mocknet doesn't check inputs vs outputs,
     // we should add a sanity check in our own code
-    itOrSkip(!process.env.TESTS_USE_MOCKNET, 'should fail when not enough satoshis are provided in utxos', async () => {
+    itOrSkip(!!process.env.TESTS_USE_CHIPNET, 'should fail when not enough satoshis are provided in utxos', async () => {
       // given
       const to = p2pkhContract.address;
       const amount = 1000n;
diff --git a/packages/cashscript/test/e2e/TokenCategoryCheck.test.ts b/packages/cashscript/test/e2e/TokenCategoryCheck.test.ts
@@ -7,9 +7,10 @@ import { Network } from '../../src/interfaces.js';
 import artifact from '../fixture/token_category_comparison.artifact.js';
 
 describe('TokenCategoryCheck', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
+
   const checkTokenCategoryContract = new Contract(artifact, [], { provider });
 
   beforeAll(() => {
diff --git a/packages/cashscript/test/e2e/TransferWithTimeout.test.ts b/packages/cashscript/test/e2e/TransferWithTimeout.test.ts
@@ -15,9 +15,10 @@ import twtArtifact from '../fixture/transfer_with_timeout.artifact.js';
 import { randomUtxo } from '../../src/utils.js';
 
 describe('TransferWithTimeout', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
+
   const twtInstancePast = new Contract(twtArtifact, [alicePub, bobPub, 100000n], { provider });
   const twtInstanceFuture = new Contract(twtArtifact, [alicePub, bobPub, 2000000n], { provider });
 
diff --git a/packages/cashscript/test/e2e/misc/timelocks.test.ts b/packages/cashscript/test/e2e/misc/timelocks.test.ts
@@ -16,9 +16,9 @@ import { describeOrSkip, getTxOutputs } from '../../test-util.js';
 
 
 describe('Timelocks', () => {
-  const provider = process.env.TESTS_USE_MOCKNET
-    ? new MockNetworkProvider()
-    : new ElectrumNetworkProvider(Network.CHIPNET);
+  const provider = process.env.TESTS_USE_CHIPNET
+    ? new ElectrumNetworkProvider(Network.CHIPNET)
+    : new MockNetworkProvider();
 
   let p2pkhInstance: Contract<typeof p2pkhArtifact>;
   let twtInstance: Contract<typeof twtArtifact>;
@@ -39,7 +39,7 @@ describe('Timelocks', () => {
     (provider as any).addUtxo?.(carolAddress, randomUtxo());
   });
 
-  describeOrSkip(!process.env.TESTS_USE_MOCKNET, 'Locktime', () => {
+  describeOrSkip(Boolean(process.env.TESTS_USE_CHIPNET), 'Locktime', () => {
     it('should fail when locktime is higher than current block height', async () => {
       const fee = 1000n;
       const p2pkhUtxos = (await p2pkhInstance.getUtxos()).filter(isNonTokenUtxo).sort(utxoComparator).reverse();
diff --git a/packages/cashscript/test/e2e/network/ElectrumNetworkProvider.test.ts b/packages/cashscript/test/e2e/network/ElectrumNetworkProvider.test.ts
@@ -2,7 +2,7 @@ import { describeOrSkip } from '../../../test/test-util.js';
 import { ElectrumNetworkProvider, Network } from '../../../src/index.js';
 import { ElectrumClient } from '@electrum-cash/network';
 
-describeOrSkip(!process.env.TESTS_USE_MOCKNET, 'ElectrumNetworkProvider', () => {
+describeOrSkip(Boolean(process.env.TESTS_USE_CHIPNET), 'ElectrumNetworkProvider', () => {
   // TODO: Test more of the API
   it('should be able to request data', async () => {
     const provider = new ElectrumNetworkProvider(Network.CHIPNET);
diff --git a/packages/cashscript/test/e2e/network/FullStackNetworkProvider.test.ts b/packages/cashscript/test/e2e/network/FullStackNetworkProvider.test.ts
@@ -10,7 +10,7 @@ import { describeOrSkip, gatherUtxos, getTxOutputs } from '../../test-util.js';
 import { FailedRequireError } from '../../../src/Errors.js';
 import artifact from '../../fixture/p2pkh.artifact.js';
 
-describeOrSkip(!process.env.TESTS_USE_MOCKNET, 'test FullStackNetworkProvider', () => {
+describeOrSkip(Boolean(process.env.TESTS_USE_CHIPNET), 'FullStackNetworkProvider', () => {
   const provider = new FullStackNetworkProvider('mainnet', new BCHJS({ restURL: 'https://api.fullstack.cash/v5/' }));
 
   describe('get utxos using FullStackNetworkProvider', () => {
