truffle-plugin-register-methods

🏆 1st Place Winner of TruffleCon 2019 Hackathon!!! 🎉🎉🎉

Usage no npm install needed!

<script type="module">
  import trufflePluginRegisterMethods from 'https://cdn.skypack.dev/truffle-plugin-register-methods';
</script>

README

Overview

🏆 1st Place Winner of TruffleCon 2019 Hackathon!!! 🎉🎉🎉

This plugin allows truffle to scan your contract build artifacts for non-constant methods and register them in the Parity Signature Registry smart contract.

By doing this, web3 browsers can use this information to show some user friendly info to the user when calling contract methods, like saying it is calling the function HELLO instead of doing an enigmatic CONTRACT INTERACTION.

metamask

Currently Metamask uses this registry as explained in https://metamask.github.io/metamask-docs/Best_Practices/Registering_Function_Names, but there is too much friction. This plugin aims to incentivize people to start registering their contract functions.

TLDR

Add:

plugins: ["truffle-plugin-register-methods"]

to truffle-config.js, then run:

$ npm i -D truffle-plugin-register-methods
$ export TRUFFLE_PLUGIN_MNEMONIC="<YOUR-SECRET-MAINNET-MNEMONIC-HERE>"
$ npx truffle run register-methods <contract-name>

Usage

For a more detailed explanation, see usage.