{"id":15652097,"url":"https://github.com/peetzweg/notar","last_synced_at":"2025-04-30T17:20:55.365Z","repository":{"id":41488154,"uuid":"509858517","full_name":"peetzweg/notar","owner":"peetzweg","description":"interactive CLI to read and call contracts deployed to EVM chains - bring your own ABIs.","archived":false,"fork":false,"pushed_at":"2024-02-27T11:06:10.000Z","size":6239,"stargazers_count":30,"open_issues_count":4,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T22:43:24.977Z","etag":null,"topics":["blockchain","cli","ethereum","evm"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/notar-cli","language":"TypeScript","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/peetzweg.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-02T20:46:56.000Z","updated_at":"2024-10-17T17:35:13.000Z","dependencies_parsed_at":"2024-10-03T12:41:29.998Z","dependency_job_id":"ca362d19-1e94-4c80-84ff-a2969a04b4a7","html_url":"https://github.com/peetzweg/notar","commit_stats":{"total_commits":48,"total_committers":2,"mean_commits":24.0,"dds":0.0625,"last_synced_commit":"27a5deb49ed5ca0339fb7539ccb9fb976a6c39a7"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peetzweg%2Fnotar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peetzweg%2Fnotar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peetzweg%2Fnotar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peetzweg%2Fnotar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peetzweg","download_url":"https://codeload.github.com/peetzweg/notar/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251749104,"owners_count":21637455,"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":["blockchain","cli","ethereum","evm"],"created_at":"2024-10-03T12:41:20.371Z","updated_at":"2025-04-30T17:20:55.341Z","avatar_url":"https://github.com/peetzweg.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# notar (npm-package: `notar-cli`)\n\n=\u003e [npmjs.com/package/notar-cli](https://www.npmjs.com/package/notar-cli)\n\nConcept piece of software to interact with smart-contracts on EVM based chains directly from your terminal. This allows for quick access and shortcut building using the shell builtins like [`alias`](https://man7.org/linux/man-pages/man1/alias.1p.html).\n\n![demo](https://user-images.githubusercontent.com/7098556/192083999-e831199f-2479-4ed3-aef9-2f849975f2ae.gif)\n\nCreate custom `token` command to inspect ERC20 tokens:\n\n![demo_alias](https://user-images.githubusercontent.com/7098556/192084005-57dd3ee0-51ef-4f14-9e81-0f9a7ed69ff8.gif)\n\n## How to Install\n\n```sh\nnpm install --global notar-cli\n```\n\nor use it via `npx`\n\n```sh\nnpx notar-cli\n```\n\n## How to Use\n\n```sh\n  Usage\n    $ notar\n\n  Options\n    --address, -a  preselect smart contract address\n    --network, -n  preselect network\n    --abi, -i  preselect abi\n\n  Examples\n    $ notar -n ethereum -a 0x956F47F50A910163D8BF957Cf5846D573E7f87CA -i ERC20\n```\n\n## Configuration\n\n`notar` has an default ethereum RPC setup (`https://rpc.ankr.com/eth`) and packaged with some [ABIs](https://github.com/peetzweg/notar/blob/6647ccdb9b5b6532bcf681580bbb93477a219aa9/packages/cli/src/components/ABISelect.tsx#L8-L13) out of the box.\n\nHowever, `notar` can be configured to your liking by creating a `.notarrc` file in your `$HOME` directory. The configuration should follow the [`ini` format](https://en.wikipedia.org/wiki/INI_file). You can easily add your own ABI files as well as connect to other EVM compatible networks.\n\nExample Config\n\n`~/.notarrc`\n\n```ini\n; Global\nabi_dir=~/.abis ; Folder which contains `ethers` compatible ABIs\n\n; Sections\n[bsc] ; Section header =\u003e network name\nrpc=https://bsc-dataseed.binance.org/ ; rpc url\n\n[polygon]\nrpc=https://rpc-mainnet.matic.quiknode.pro\n\n[moonbeam]\nrpc=https://moonbeam.public.blastapi.io\n```\n\n## Fetch ABIs from Etherscan\n\nNotar is able to fetch ABIs of verified contracts directly from [Etherscan](https://etherscan.io/) and others alike. In order to do this it needs the API url of the scanner and a valid API key. It's setup like this to support all chains which have an Etherscan equivalent.\n\n`~/.notarrc`\n\n```ini\n[ethereum]\nrpc=https://rpc.ankr.com/eth\nscan_url=https://api.etherscan.io/ ; make sure it's the API endpoint url not the actual scanner website url.\nscan_api_key=YOUR_API_KEY\n```\n\n+ [How to aquire an API key from Etherscan and alike?](https://docs.etherscan.io/getting-started/viewing-api-usage-statistics)\n\n+ [What are the `scan_url` endpoints for Etherscan and alike?](https://docs.etherscan.io/getting-started/endpoint-urls)\n\n## Special Thanks\n\nThis cli is built with [ink](https://github.com/vadimdemedes/ink), [abimate](https://github.com/peetzweg/abimate) and [ethers](https://github.com/ethers-io/ethers.js/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeetzweg%2Fnotar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeetzweg%2Fnotar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeetzweg%2Fnotar/lists"}