Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peetzweg/notar
interactive CLI to read and call contracts deployed to EVM chains - bring your own ABIs.
https://github.com/peetzweg/notar
blockchain cli ethereum evm
Last synced: 5 days ago
JSON representation
interactive CLI to read and call contracts deployed to EVM chains - bring your own ABIs.
- Host: GitHub
- URL: https://github.com/peetzweg/notar
- Owner: peetzweg
- Created: 2022-07-02T20:46:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-27T11:06:10.000Z (9 months ago)
- Last Synced: 2024-10-29T21:10:25.189Z (16 days ago)
- Topics: blockchain, cli, ethereum, evm
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/notar-cli
- Size: 5.95 MB
- Stars: 30
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# notar (npm-package: `notar-cli`)
=> [npmjs.com/package/notar-cli](https://www.npmjs.com/package/notar-cli)
Concept 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).
Create custom `token` command to inspect ERC20 tokens:
## How to Install
```sh
npm install --global notar-cli
```
or use it via `npx`
```sh
npx notar-cli
```
## How to Use
```sh
Usage
$ notar
Options
--address, -a preselect smart contract address
--network, -n preselect network
--abi, -i preselect abi
Examples
$ notar -n ethereum -a 0x956F47F50A910163D8BF957Cf5846D573E7f87CA -i ERC20
```
## Configuration
`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.
However, `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.
Example Config
`~/.notarrc`
```ini
; Global
abi_dir=~/.abis ; Folder which contains `ethers` compatible ABIs
; Sections
[bsc] ; Section header => network name
rpc=https://bsc-dataseed.binance.org/ ; rpc url
[polygon]
rpc=https://rpc-mainnet.matic.quiknode.pro
[moonbeam]
rpc=https://moonbeam.public.blastapi.io
```
## Fetch ABIs from Etherscan
Notar 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.
`~/.notarrc`
```ini
[ethereum]
rpc=https://rpc.ankr.com/eth
scan_url=https://api.etherscan.io/ ; make sure it's the API endpoint url not the actual scanner website url.
scan_api_key=YOUR_API_KEY
```
+ [How to aquire an API key from Etherscan and alike?](https://docs.etherscan.io/getting-started/viewing-api-usage-statistics)
+ [What are the `scan_url` endpoints for Etherscan and alike?](https://docs.etherscan.io/getting-started/endpoint-urls)
## Special Thanks
This 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/).