Skip to main content

Function: getColonyNetworkClient()

getColonyNetworkClient(network, signerOrProvider, options?): ColonyNetworkClient

The main entry point for accessing the deployed colonyNetwork contracts

Specify a network and an ethers compatible singer or provider to get back an initialized and extended (ethers) contract client for the colonyNetwork. From here you can access different colonies, extensions, ENS and other features of Colony.

Example

import { getColonyNetworkClient, Network } = from '@colony/colony-js';
import { providers } from 'ethers';

// For local connections (run an Ethereum node on port 8545);
const provider = new providers.JsonRpcProvider();

// Just for reading data - to sign transactions we need to pass in a signer.
const networkClient = await getColonyNetworkClient(Network.Xdai, provider);

Parameters​

network​

Network

One of the available options. See Network.

signerOrProvider​

SignerOrProvider

An ethers compatible signer or provider instance

options?​

NetworkClientOptions

Here you can supply options for accessing certain contracts (mostly used in local/dev environments)

Returns​

ColonyNetworkClient