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

truffle-yargs

v0.3.3

Published

Add hearty bash commands to contracts what be stowed in ye's truffle project:

Downloads

4

Readme


Add hearty bash commands to contracts what be stowed in ye's truffle project:

truffle-contract USDC.balanceOf \
  --at 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48 \
  --address 0xdfcb116732ebc9ae2c8939b053363bcf48a37a99 \
  --network mainnet

CLI Standalone

npm install -g truffle-yargs
truffle-contract --dir path-to-your/truffle-project

Install

npm install --save truffle-yargs

Quick Usage

Roll your own CLI within your own truffle project.

For example, create a cli.js with your truffle project:

#!/usr/bin/env node

const path = require('path');
const yargs = require('yargs');
const truffleYargs = require('truffle-yargs')(yargs);

// by default, this will scan truffle default contracts location
truffleYargs()
  .demandCommand(1, 'Specify at least one command to run.')
  .strict()
  .help()
  .argv;

Programmatic Usage

Run the methods as commands with the same validation and parsing:

const yargs = require('yargs');
const truffleYargs = require('truffle-yargs')(yargs);

try {
  truffleYargs()
    .contract('Token', '0x468d834b0FAc4B9D8B2E90bE1cE35A891Ff96Ae9')
    .balanceOf({
      owner: '0x4a378afbc608073d4520c91d70d06cb79a0a31c5',
    })
    .then(balance => {
      console.log('Balance is:', balance);
    }, err => {
      console.error('Error:', err);
    });

Options

provider (optional)

Manually configure a Web3 provider instead of detecting from truffle config

const customProvider = new Web3.providers.HttpProvider('http://localhost:8545');
truffleYargs({
  provider: customProvider
});

contracts (optional)

String glob pattern of contracts

truffleYargs({
  contracts: './custom-build-path/**/*.json'
});

Array of contracts

truffleYargs({
  contracts: [
    Token,
    OtherContract,
    SafeMath,
  ]
});

Object hash map of contracts

truffleYargs({
  contracts: {
    Token,    
    OtherContract,
    SafeMath,
  }
});

TODO

  • Detect deployed address from JSON using truffle config network ID
  • Document overrides of commands and options

Credits

  • Hook by Alena Artemova from the Noun Project
  • Eye Patch by Javier Sánchez from the Noun Project
  • Bone by TS Graphics from the Noun Project
  • Pirate Hat by Nakesha Upshaw from the Noun Project