@omegajs/testnet
v1.0.0
Published
A compact module designed to assist in setting up a local Omega test network for development and testing purposes.
Downloads
8
Readme
OmegaJS Testnet Launcher
@omegajs/testnet
A compact module designed to assist in setting up a local Omega test network for development and testing purposes.
npm install @omegajs/testnet
Use this if you want to use Omega Flock in tests, etc.
Install Via L1FE's NPM
npm config set registry https://npm.l1fe.tech
npm install @omegajs/scroll
Install Via L1FE's Git Repository
git clone https://lab.l1fe.tech/omega/scroll.git
cd scroll
npm install
Usage
const createOmegaTestnet = require('@omegajs/testnet')
const testnet = await createOmegaTestnet(10) // create a local testnet with 10 dht nodes
API
const testnet = await createOmegaTestnet(size = 10, [options])
Create a new testnet. size
is how many DHT nodes you want in it. Options include:
{
port: preferredLocalPort, // defaults to ANY (0)
host: preferredLocalHost, // defaults to 127.0.0.1
teardown // optional async teardown helper ie, t.teardown in brittle/tap etc
}
testnet.nodes
An array of nodes in the testnet.
testnet.bootstrap
An array of bootstrap addresses of the testnet.
const node = testnet.createNode([options])
Create an additional ephemeral node and add it to the testnet. Options are the same as new DHT()
.
for (const node of testnet)
Iterate over the nodes of the testnet.
License
Apache-2.0