Code Monkey home page Code Monkey logo

hardhat-nextjs's Introduction

hardhat-nextjs-plugin

Hardhat plugin that generates React hooks for all smart contract functions and events.

About

This plugin allows a smart contract developer to generate React implementations of all the smart contract functions and events.

React hooks or the whole NextJS project can then be shared with the dApp developer and jumpstart the development process.

The plugin also generates an optimized ABI files and copies then along with React Hooks.

To be able to use the hooks, the developer needs to enter the contract address into each abi file.

Installation

  1. Install the dependencies:
npm install @i0san/hardhat-nextjs
  1. Import the plugin in your hardhat.config.js:
import "@i0san/hardhat-nextjs";

Tasks

This plugin adds the "nextjs" task to Hardhat. To see the info about the task options run:

npx hardhat help nextjs

Usage

To use the task, run the task after the contracts have been compiled and artifacts generated.

npx hardhat nextjs

This will create a new folder "/nextjs-app" with the app and all the hooks and a usage page.

Configuration

Usage: hardhat [GLOBAL OPTIONS] nextjs [--hooks-only <BOOLEAN>] [--skip-contracts <STRING>]

OPTIONS:

  --hooks-only          Generate React Hooks only. (default: false)
  --skip-contracts      Array of contract names to skip. Format: "[\"Contract1", \"Contract2"]". Optional.

nextjs: Generate NextJS app with implemented contract functions and events.

License

MIT

Author

IoSan - [email protected]

hardhat-nextjs's People

Contributors

i0san avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.