{"id":21420218,"url":"https://github.com/ethjs/ethjs-contract-boilerplate","last_synced_at":"2025-07-14T06:32:05.014Z","repository":{"id":66080777,"uuid":"102313379","full_name":"ethjs/ethjs-contract-boilerplate","owner":"ethjs","description":"A highly configurable boilerplate for multi-environment Ethereum smart-contract development.","archived":false,"fork":false,"pushed_at":"2017-11-17T19:32:33.000Z","size":36,"stargazers_count":24,"open_issues_count":2,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T06:06:30.546Z","etag":null,"topics":["boilerplate","contract","ethdeploy","ethereum","ethjs","smart-contracts","wafr","website"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ethjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-04T03:07:21.000Z","updated_at":"2022-02-06T00:48:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"5623033c-99b3-4cc0-9796-0981195fb433","html_url":"https://github.com/ethjs/ethjs-contract-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethjs%2Fethjs-contract-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethjs%2Fethjs-contract-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethjs%2Fethjs-contract-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethjs%2Fethjs-contract-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethjs","download_url":"https://codeload.github.com/ethjs/ethjs-contract-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225958011,"owners_count":17551331,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","contract","ethdeploy","ethereum","ethjs","smart-contracts","wafr","website"],"created_at":"2024-11-22T20:13:46.796Z","updated_at":"2024-11-22T20:13:48.381Z","avatar_url":"https://github.com/ethjs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## ethjs-contract-boilerplate\n\n\u003cdiv\u003e\n  \u003c!-- Dependency Status --\u003e\n  \u003ca href=\"https://david-dm.org/ethjs/ethjs-contract-boilerplate\"\u003e\n    \u003cimg src=\"https://david-dm.org/ethjs/ethjs-contract-boilerplate.svg\"\n    alt=\"Dependency Status\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- devDependency Status --\u003e\n  \u003ca href=\"https://david-dm.org/ethjs/ethjs-contract-boilerplate#info=devDependencies\"\u003e\n    \u003cimg src=\"https://david-dm.org/ethjs/ethjs-contract-boilerplate/dev-status.svg\" alt=\"devDependency Status\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- NPM Version --\u003e\n  \u003ca href=\"https://www.npmjs.org/package/ethjs-contract-boilerplate\"\u003e\n    \u003cimg src=\"http://img.shields.io/npm/v/ethjs-contract-boilerplate.svg\"\n    alt=\"NPM version\" /\u003e\n  \u003c/a\u003e\n\n  \u003c!-- Javascript Style --\u003e\n  \u003ca href=\"http://airbnb.io/javascript/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/code%20style-airbnb-brightgreen.svg\" alt=\"js-airbnb-style\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n## Features\n  - Highly unopinionated\n  - Complex configurable multi-environment contract deployment (ethdeploy)\n  - Dual-language contract testing in Javascript (mocha) and Solidity (wafr)\n  - Async/Await enabled JS testing\n  - Configurable linting with eslint\n  - Webpack enabled build and distribution flow\n  - Local TestRPC driven testing environment\n\n## Install\n\n```\ngit clone https://github.com/ethjs/ethjs-contract-boilerplate\ncd ethjs-contract-boilerplate\nnpm install\n```\n\n## Start\n\n**This will start a testrpc instance which is used for JS testing.**\n\n```\nnpm start\n```\n\n## Test\n\n```\nnpm test\n```\n\n## Solidity or JS Testing\n\n```\nnpm run test:contracts:solidity\n\nnpm run test:contracts:js\n```\n\n## Deployment\n\n**Specify your account information in `internals/accounts/index.js`**\n\n**Remember, do not publish/include your actual private keys in the repo.. require them from a source outside the repository**\n\n```\nnpm run deploy:mainnet\nnpm run deploy:rinkeby\n\nnpm run deploy:testrpc\n```\n\n## Build\n\n**This will build the outputted contract data (address/abi/interface etc).**\n\n```\nnpm run build\n```\n\n## About\n\nThis is a highly configurable boilerplate for constructing complex Ethereum smart-contract systems.\n\nAll environment and account configuration is included within the `internals` directory.\n\nAll contracts/interfaces and tests are included in the `src/contracts` directory.\n\nAll build/deployment data is outputed to `src/contracts/lib` directory.\n\n## Internals\n\n**Account Management (`internals/accounts`)**\n\nAll account data is included in the accounts directory. This is where you can define your account private keys/addresses/balances.\n\nThis boierplate is configured to use the same account accross all environments.\n\n**Contract Deployment (`internals/ethdeploy`)**\n\nAll deployment configuration is included in this directory.\n\n**Distribution (`internals/webpack`)**\n\nAll webpack related configuration is in this directory.\n\n## Contributing\n\nPlease help better the ecosystem by submitting issues and pull requests to `ethjs-contract-boilerplate`. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard and the unix philosophy.\n\n## Help out\n\nThere is always a lot of work to do, and will have many rules to maintain. So please help out in any way that you can:\n\n- Create, enhance, and debug ethjs rules (see our guide to [\"Working on rules\"](./.github/CONTRIBUTING.md)).\n- Improve documentation.\n- Chime in on any open issue or pull request.\n- Open new issues about your ideas for making `ethjs` better, and pull requests to show us how your idea works.\n- Add new tests to *absolutely anything*.\n- Create or contribute to ecosystem tools.\n- Spread the word!\n\nPlease consult our [Code of Conduct](CODE_OF_CONDUCT.md) docs before helping out.\n\nWe communicate via [issues](https://github.com/ethjs/ethjs-contract-boilerplate/issues) and [pull requests](https://github.com/ethjs/ethjs-contract-boilerplate/pulls).\n\n## Todo\n\nThe current TODO items are:\n\n - A clear command (clear all boilerplate contracts/tests)\n - Plop enabled contract instantiation\n - Account generation/wallet management\n\n## Important documents\n\n- [Changelog](CHANGELOG.md)\n- [Code of Conduct](CODE_OF_CONDUCT.md)\n- [License](https://raw.githubusercontent.com/ethjs/ethjs-contract-boilerplate/master/LICENSE)\n\n## Licence\n\nThis project is licensed under the MIT license, Copyright (c) 2016 Nick Dodson. For more information see LICENSE.md.\n\n```\nThe MIT License\n\nCopyright (c) 2016 Nick Dodson. nickdodson.com\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethjs%2Fethjs-contract-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethjs%2Fethjs-contract-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethjs%2Fethjs-contract-boilerplate/lists"}