@defichain/testcontainers

SDK & Ecosystem for building modern lite DeFi Applications at scale.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@defichain/testcontainers
911412.64.12 days ago2 years agoMinified + gzip package size for @defichain/testcontainers in KB

Readme

@defichain/testcontainers
Similar to testcontainers in the Java ecosystem, this package provides a lightweight, throwaway instances of regtest, testnet or mainnet provisioned automatically in Docker container. @defichain/testcontainers encapsulate on top of defi/defichain:v1.x and directly interface with the Docker REST API.
With @defichain/testcontainers, it allows the JS developers to:
  1. End-to-end test their application without hassle of setting up the toolchain
  2. Run parallel tests as port number and container are dynamically generated on demand
  3. Supercharge our CI workflow; run locally, anywhere or CI (as long as it has Docker installed)
  4. Supercharge your @defichain/jellyfish-* implementation with 100% day 1 compatibility (mono repo!)
  5. Bring quality and reliability to dApps on the DeFiChain JS ecosystem

Usage Example

Install as dev only as you don't need this in production. Please don't use this in production!
npm i defichain
npm i -D @defichain/testcontainers

Use your favourite jest runner and start building dApps!

Basic RegTestContainer setup

import { RegTestDocker } from '@defichain/testcontainers'

describe('reg test container', () => {
  const container = new RegTestContainer()

  beforeEach(async () => {
    await container.start()
    await container.waitForReady()
  })

  afterEach(async () => {
    await container.stop()
  })

  it('should getmininginfo and chain should be regtest', async () => {
    // Using node.call('method', []), the built-in minimalistic rpc call
    const result = await container.call('getmininginfo', [])
    expect(result.chain).toStrictEqual('regtest')
  })
})

MasterNodeRegTestContainer with auto-minting

import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
import waitForExpect from "wait-for-expect";

describe('master node pos minting', () => {
  const container = new MasterNodeRegTestContainer()

  beforeEach(async () => {
    await container.start()
    await container.waitForReady()
  })

  afterEach(async () => {
    await container.stop()
  })

  it('should wait until coinbase maturity with spendable balance', async () => {
    await container.waitForWalletCoinbaseMaturity()

    await waitForExpect(async () => {
      const info = await container.getMiningInfo()
      expect(info.blocks).toBeGreaterThan(100)
    })

    // perform utxostoaccount rpc
    const address = await container.getNewAddress()
    const payload: { [key: string]: string } = {}
    payload[address] = "100@0"
    await container.call("utxostoaccount", [payload])
  })
})

Endpoint?

const container = new MasterNodeRegTestContainer()
const rpcURL = await container.getCachedRpcUrl()

// they are dynmaically assigned to host, you can run multiple concurrent tests!
const port = await container.getPort('8555/tcp')

Included container.call('method', []) for convenience RPC calls

const container = new MasterNodeRegTestContainer()
await container.start()
await container.waitForReady()

// raw universal calls
const { blocks } = await container.call('getmininginfo')
const address = await container.call('getnewaddress', ['label', 'legacy'])

// basic included types
const count = await container.getBlockCount()
const info = await container.getMiningInfo()
const newAddress = await container.getNewAddress()