@streamr/config

@streamr/config

Features

• Streamr Network development and production smart contract addresses
• Zero dependency

Installing

Using npm:

npm install --save @streamr/config

Examples

Typescript

Import DATA token production Ethereum address as a variable in a Typescript project:

import { Chains } from "@streamr/config"

const {
    ethereum: {
        id: chainId,
        contracts: {
            "DATA-token": dataTokenAddress
        }
    }
} = Chains.load("production")

Find RPC endpoints:

import * as config from "@streamr/config"

const chains: config.Chains = config.Chains.load("production")
const httpRpcEndpoints: RPCEndpoint[] = chains.ethereum.getRPCEndpointsByProtocol(config.RPCProtocol.HTTP)
const wsRpcEndpoints: RPCEndpoint[] = chains.ethereum.getRPCEndpointsByProtocol(config.RPCProtocol.WEBSOCKET)

You can also load configuration based on $NODE_ENV environment variable:

import * as config from "@streamr/config"

const chains: Chains = config.Chains.loadFromNodeEnv()

Javascript

Use in a Javascript project:

const config = require("@streamr/config")
const chains: config.Chains = config.Chains.loadFromNodeEnv()

Other Languages

Other languages can read the JSON file directly.

Development

Common Setup

Git checkout repository and change directory to it. Install NVM and run command in the repository root:

nvm use

Install Node modules:

npm ci

Change directory:

cd packages/config

Programming

Start with Common Setup before continuing.

Run tests:

make test

Run lint:

make lint

Run build:

make build

Run clean:

make clean

Publish Release

1. Start with Common Setup before continuing.
2. Login to Npmjs.com:

   npm login --registry https://registry.npmjs.org --scope @streamr
   

3. Run clean build, create a new release on Npmjs.com, update version in package.json, push a release commit, and tag it on GitHub:

   ./release.bash 0.0.2
   

4. Draft a new release on GitHub network-contracts repository with the generated tag config/0.0.2

License

MIT