ape-tokens: tokenlists plugin for Ape
Project description
Quick Start
A series of utilities for working with tokens, based on the py-tokenlists
.
Dependencies
- python3 version 3.8 up to 3.12.
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)
Project details
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
Hashes for ape_tokens-0.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1a38628b2fae301233dec7d7659959fe1a8543698c56c476236f32df03ccdb4 |
|
MD5 | 65e8667b85b0e1984709711dbbaccf5e |
|
BLAKE2b-256 | 81a5e30dc8ea520be36854952180b27654867acb8a9502828549cdc6178df112 |