https://github.com/apeworx/ape-addressbook
Address converter plugin: tracking addresses and contracts in projects globally
https://github.com/apeworx/ape-addressbook
ape apeworx ethereum python smart-contracts web3
Last synced: 11 months ago
JSON representation
Address converter plugin: tracking addresses and contracts in projects globally
- Host: GitHub
- URL: https://github.com/apeworx/ape-addressbook
- Owner: ApeWorX
- License: apache-2.0
- Created: 2022-03-20T20:19:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T20:24:55.000Z (over 1 year ago)
- Last Synced: 2025-08-09T10:13:03.250Z (12 months ago)
- Topics: ape, apeworx, ethereum, python, smart-contracts, web3
- Language: Python
- Homepage: https://www.apeworx.io/
- Size: 38.1 KB
- Stars: 7
- Watchers: 4
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Quick Start
Ape plugin that allows tracking addresses and contracts in projects and globally.
## Dependencies
- [python3](https://www.python.org/downloads) version 3.9 up to 3.12.
## Installation
### via `pip`
You can install the latest release via [`pip`](https://pypi.org/project/pip/):
```bash
pip install ape-addressbook
```
### via `setuptools`
You can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:
```bash
git clone https://github.com/ApeWorX/ape-addressbook.git
cd ape-addressbook
python3 setup.py install
```
## Quick Usage
To use the addressbook in a project, add common addresses to your `ape-config.yaml` file like this:
```yaml
addressbook:
shared_account: "0x2192f6112a026bce4047CeD2A16553Fd31E798B6"
```
Then, to use the address, import the addressbook and access it via the alias set in the config:
```python
from ape_addressbook import addressbook
address = addressbook["shared_account"]
```