Quick Start

Chainstack network provider plugins.

This plugin allows using the Ape framework with Chainstack as a node provider in an easy and integrated way.

Ape is an innovative smart contract development and testing framework. It is inspired by Brownie, and it has essentially the same syntax. Still, Ape focuses on a more modular approach, allowing us to build and use external plugins to add functionality.

Table of contents

• Ape Chainstack Plugin
  • Requirements
    • Dependencies
  • Installation
    • Virtual environment
    • Install ape-chainstack via pip
    • Install ape-chainstack via setuptools
  • Quick Usage
  • Development
  • License

Requirements

• Linux or macOS
• Windows Subsystem Linux (WSL) if operating on windows.

Dependencies

• python3 version 3.8 or greater

• python3-dev

  • MacOS. Should already have the correct headers if Python is installed with brew

  • Linux. Install python3-dev with:

  sudo apt-get install python3-dev
  

Note: Always check the Ape docs to find the updated requirements.

Installation

Verify the Python version installed:

Python3 --version

Virtual environment

It is recommended to operate in a virtual environment; you will need to install Ape in the virtual environment if you decide to use one.

Create a virtual environment.

python3 -m venv /path/to/new/environment

Keep in mind that you can place the virtual environment where you prefer.

Then activate it.

source /bin/activate

Install ape-chainstack via pip

You can install the latest release via pip:

pip install ape-chainstack

Install ape-chainstack via setuptools

You can clone the repository and use setuptools for the most up-to-date version:

git clone https://github.com/ApeWorX/ape-chainstack.git
cd ape-chainstack
python3 setup.py install

Verify that the Chainstack plugin was installed correctly with this command:

ape plugins list

It will show a list of all the plugins installed, and Chainstack will be there.

Installed Plugins:
  chainstack    <current version number>

Quick Usage

Follow these steps to sign up on Chainstack, deploy a node, and find your endpoint credentials:

1. Sign up with Chainstack.
2. Deploy a node.
3. View node access and credentials.

Note: At this moment only the Ethereum network is supported.

Create an environment variable with your Chainstack node URL in this format CHAINSTACK_"NETWORK"_URL=ENDPOINT_URL; for example:

export CHAINSTACK_GOERLI_URL=https://nd-11X-26X-16X.p2pify.com/YOUR_API_KEY

Use the command ape networks list to see the networks available:

ethereum  (default)
├── mainnet
│   ├── geth  (default)
│   └── chainstack
├── ropsten
│   ├── geth  (default)
│   └── chainstack
├── kovan
│   └── geth  (default)
├── rinkeby
│   ├── geth  (default)
│   └── chainstack
├── goerli
│   ├── geth  (default)
│   └── chainstack
└── local  (default)
    ├── geth
    └── test  (default)

Use the --network command to access the console using your node; for example:

ape console --network ethereum:goerli:chainstack

Check the Ape docs to see how to select a network.

Now you are ready to use Ape to develop and test your smart contract, checkout the Ape Academy for tutorials.

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.