npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

buidler-local-networks-config-plugin

v0.0.1

Published

Local networks config plugin for Buidler

Downloads

4

Readme

buidler CI Status

buidler-local-networks-config-plugin

Allow loading network configs for Buidler projects in home file

What

This plugin allows you to specify a local configuration file to populate the Buidler's networks config. This means users can keep critical information stored locally without risking it to the project's devs or users. For example, you can keep your providers keys or private keys in a secured directory without exposing them.

Installation

Install dependency from NPM:

npm install buidler-local-networks-config-plugin @nomiclabs/buidler

And add the following statement to your buidler.config.js:

usePlugin('buidler-local-networks-config-plugin')

Required plugins

This plugin does not require any extra plugin.

Tasks

This plugin creates no additional tasks.

Environment extensions

This plugin does not perform any environment extension.

Configuration

This plugin extends the BuidlerConfig object with an optional localNetworksConfig field.

This is an example of how to set it:

module.exports = {
  localNetworksConfig: '~/.buidler/networks.ts'
}

In case a localNetworksConfig is not provided, the plugin will try to read it from ~/.buidler/networks.json.

Note that both JS/TS and JSON formats are supported.

Usage

The local configuration file should support the following interface, any other field will be simply ignored:

export interface LocalNetworksConfig {
  networks?: Networks
  defaultConfig?: NetworkConfig
}

Where Networks and NetworkConfig are based types defined by Buidler.

In case there is a conflict between any of the local network configs, the default one, or the ones defined in your project, the following list of priorities will be enforced:

  1. Project network specific configuration
  2. Local network specific configuration
  3. Local default network configuration

A local configuration file could look as follows:

{
  "networks": {
    "rinkeby": {
      "gasMultiplier": 2,
      "accounts": "0x12..56,0xab..cd",
      "url": "https://rinkeby.infura.io/v3/<API_KEY>"
    },
    "mainnet": {
      "accounts": "0x12..56,0xab..cd",
      "url": "https://mainnet.infura.io/v3/<API_KEY>"
    }
  },
  "defaultConfig": {
    "gasPrice": "auto"
  }
}

TypeScript support

You need to add this to your tsconfig.json's files array: "node_modules/buidler-local-networks-config-plugin/src/type-extensions.d.ts"