leap-mock v0.1.7

leap-mock

Allows creation of mock Antelope chains for testing of weird block production scenarios, based on two main concepts:

• Jumps: used to set up fork scenarios
• Pauses: used to set up connection drop scenarios

Table of Contents

1. Introduction

   • Overview of leap-mock
   • Key Concepts: Jumps and Pauses

2. Quickstart

   • Running with Docker
   • Running with a Cloned Repository

3. Practical Example

4. Endpoints

5. Parameters

6. Behavior

7. Additional Endpoints

8. Implemented Mock APIs

9. Testing

Quickstart

docker run -d --network=host guilledk/leap-mock

or with the repo cloned:

npm run build && npm run start

This will serve the control api at port 6970

Practical example:

Let's say you wanted to test the fork handling machinery of a new state history indexer, first lets craft a ChainDescriptor :

{
    "startBlock": 1,
    "endBlock": 10,
    "blockGenStrat": "inorder",
    "jumps": [[5, 3]]
}

If used as parameters for the /create_chain endpoint this ChainDescriptor will create a new chain with block range 1-10, with hashes of blocks being just a hex of the block number, then if started, when this chain reaches block 5 it will jump back to block 3, simulating a fork.

Remember to start block production the endpoint /start has to be called with the chainId.

Endpoints

POST /create_chain

• Description: Initializes a new blockchain instance.
• Request Body:
  • ChainDescriptor: Object describing the blockchain configuration.
• Response:
  • Success: Object with information about the initialized chain.
  • Error: Error message.

ChainDescriptor is an interface used as the input for the /create_chain api, which initializes a new blockchain instance.

Parameters

Optional Parameters

• shipPort?: number
  • The port number for the ship socket connection.
• httpPort?: number
  • The port number for the HTTP API socket connection.
• abi?: ABI
  • The ABI (Application Binary Interface) for the chain. Defaults to DEFAULT_ABI if not provided.
• chainId?: string
  • A unique identifier for the chain. A random hash is generated if not provided.
• startTime?: string
  • The start time of the blockchain instance in ISO format. Defaults to the next block time if not provided.
• asapMode?: boolean
  • If true, the chain will operate in ASAP mode, affecting block generation speed.
• blockGenStrat?: string
  • Strategy for generating block hashes. Can be 'random' or 'inorder'.
• blocks?: string[][]
  • Predefined block hashes. If not provided, they are generated based on blockGenStrat.
• jumps?: [number, number][]
  • An array of tuples representing jumps in the blockchain, each tuple consisting of two numbers.
• pauses?: [number, number][]
  • An array of tuples for pauses in the blockchain, where each tuple represents the start and end of a pause. Pause means drop the sockets and wait for x seconds then restart sockets, while keeping production going.

Mandatory Parameters

• startBlock: number
  • The starting block number for the blockchain instance.
• endBlock: number
  • The ending block number for the blockchain instance.

Behavior

• The initializeChain function creates a new blockchain instance with the specified configuration.
• If chainId is already in use, an error is thrown.
• Random ports are assigned for shipPort and httpPort if not specified.
• The start time defaults to the next block time if not provided.
• The function sets up block history, network sockets, and other necessary configurations based on the provided parameters.

POST /restart_chain_network

• Description: Restarts the network of a specified blockchain instance.
• Request Body:
  • chainId: ID of the blockchain instance.
  • sleepTime (optional): Time to wait before restarting the network.
• Response:
  • Success: Confirmation message ('ok').
  • Error: Error message.

POST /destroy_chain

• Description: Destroys a specified blockchain instance.
• Request Body:
  • chainId: ID of the blockchain instance to be destroyed.
• Response:
  • Success: Confirmation message ('ok').
  • Error: Error message.

POST /start

• Description: Starts the blockchain producer for a specified instance.
• Request Body:
  • chainId: ID of the blockchain instance.
• Response:
  • Success: Confirmation message ('ok').
  • Error: Error message.

POST /stop

• Description: Stops the blockchain producer for a specified instance.
• Request Body:
  • chainId: ID of the blockchain instance.
• Response:
  • Success: Confirmation message ('ok').
  • Error: Error message.

Implemented mock apis:

http api:

- /v1/chain/get_info
- /v1/chain/get_block

websocket:

- state history block read protocol

Testing:

Check the tests/ directory to see how to integrate leap-mock into mocha based tests.