@midnight-ntwrk/testkit-js 3.0.0-alpha.0

package/README.md

@@ -0,0 +1,256 @@
+# What is this?
+A comprehensive testing solution for your Midnight.JS applications, providing seamless integration with various test environments.
+
+This package was created for the [Midnight network](https://midnight.network). 
+
+Please visit the [Midnight Developer Hub](https://midnight.network/developer-hub) to learn more.
+
+# Use only in Midnight test environments
+Image exclusively for Midnight test environments use.  
+
+# Agree to Terms
+By downloading and using this image, you agree to [Midnight’s Terms and Conditions](https://midnight.network/static/terms.pdf), which includes the [Privacy Policy](https://midnight.network/static/privacy-policy.pdf).
+
+# License
+The software provided herein is licensed under the [Apache License V2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+## Table of Contents
+1. [Installation](#installation)
+2. [Getting Started](#getting-started)
+3. [Features](#Features)
+4. [Limitations](#Limitations)
+5. [Examples of Usage](#Examples-of-Usage)
+
+---
+
+## Installation
+Before using the testing library, ensure you have the following prerequisites:
+1. Node.js and yarn installed
+2. Docker Desktop (optional for local dockerized tests)
+3. Midnight.JS project set up
+
+Install the testing library by running the following command in your terminal:
+```
+yarn add -D @midnight-ntwrk/testkit-js
+```
+
+## Getting Started
+To use the testing library, create a new file called `midnight.test.js` in the `__tests__` directory of your project. In this file, import the necessary dependencies:
+```typescript
+import { getTestEnvironment } from '@midnight-ntwrk/testkit-js';
+
+beforeAll(async () => {
+  testEnvironment = getTestEnvironment(logger);
+  environmentConfiguration = await testEnvironment.start();
+  walletProvider = await testEnvironment.getMidnightWalletProvider();
+});
+
+afterAll(async () => {
+  await testEnvironment.shutdown();
+});
+```
+
+---
+
+## Features
+
+Set of functions that simplify testing of DApps in Midnight
+
+- [x] Standard Dockerized environment setup - both live and local
+- [x] Predefined Midnight environments configuration 
+- [x] Proof server control
+- [x] Wallets management
+- [x] Fund wallets
+- [x] Check system health
+
+---
+
+## Environment variables
+
+### Environment selection:
+- MN_TEST_ENVIRONMENT controls the environment to be used for testing. It can take one of these values:
+   - undeployed
+   - devnet
+   - testnet
+   - env-var-remote
+
+If **MN_TEST_ENVIRONMENT** is not set, the default value will be `undeployed`.
+If **MN_TEST_ENVIRONMENT** is set to `undeployed`, the testing environment will be deployed locally using Docker.
+If **MN_TEST_ENVIRONMENT** is set to `devnet`,`testnet, env-var-remote` the testing environment will the corresponding live network, with proof server setup using predefined NETWORK_ID.
+If **MN_TEST_ENVIRONMENT** is set to `env-var-remote`, below environment variables must be set:
+  - *MN_TEST_NETWORK_ID* - Proof server NETWORK_ID
+  - *MN_TEST_INDEXER* - Indexer URL
+  - *MN_TEST_INDEXER_WS* - Indexer WebSocket URL
+  - *MN_TEST_NODE* - Node URL
+  - *MN_TEST_FAUCET* - Faucet URL
+
+### Wallet setup:
+- MN_TEST_WALLET_SEED can be used to set a specific seed phrase for the wallet. If not set, a random seed phrase will be used.
+
+---
+
+## Limitations
+
+- Localnet wallets limit count is 4
+
+---
+
+## Examples of Usage
+
+### 1. Selecting Different Environments
+
+You can control the test environment using the `MN_TEST_ENVIRONMENT` environment variable. Here's how you can set it:
+
+```typescript
+const testEnvironment = getTestEnvironment(logger);
+environmentConfiguration = await testEnvironment.start();
+```
+
+```shell
+# Example: Set the environment variable before initializing the test environment
+MN_TEST_ENVIRONMENT='devnet'; yarn test
+```
+
+This allows you to easily switch between predefined environments like `devnet`, `testnet`, and others.
+Default (undefined) value is `undeployed` which will deploy the testing environment locally using Docker.
+
+---
+
+### 2. Creating and Managing Wallets
+
+Here's an example of creating wallets in your test environment:
+
+```typescript
+// Example: Create multiple wallets in a test environment
+const testEnvironment = getTestEnvironment(logger);
+await testEnvironment.start();
+
+// Create 2 wallets
+const wallets = await testEnvironment.startMidnightWalletProviders(2);
+
+// Verify wallet properties
+expect(wallets).toHaveLength(2);
+wallets.forEach(async (wallet) => {
+  expect(wallet.coinPublicKey).not.toBeUndefined();
+});
+
+// Shutdown the environment after testing
+await testEnvironment.shutdown();
+```
+
+This demonstrates how to create wallets and verify their properties, such as the `coinPublicKey`.
+
+---
+
+### 3. Setting Wallet Seeds
+
+If you need to use specific wallet seeds for testing, you can do the following:
+
+```typescript
+// Example: Create a wallet with a predefined seed phrase
+const wallet = await testEnvironment.getMidnightWalletProvider();
+
+expect(wallet.coinPublicKey).not.toBeUndefined();
+```
+
+```shell
+# Example: Set the environment variable before initializing the test environment
+MN_TEST_WALLET_SEED='00000000000000000000000000000042'; yarn test
+```
+
+This allows you to test specific scenarios using known wallet seeds.
+
+---
+
+### 4. Handling Environment Configuration
+
+You can also customize the test environment configuration by modifying the `defaultContainersConfiguration` object:
+
+```typescript
+import {
+  defaultContainersConfiguration,
+  getContainersConfiguration,
+  setContainersConfiguration
+} from '../configuration';
+
+// Example: Modify default environment configuration before starting
+const config: ContainersConfiguration = {
+  ...defaultContainersConfiguration,
+  proofServer: {
+    ...defaultContainersConfiguration.proofServer,
+    fileName: 'proof-server.yml'
+  }
+};
+setContainersConfiguration(config);
+```
+
+This gives developers flexibility in configuring the test environment according to their needs.
+
+---
+
+### 5. Error Handling
+
+Here's an example of handling errors when setting up wallets:
+
+```typescript
+// Example: Test for maximum wallet limit exceeded
+process.env.MN_TEST_ENVIRONMENT = undefined; // Use local environment
+const testEnvironment = getTestEnvironment(logger);
+await testEnvironment.start();
+
+try {
+  await testEnvironment.startMidnightWalletProviders(5); // Assuming max is 4
+} catch (error) {
+  expect(error.message).toContain('Maximum supported number of wallets for this environment reached');
+}
+
+await testEnvironment.shutdown();
+```
+
+This demonstrates how to handle cases where the wallet limit is exceeded.
+
+---
+
+### 6. Advanced Usage with Proof Server
+
+Here's an example of integrating with the proof server:
+
+```typescript
+// Example: Start a proof server with networkd ID = testnet and ID = 123
+const proofServer = await DynamicProofServerContainer.start(logger, '123', 'testnet');
+
+//stop the proof server
+await proofServer.stop();
+```
+
+This shows how to integrate with and customize the proof server for testing.
+
+---
+
+### 7. Customized test environments
+
+Library is provided with set of predefined environment configurations i.e.:
+
+- LocalTestEnvironment 
+- Testnet2TestEnvironment
+
+By using `getTestEnvironment(logger);` based on environment variable MN_TEST_ENVIRONMENT test environment configuration is provided.
+However, you can either create your own class defining the environment endpoints or use below enviroment variables.
+
+Here's an example of fully customized endpoints of the test environment, that you can provide using environment variables:
+
+```shell
+MN_TEST_ENVIRONMENT="env-var-remote" \
+MN_TEST_NETWORK_ID="undeployed" \
+MN_TEST_INDEXER="http://localhost:3085/api/" \
+MN_TEST_INDEXER_WS="ws://localhost:3085/ws/" \
+MN_TEST_NODE="http://localhost:3086" \
+yarn test
+
+```
+
+---
+
+### 8. System health check before tests
+
+For the remote test environemnts (testnet-02, ...) simple health check is performed for each of the components to check their state before test.

package/dist/assertions.d.ts

@@ -0,0 +1,15 @@
+import type { Contract } from '@midnight-ntwrk/compact-js';
+import type { StateValue } from '@midnight-ntwrk/compact-runtime';
+import type { Bindingish, Proofish, Signaturish, Transaction } from '@midnight-ntwrk/ledger-v7';
+import type { CallTxOptions, DeployContractOptions, DeployTxOptions, FinalizedCallTxData, FinalizedDeployTxData, FinalizedDeployTxDataBase } from '@midnight-ntwrk/midnight-js-contracts';
+import { type FinalizedTxData, type MidnightProviders, type PrivateStateId } from '@midnight-ntwrk/midnight-js-types';
+export declare const stateValueEqual: (a: StateValue, b: StateValue) => boolean;
+export declare const txsEqual: <S extends Signaturish, P extends Proofish, B extends Bindingish>(a: Transaction<S, P, B>, b: Transaction<S, P, B>) => boolean;
+export declare const expectFoundAndDeployedTxPublicDataEqual: <C extends Contract.Any>(deployTxData: FinalizedDeployTxData<C>, foundDeployTxData: FinalizedDeployTxDataBase<C>) => void;
+export declare const expectFoundAndDeployedTxPrivateDataEqual: <C extends Contract.Any>(deployTxData: FinalizedDeployTxData<C>, foundDeployTxData: FinalizedDeployTxDataBase<C>) => void;
+export declare const expectFoundAndDeployedTxDataEqual: <C extends Contract.Any>(deployTxData: FinalizedDeployTxData<C>, foundDeployTxData: FinalizedDeployTxDataBase<C>) => void;
+export declare const expectFoundAndDeployedStatesEqual: <C extends Contract.Any>(providers: MidnightProviders<Contract.ImpureCircuitId<C>, PrivateStateId, Contract.PrivateState<C> | unknown>, deployTxData: FinalizedDeployTxData<C>, foundDeployTxData: FinalizedDeployTxDataBase<C>, privateStateId?: PrivateStateId, initialPrivateState?: Contract.PrivateState<C>) => Promise<void>;
+export declare const expectSuccessfulTxData: (finalizedTxData: FinalizedTxData) => void;
+export declare const expectSuccessfulDeployTx: <C extends Contract.Any>(providers: MidnightProviders<Contract.ImpureCircuitId<C>, PrivateStateId, Contract.PrivateState<C> | unknown>, deployTxData: FinalizedDeployTxData<C>, deployTxOptions?: DeployContractOptions<C> | DeployTxOptions<C>) => Promise<void>;
+export declare const expectSuccessfulCallTx: <C extends Contract.Any, ICK extends Contract.ImpureCircuitId<C>>(providers: MidnightProviders<Contract.ImpureCircuitId<C>, PrivateStateId, Contract.PrivateState<C> | unknown>, callTxData: FinalizedCallTxData<C, ICK>, callTxOptions?: CallTxOptions<C, ICK>, nextPrivateState?: Contract.PrivateState<C>) => Promise<void>;
+//# sourceMappingURL=assertions.d.ts.map

package/dist/assertions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertions.d.ts","sourceRoot":"","sources":["../src/assertions.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAChG,OAAO,KAAK,EACV,aAAa,EACb,qBAAqB,EACrB,eAAe,EACf,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EAC1B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EAEpB,MAAM,mCAAmC,CAAC;AAE3C,eAAO,MAAM,eAAe,GAAI,GAAG,UAAU,EAAE,GAAG,UAAU,KAAG,OAE9D,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,UAAU,EAAE,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAG,OAE5I,CAAC;AAEF,eAAO,MAAM,uCAAuC,GAAI,CAAC,SAAS,QAAQ,CAAC,GAAG,EAC5E,cAAc,qBAAqB,CAAC,CAAC,CAAC,EACtC,mBAAmB,yBAAyB,CAAC,CAAC,CAAC,KAC9C,IAWF,CAAC;AAEF,eAAO,MAAM,wCAAwC,GAAI,CAAC,SAAS,QAAQ,CAAC,GAAG,EAC7E,cAAc,qBAAqB,CAAC,CAAC,CAAC,EACtC,mBAAmB,yBAAyB,CAAC,CAAC,CAAC,KAC9C,IAIF,CAAC;AAEF,eAAO,MAAM,iCAAiC,GAAI,CAAC,SAAS,QAAQ,CAAC,GAAG,EACtE,cAAc,qBAAqB,CAAC,CAAC,CAAC,EACtC,mBAAmB,yBAAyB,CAAC,CAAC,CAAC,KAC9C,IAGF,CAAC;AAEF,eAAO,MAAM,iCAAiC,GAAU,CAAC,SAAS,QAAQ,CAAC,GAAG,EAC5E,WAAW,iBAAiB,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,EAC7G,cAAc,qBAAqB,CAAC,CAAC,CAAC,EACtC,mBAAmB,yBAAyB,CAAC,CAAC,CAAC,EAC/C,iBAAiB,cAAc,EAC/B,sBAAsB,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,KAC7C,OAAO,CAAC,IAAI,CAad,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,iBAAiB,eAAe,KAAG,IAOzE,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAU,CAAC,SAAS,QAAQ,CAAC,GAAG,EACnE,WAAW,iBAAiB,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,EAC7G,cAAc,qBAAqB,CAAC,CAAC,CAAC,EACtC,kBAAkB,qBAAqB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,KAC9D,OAAO,CAAC,IAAI,CA2Bd,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAU,CAAC,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,SAAS,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,EAC1G,WAAW,iBAAiB,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,EAC7G,YAAY,mBAAmB,CAAC,CAAC,EAAE,GAAG,CAAC,EACvC,gBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,CAAC,EACrC,mBAAmB,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,KAC1C,OAAO,CAAC,IAAI,CAcd,CAAC"}

package/dist/client/faucet-client.d.ts

@@ -0,0 +1,30 @@
+import type { Logger } from 'pino';
+/**
+ * Client for interacting with the Midnight faucet service.
+ * Provides functionality to request test tokens for wallet addresses.
+ */
+export declare class FaucetClient {
+    readonly faucetUrl: string;
+    private logger;
+    /**
+     * Creates a new FaucetClient instance.
+     * @param {string} faucetUrl - The URL of the faucet service endpoint
+     * @param {Logger} logger - Logger instance for recording operations
+     */
+    constructor(faucetUrl: string, logger: Logger);
+    /**
+     * Checks the health status of the faucet service.
+     * Makes a GET request to the health endpoint of the faucet service.
+     * @returns {Promise<AxiosResponse | void>} A promise that resolves to the response of the health check or logs an error if the request fails
+     */
+    health(): Promise<void | import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Requests test tokens from the faucet for a specified wallet address.
+     * Makes a POST request to the faucet service with the wallet address.
+     * @param {string} walletAddress - The address to receive the test tokens
+     * @returns {Promise<void>} A promise that resolves when the request is complete
+     * @throws Will log but not throw if the request fails
+     */
+    requestTokens(walletAddress: string): Promise<void>;
+}
+//# sourceMappingURL=faucet-client.d.ts.map

package/dist/client/faucet-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"faucet-client.d.ts","sourceRoot":"","sources":["../../src/client/faucet-client.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAInC;;;GAGG;AACH,qBAAa,YAAY;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK7C;;;;OAIG;IACG,MAAM;IAaZ;;;;;;OAMG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAyB1D"}

package/dist/client/index.d.ts

@@ -0,0 +1,5 @@
+export * from './faucet-client';
+export * from './indexer-client';
+export * from './node-client';
+export * from './proof-server-client';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAeA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC"}

package/dist/client/indexer-client.d.ts

@@ -0,0 +1,18 @@
+import type { Logger } from 'pino';
+export declare class IndexerClient {
+    readonly indexerUrl: string;
+    private logger;
+    /**
+     * Creates an instance of IndexerClient.
+     * @param {string} indexerUrl - The URL of the indexer service.
+     * @param {Logger} logger - The logger instance for logging information.
+     */
+    constructor(indexerUrl: string, logger: Logger);
+    /**
+     * Checks the health status of the indexer service.
+     * Makes a GET request to the status endpoint of the indexer service.
+     * @returns {Promise<AxiosResponse | void>} A promise that resolves to the response of the health check or logs an error if the request fails.
+     */
+    health(): Promise<void | import("axios").AxiosResponse<any, any, {}>>;
+}
+//# sourceMappingURL=indexer-client.d.ts.map

package/dist/client/indexer-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexer-client.d.ts","sourceRoot":"","sources":["../../src/client/indexer-client.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAInC,qBAAa,aAAa;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK9C;;;;OAIG;IACG,MAAM;CAYb"}

package/dist/client/node-client.d.ts

@@ -0,0 +1,66 @@
+import type { ContractAddress } from '@midnight-ntwrk/compact-runtime';
+import { ContractState, LedgerState } from '@midnight-ntwrk/ledger-v7';
+import type { BlockHash } from '@midnight-ntwrk/midnight-js-types';
+import { type AxiosResponse } from 'axios';
+import type { Logger } from 'pino';
+/**
+ * Client for interacting with a Midnight node's JSON-RPC API
+ */
+export declare class NodeClient {
+    readonly nodeURL: string;
+    private logger;
+    /**
+     * Creates a new NodeClient instance
+     * @param {string} nodeURL - URL of the Midnight node
+     * @param {Logger} logger - Logger instance for recording operations
+     */
+    constructor(nodeURL: string, logger: Logger);
+    /**
+     * Checks the health status of the node.
+     * Makes a GET request to the health endpoint of the node.
+     * @returns {Promise<AxiosResponse | void>} A promise that resolves to the response of the health check or logs an error if the request fails.
+     */
+    health(): Promise<void | AxiosResponse<any, any, {}>>;
+    /**
+     * Validates response format and throws if unexpected
+     * @param {AxiosResponse} response - Response from node API
+     * @throws {Error} If response format is unexpected
+     * @private
+     */
+    private static throwOnUnexpected;
+    /**
+     * Makes a JSON-RPC request to the node
+     * @param {string} method - RPC method name
+     * @param {any[]} params - RPC method parameters
+     * @returns {Promise<string>} Response result as string
+     * @private
+     */
+    private jsonRPC;
+    /**
+     * Fetches the state of a contract
+     * @param {ContractAddress} contractAddress - Address of the contract
+     * @returns {Promise<ContractState | null>} Contract state or null if not found
+     */
+    contractState(contractAddress: ContractAddress): Promise<ContractState | null>;
+    /**
+     * Fetches the ledger state at a given block
+     * @param {BlockHash} blockHash - Hash of the block
+     * @returns {Promise<LedgerState>} Ledger state
+     */
+    ledgerState(blockHash: BlockHash): Promise<LedgerState>;
+    /**
+     * Fetches the raw ledger state blob at a given block
+     * @param {BlockHash} blockHash - Hash of the block
+     * @returns {Promise<Uint8Array>} Raw ledger state data
+     * @throws {Error} If no ledger state is found
+     */
+    ledgerStateBlob(blockHash: BlockHash): Promise<Uint8Array>;
+    /**
+     * Fetches the ledger version at a given block
+     * @param {BlockHash} blockHash - Hash of the block
+     * @returns {Promise<string>} Ledger version
+     * @throws {Error} If no ledger version is found
+     */
+    ledgerVersion(blockHash: BlockHash): Promise<string>;
+}
+//# sourceMappingURL=node-client.d.ts.map

package/dist/client/node-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-client.d.ts","sourceRoot":"","sources":["../../src/client/node-client.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAEvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAc,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAInC;;GAEG;AACH,qBAAa,UAAU;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK3C;;;;OAIG;IACG,MAAM;IAaZ;;;;;OAKG;IAEH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAMhC;;;;;;OAMG;YAEW,OAAO;IAoBrB;;;;OAIG;IACG,aAAa,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAQpF;;;;OAIG;IACG,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IAK7D;;;;;OAKG;IACG,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC;IAShE;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAQ3D"}

package/dist/client/proof-server-client.d.ts

@@ -0,0 +1,25 @@
+import { type AxiosRequestConfig } from 'axios';
+import type { Logger } from 'pino';
+export declare class ProofServerClient {
+    readonly proofServer: string;
+    private logger;
+    /**
+     * Creates an instance of ProofServerClient.
+     * @param {string} proofServer - The URL of the proof server service.
+     * @param {Logger} logger - The logger instance for logging information.
+     */
+    constructor(proofServer: string, logger: Logger);
+    /**
+     * Checks the health status of the indexer service.
+     * Makes a GET request to the status endpoint of the indexer service.
+     * @returns {Promise<AxiosResponse | void>} A promise that resolves to the response of the health check or logs an error if the request fails.
+     */
+    health(): Promise<void | import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Proves a transaction by sending a POST request to the proof server.
+     * @param data serialized transaction data
+     * @param config Axios request configuration
+     */
+    proveTx(data?: ArrayBuffer, config?: AxiosRequestConfig): Promise<void | import("axios").AxiosResponse<any, any, {}>>;
+}
+//# sourceMappingURL=proof-server-client.d.ts.map

package/dist/client/proof-server-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proof-server-client.d.ts","sourceRoot":"","sources":["../../src/client/proof-server-client.ts"],"names":[],"mappings":"AAeA,OAAc,EAAE,KAAK,kBAAkB,EAAE,MAAM,OAAO,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAInC,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK/C;;;;OAIG;IACG,MAAM;IAaZ;;;;OAIG;IACG,OAAO,CACX,IAAI,CAAC,EAAE,WAAW,EAClB,MAAM,GAAE,kBAEP;CAaJ"}

package/dist/configuration-types.d.ts

@@ -0,0 +1,68 @@
+import { type WaitStrategy } from 'testcontainers';
+/**
+ * Configuration for a proof server container instance
+ */
+export interface ProofServerContainerConfiguration {
+    /** Directory path where container configuration is located */
+    path: string;
+    /** Name of the container configuration file */
+    fileName: string;
+    /** Network endpoint configuration for the container */
+    container: ContainerEndpoints;
+}
+/**
+ * Network endpoint configuration for a container
+ */
+export interface ContainerEndpoints {
+    /** Name of the container */
+    name: string;
+    /** Port number the container listens on */
+    port: number;
+    /** TestContainers WaitStrategy to use for container start */
+    waitStrategy: WaitStrategy;
+}
+/**
+ * Container endpoint configurations for standalone mode services
+ */
+export interface StandaloneContainerNames {
+    /** Proof server container configuration */
+    proofServer: ContainerEndpoints;
+    /** Blockchain node container configuration */
+    node: ContainerEndpoints;
+    /** Indexer service container configuration */
+    indexer: ContainerEndpoints;
+}
+/**
+ * Configuration for standalone mode containers
+ */
+export interface StandaloneContainersConfiguration {
+    /** Directory path where container configuration is located */
+    path: string;
+    /** Name of the container configuration file */
+    fileName: string;
+    /** Container endpoint configurations */
+    container: StandaloneContainerNames;
+}
+/**
+ * Configuration for test logging
+ */
+export interface LogConfiguration {
+    /** Directory path where log files will be written */
+    path: string;
+    /** Name of the log file */
+    fileName: string;
+    /** Log level (e.g. 'info', 'debug', etc) */
+    level: string;
+}
+/**
+ * Top-level configuration for all test containers
+ */
+export interface ContainersConfiguration {
+    /** Proof server container configuration */
+    proofServer: ProofServerContainerConfiguration;
+    /** Standalone mode containers configuration */
+    standalone: StandaloneContainersConfiguration;
+    /** Logging configuration */
+    log: LogConfiguration;
+}
+//# sourceMappingURL=configuration-types.d.ts.map

package/dist/configuration-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration-types.d.ts","sourceRoot":"","sources":["../src/configuration-types.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,uDAAuD;IACvD,SAAS,EAAE,kBAAkB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,YAAY,EAAE,YAAY,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,2CAA2C;IAC3C,WAAW,EAAE,kBAAkB,CAAC;IAChC,8CAA8C;IAC9C,IAAI,EAAE,kBAAkB,CAAC;IACzB,8CAA8C;IAC9C,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,SAAS,EAAE,wBAAwB,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,2CAA2C;IAC3C,WAAW,EAAE,iCAAiC,CAAC;IAC/C,+CAA+C;IAC/C,UAAU,EAAE,iCAAiC,CAAC;IAC9C,4BAA4B;IAC5B,GAAG,EAAE,gBAAgB,CAAC;CACvB"}

package/dist/configuration.d.ts

@@ -0,0 +1,6 @@
+import type { ContainersConfiguration } from './configuration-types';
+export declare const defaultContainersConfiguration: ContainersConfiguration;
+export declare const latestContainersConfiguration: ContainersConfiguration;
+export declare const getContainersConfiguration: () => ContainersConfiguration;
+export declare const setContainersConfiguration: (containersConfig: ContainersConfiguration) => void;
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.d.ts","sourceRoot":"","sources":["../src/configuration.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAIrE,eAAO,MAAM,8BAA8B,EAAE,uBAoC5C,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,uBAU3C,CAAC;AAIF,eAAO,MAAM,0BAA0B,+BAEtC,CAAC;AAEF,eAAO,MAAM,0BAA0B,GAAI,kBAAkB,uBAAuB,SAEnF,CAAC"}

package/dist/contract/contract-types.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Configuration interface for Midnight contracts.
+ */
+export interface ContractConfiguration {
+    /**
+     * Name of the store used for persisting private state data.
+     * This is used as a base name - a signing key store will also be created with "-signing-keys" appended.
+     */
+    readonly privateStateStoreName: string;
+    /**
+     * File system path to the zero-knowledge proof configuration files.
+     * This should point to the directory containing the circuit verification keys and other ZK artifacts.
+     */
+    readonly zkConfigPath: string;
+}
+//# sourceMappingURL=contract-types.d.ts.map

package/dist/contract/contract-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-types.d.ts","sourceRoot":"","sources":["../../src/contract/contract-types.ts"],"names":[],"mappings":"AAeA;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC/B"}

package/dist/contract/in-memory-private-state-provider.d.ts

@@ -0,0 +1,10 @@
+import type { Contract } from '@midnight-ntwrk/compact-js';
+import { type PrivateStateId, type PrivateStateProvider } from '@midnight-ntwrk/midnight-js-types';
+/**
+ * A simple in-memory implementation of private state provider. Makes it easy to capture and rewrite private state from deploy.
+ * @template PSI - Type of the private state identifier.
+ * @template PS - Type of the private state.
+ * @returns {PrivateStateProvider<PSI, PS>} An in-memory private state provider.
+ */
+export declare const inMemoryPrivateStateProvider: <PSI extends PrivateStateId, PS extends Contract.PrivateState<Contract.Any>>() => PrivateStateProvider<PSI, PS>;
+//# sourceMappingURL=in-memory-private-state-provider.d.ts.map

package/dist/contract/in-memory-private-state-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"in-memory-private-state-provider.d.ts","sourceRoot":"","sources":["../../src/contract/in-memory-private-state-provider.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAG3D,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAAC,MAAM,mCAAmC,CAAC;AAEtE;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GACvC,GAAG,SAAS,cAAc,EAC1B,EAAE,SAAS,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,OAC3C,oBAAoB,CAAC,GAAG,EAAE,EAAE,CAgFhC,CAAC"}

package/dist/contract/index.d.ts

@@ -0,0 +1,4 @@
+export * from './contract-types';
+export * from './in-memory-private-state-provider';
+export * from './providers';
+//# sourceMappingURL=index.d.ts.map

package/dist/contract/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/contract/index.ts"],"names":[],"mappings":"AAeA,cAAc,kBAAkB,CAAC;AACjC,cAAc,oCAAoC,CAAC;AACnD,cAAc,aAAa,CAAC"}

package/dist/contract/providers.d.ts

@@ -0,0 +1,24 @@
+import { type MidnightProviders, type PrivateStateId } from '@midnight-ntwrk/midnight-js-types';
+import { type EnvironmentConfiguration } from '@/test-environment';
+import { type MidnightWalletProvider } from '@/wallet';
+import { type ContractConfiguration } from './contract-types';
+/**
+ * Configures and returns the required providers for a Midnight contract.
+ *
+ * @template ICK - Type parameter for the input circuit key string
+ * @template PS - Type parameter for the private state
+ *
+ * @param {MidnightWalletProvider} midnightWalletProvider - The midnightWalletProvider provider instance to use for transactions
+ * @param {EnvironmentConfiguration} environmentConfiguration - Configuration for the environment including indexer and proof server details
+ * @param {ContractConfiguration} contractConfiguration - Configuration specific to the contract including storage names and ZK config path
+ *
+ * @returns {MidnightProviders} An object containing all configured providers:
+ *   - privateStateProvider: For managing private contract state
+ *   - publicDataProvider: For accessing public blockchain data
+ *   - zkConfigProvider: For zero-knowledge proof configurations
+ *   - proofProvider: For generating and verifying proofs
+ *   - walletProvider: For midnightWalletProvider operations
+ *   - midnightProvider: For Midnight-specific operations
+ */
+export declare const initializeMidnightProviders: <ICK extends string, PS>(midnightWalletProvider: MidnightWalletProvider, environmentConfiguration: EnvironmentConfiguration, contractConfiguration: ContractConfiguration) => MidnightProviders<ICK, PrivateStateId, PS>;
+//# sourceMappingURL=providers.d.ts.map

package/dist/contract/providers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/contract/providers.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAEhG,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAEvD,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAE9D;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,2BAA2B,GAAI,GAAG,SAAS,MAAM,EAAE,EAAE,EAChE,wBAAwB,sBAAsB,EAC9C,0BAA0B,wBAAwB,EAClD,uBAAuB,qBAAqB,KAC3C,iBAAiB,CAAC,GAAG,EAAE,cAAc,EAAE,EAAE,CAe3C,CAAC"}

package/dist/env-vars.d.ts

@@ -0,0 +1,10 @@
+export declare const getEnvVarEnvironment: () => string;
+export declare const getEnvVarWalletSeeds: () => string[] | undefined;
+export declare const MN_TEST_INDEXER: string | undefined;
+export declare const MN_TEST_INDEXER_WS: string | undefined;
+export declare const MN_TEST_NODE: string | undefined;
+export declare const MN_TEST_NODE_WS: string | undefined;
+export declare const MN_TEST_FAUCET: string | undefined;
+export declare const MN_TEST_NETWORK_ID: string | undefined;
+export declare const MN_TEST_WALLET_NETWORK_ID: string | undefined;
+//# sourceMappingURL=env-vars.d.ts.map

package/dist/env-vars.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env-vars.d.ts","sourceRoot":"","sources":["../src/env-vars.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,oBAAoB,cAKhC,CAAC;AACF,eAAO,MAAM,oBAAoB,4BAGhC,CAAC;AACF,eAAO,MAAM,eAAe,oBAA8B,CAAC;AAC3D,eAAO,MAAM,kBAAkB,oBAAiC,CAAC;AACjE,eAAO,MAAM,YAAY,oBAA2B,CAAC;AACrD,eAAO,MAAM,eAAe,oBAA8B,CAAC;AAC3D,eAAO,MAAM,cAAc,oBAA6B,CAAC;AACzD,eAAO,MAAM,kBAAkB,oBAAiC,CAAC;AACjE,eAAO,MAAM,yBAAyB,oBAAwC,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,11 @@
+/**
+ * An error representing a required, but missing, environment variable.
+ */
+export declare class MissingEnvironmentVariable extends Error {
+    readonly environmentVariable: string;
+    /**
+     * @param environmentVariable The name of the missing environment variable.
+     */
+    constructor(environmentVariable: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAeA;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,KAAK;aAIvB,mBAAmB,EAAE,MAAM;IAHvD;;OAEG;gBACyB,mBAAmB,EAAE,MAAM;CAGxD"}