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

vue-cli-plugin-ethers

v0.2.3

Published

Ethereum ethers.js vuex store module generator plugin for vue-cli 3. Build dapps!

Downloads

219

Readme

Ethereum ethers.js vuex store module generator plugin for vue-cli 3

Build dApps!

vue-cli 3 plugin to generate a vuex store module that will connect to the Ethereum blockchain using the ethers.js web3 provider. (ethers.js can do everything web3.js can do and more, like ENS name resolution. It is also well documented.)

This plugin monitors and updates connection and network status with your Ethereum node on any network and allows you to connect to contracts and submit transactions.

(Requires a browser that supports Ethereum or the use of a browser plugin like MetaMask.) Can serve as the foundation of a vue-based Ethereum dApp!

State

These state variables are kept updated:

  • connected (true or false)
  • address (of the user)
  • ens (ENS name if any for selected address)
  • user (either address or if on a net that supports ENS, the ENS name)
  • error (error if any)
  • network (human readable name of the network you are on)

Example code

This plugin comes with the following example code enabled so you can see how this module works. Replace the example code with your own application logic.

  • In the store module, search for the alert and confirm statements. These will alert the state of the ethereum connection and account changes in the browser.
  • By default ethersConnect.js is set to log each block of the blockchain in the console. Review the code comments to see how to easily extend or disable this.

Usage

  • See Vuex Getting Started for general information about Vuex.
  • This plugin expects you to have a file main.js in your src folder according to vue-cli standard.
  • It also expects you to have already added Vuex to your project before adding this plugin.
  • And that
    • your store folder is called store with an index.js in it,
    • you have a modules section in your store index.js,
    • and you have an export in your store index.js file.

For example, the standard store created by vue add vuex, with a modules section added, will work:

import Vue from 'vue'
import Vuex from 'vuex'

Vue.use(Vuex)

export default new Vuex.Store({
  state: {
  },
  mutations: {
  },
  actions: {
  },
  modules: {
  }
})

These are needed to correctly augment the root store with the ethers module code.

Install via vue-cli

$ vue add ethers

Interacting with contracts

Read about how to do this in the ethers.js contract documentation.

Contributions

Pull requests welcome!

Acknowledgements

Extended and modified from vue-cli-plugin-vuex-module-generator. Thanks!