{"id":20599038,"url":"https://github.com/wmitsuda/truffle-plugin-register-methods","last_synced_at":"2025-05-09T23:32:28.880Z","repository":{"id":44095028,"uuid":"200516313","full_name":"wmitsuda/truffle-plugin-register-methods","owner":"wmitsuda","description":"Truffle plugin for registering contract functions in Parity Method Registry","archived":true,"fork":false,"pushed_at":"2023-01-23T23:49:41.000Z","size":1187,"stargazers_count":1,"open_issues_count":11,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-21T22:43:31.184Z","etag":null,"topics":["ethereum","solidity","truffle","truffle-framework","web3"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wmitsuda.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-04T16:30:13.000Z","updated_at":"2023-10-04T19:18:28.000Z","dependencies_parsed_at":"2023-01-26T13:16:41.299Z","dependency_job_id":null,"html_url":"https://github.com/wmitsuda/truffle-plugin-register-methods","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wmitsuda%2Ftruffle-plugin-register-methods","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wmitsuda%2Ftruffle-plugin-register-methods/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wmitsuda%2Ftruffle-plugin-register-methods/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wmitsuda%2Ftruffle-plugin-register-methods/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wmitsuda","download_url":"https://codeload.github.com/wmitsuda/truffle-plugin-register-methods/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253341964,"owners_count":21893547,"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":["ethereum","solidity","truffle","truffle-framework","web3"],"created_at":"2024-11-16T08:30:13.823Z","updated_at":"2025-05-09T23:32:28.239Z","avatar_url":"https://github.com/wmitsuda.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\n\n\u003e 🏆 1st Place Winner of TruffleCon 2019 Hackathon!!! 🎉🎉🎉\n\nThis plugin allows truffle to scan your contract build artifacts for non-constant methods and register them in the Parity Signature Registry smart contract.\n\nBy 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**.\n\n![metamask](docs/overview.png)\n\nCurrently 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.\n\n# TLDR\n\nAdd:\n\n```\nplugins: [\"truffle-plugin-register-methods\"]\n```\n\nto `truffle-config.js`, then run:\n\n```sh\n$ npm i -D truffle-plugin-register-methods\n$ export TRUFFLE_PLUGIN_MNEMONIC=\"\u003cYOUR-SECRET-MAINNET-MNEMONIC-HERE\u003e\"\n$ npx truffle run register-methods \u003ccontract-name\u003e\n```\n\n# Usage\n\nFor a more detailed explanation, see [usage](USAGE.md).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwmitsuda%2Ftruffle-plugin-register-methods","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwmitsuda%2Ftruffle-plugin-register-methods","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwmitsuda%2Ftruffle-plugin-register-methods/lists"}