Skip to content

@gala-chain/testAPI


API > ContractTestClient

Variable: ContractTestClient

const ContractTestClient: object

Factory object for creating contract test clients for different organizations.

Provides methods to create test clients connected to Curator, Users, or Partner organizations with appropriate defaults and configuration.

Example

import { ContractTestClient } from "@gala-chain/test";

// Create curator client for admin operations
const curatorClient = ContractTestClient.createForCurator(adminUser, contractConfig);

// Create user client for regular user operations
const userClient = ContractTestClient.createForUser(testUser, contractConfig);

// Get builder for custom configuration
const customBuilder = ContractTestClient.getBuilder(customParams);

Type declaration

createForCurator

createForCurator: (user, contract) => ChainClient & CommonContractAPI & ChainUserAPI = createForCurator

Creates a test client for the Curator organization.

Parameters

user: ChainUser

Chain user to authenticate as

contract: ContractConfig

Contract configuration to connect to

Returns

Chain client with common contract and user APIs

createForPartner

createForPartner: (user, contract) => ChainClient & CommonContractAPI & ChainUserAPI = createForPartner

Creates a test client for the Partner organization.

Parameters

user: ChainUser

Chain user to authenticate as

contract: ContractConfig

Contract configuration to connect to

Returns

Chain client with common contract and user APIs

createForUser

createForUser: (user, contract) => ChainClient & CommonContractAPI & ChainUserAPI = createForUser

Creates a test client for the Users organization.

Parameters

user: ChainUser

Chain user to authenticate as

contract: ContractConfig

Contract configuration to connect to

Returns

Chain client with common contract and user APIs

getBuilder

getBuilder: (params) => ChainClientBuilder = getBuilder

Gets the appropriate chain client builder based on provided parameters.

Determines connection type based on available parameters: - If mockedChaincodeDir is provided, returns MockedChaincodeClientBuilder - If apiUrl is provided, returns REST API client builder - Otherwise, returns Hyperledger Fabric client builder

Parameters

params: TestClientParams

Test client parameters

Returns

Appropriate chain client builder

Source

chain-test/src/e2e/ContractTestClient.ts:324