ape-tokens: tokenlists plugin for Ape
Project description
Ape Token Utilities
A series of utilities for working with tokens, based on the py-tokenlists.
Dependencies
- python3 version 3.7 or greater, python3-dev
Installation
via pip
You can install the latest release via pip:
pip install ape-tokens
via setuptools
You can clone the repository and use setuptools for the most up-to-date version:
git clone https://github.com/ApeWorX/ape-tokens.git
cd ape-tokens
python3 setup.py install
Quick Usage
CLI Usage
First, install a token list, such as the 1inch token list, which contains many tokens that you can use:
ape tokens install tokens.1inch.eth
To see all the tokens you can use, run command:
ape tokens list-tokens
To see other available CLI commands, run:
ape tokens --help
Python Usage
One of the main reasons to use the ape-tokens plugin is to have nicer UX for providing token amounts to contract transactions.
For example, let's say you have a smart-contract named MyContract with a function provideLinkToken() that takes a decimal value of LINK tokens.
The following is an example script that deploys the contract and makes a transaction by expressing the value of LINK as 8.23 LINK:
from ape import accounts, project
my_account = accounts[0]
contract = my_account.deploy(project.MyContract)
contract.provideLinkTokens("8.23 LINK")
Alternatively, if you need the converted value returned to you, you can use the convert tool from the root ape namespace:
from ape import convert
convert("100.1234 BAT", int)
Lastly, to get information about a token, including its contract address, you can do so by importing the tokens member from the root ape_tokens namespace:
from ape_tokens import tokens
bat = tokens["BAT"]
print(bat.address)
Development
This project is in development and should be considered a beta. Things might not be in their final state and breaking changes may occur. Comments, questions, criticisms and pull requests are welcomed.
License
This project is licensed under the Apache 2.0.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ape-tokens-0.1.0.tar.gz.
File metadata
- Download URL: ape-tokens-0.1.0.tar.gz
- Upload date:
- Size: 14.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a0cf7e9e7c5e03de8455e231115466b2474811606e9f5e7752f882af6913cef6 |
|
| MD5 | 440ac9147882844edcb8e43c0005e73a |
|
| BLAKE2b-256 | a190e95b0088baeaa9ea65f29c11dcf5d3b8a665ec633f243b4738606eb558dc |
File details
Details for the file ape_tokens-0.1.0-py3-none-any.whl.
File metadata
- Download URL: ape_tokens-0.1.0-py3-none-any.whl
- Upload date:
- Size: 9.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ab66e2ad69440a15d9994d7f703b5d3dec776e3b135f151e3149c7429af25351 |
|
| MD5 | 1ba8647e029139ae43f397dc320fc4a9 |
|
| BLAKE2b-256 | fc07e59a9ff1bafa72b26efa9c2c49b228cdf13937a64aefac3893eb2b539c45 |
