A repo dedicated to showing how to make smart contracts in a purely pythonic environment
Note: This repo has been recently updated to use Sepolia.
This is a repo to work with and use Chainlink smart contracts in a python, apeworx & vyper environment. If you're brand new to Chainlink, check out the beginner walk-through in remix to learn the basics.
It shows how to use these frameworks and languages as well as the following Chainlink features:
It's recommended that you've gone through the apeworx getting started documentation before proceeding here.
git --version
and you see a response like git version x.x.x
python --version
or python3 --version
and get an output like: Python x.x.x
pipx
is different from pip
pipx --version
and see something like x.x.x.x
pipx
but you can follow the ape documentation for other installation methods.ape --version
and see an output like x.x.x
git clone https://github.com/smartcontractkit/apeworx-starter-kit
cd apeworx-starter-kit
ape plugins install alchemy vyper
Run tests:
ape test
If you run ape --help
you'll get an output of all the tasks you can run.
The following will deploy your contracts to a temporary ape test network. Additionally, if on a local network, it will deploy mock Chainlink contracts for you to interact with. If you'd like to interact with your deployed contracts, skip down to Interacting with Deployed Contracts.
After your script completes, the network deletes itself.
ape run scripts/deploy_price_feed_consumer.py
ape run scripts/deploy_keepers_consumer.py
ape run scripts/deploy_vrf_consumer.py
In order to deploy to a local, adhoc, mainnet, or testnet, you'll need to first create accounts. For the scripts we currently have, it'll default to the "default" account. If you'd like to have the scripts point to a different account, go to helper_functions.py
and change the get_account
function to look for your account instead of `default.
Ape doesn't support .env
files or keeping your private keys in plaintext, which means it's harder for you to release your private key to the world!
To import an account into ape, run the following:
ape accounts import default
Where default
will be the name of your account. Ape will then prompt you for your private key and password, and encrypt it on your computer. The only way to use this key moving forward will be to decrypt the key with your password.
Ape doesn't come with a built-in local network like hardhat or ganache, so we will have to use our own. Ape also prefers users to build plugins for working additional networks, you can find a list of the plugins on their github.
We recommend using Foundry's Anvil as your local network.
You'll know you did it right if you can run anvil --version
and get an output like anvil 0.1.0 (f016135 2022-07-04T00:15:02.655418Z)
Run:
anvil
You'll see an output with many private keys.
If you'd like to use this as your main "default" account, run the following:
ape accounts delete default
And then, re-import your private key from anvil by following the importing an account guide
Note: This will only work since the chain Id is
31337
for anvil! For working with non-local networks, please see Deploy to a mainnet or testnet
ape run scripts/deploy_price_feed_consumer.py --network http://127.0.0.1:8545
You'll be prompted for your password.
Please see import an account. And be sure your account has plenty of testnet or mainnet tokens if working on live network. See this faucet for testnet tokens.
Since we are working with Alchemy, create an environment variable called WEB3_ALCHEMY_PROJECT_ID
or WEB3_ALCHEMY_API_KEY
. If using a linux or mac environment, you can set it by running:
export WEB3_ALCHEMY_PROJECT_ID=MY_API_TOKEN
Note: At this time, it's really tricky to change networks with Ape. If you want to use another network ape doesn't have a plugin for, you can use an adhoc network as shown above.
helper_config.py
If you're using a network not covered in helper_config.py
be sure to add it.
ape run scripts/deploy_price_feed_consumer.py --network ethereum:sepolia:alchemy
To interact with contracts, we recommend using the console.
ape console --network ethereum:sepolia:alchemy
Or, you can follow along and run the scripts to see the end-to-end functionality.
ape run scripts/deploy_price_feed_consumer.py --network ethereum:sepolia:alchemy
ape run scripts/read_price_feed.py --network ethereum:sepolia:alchemy
You can do that with the script, or by going to the UI at vrf.chain.link
ape run scripts/create_subscription.py --network ethereum:sepolia:alchemy
Update your helper_config.py
with your subscription Id.
Deploy vrf consumer
ape run scripts/deploy_vrf_consumer.py --network ethereum:sepolia:alchemy
Request a random number and wait for a response
ape run scripts/request_and_read_randomness.py --network ethereum:sepolia:alchemy
ape run scripts/deploy_keepers_consumer.py --network ethereum:sepolia:alchemy
You can go to keepers.chain.link
After a delay, run:
ape run scripts/read_counter.py --network ethereum:sepolia:alchemy
And it should be updated!
Contributions are always welcome! Open a PR or an issue!
Thank You!