Skip to content

llamanodes/ape-llamanodes

Repository files navigation

Quick Start

Use the LlamaNodes provider plugin to interact with blockchains via APIs. This plugin supports the following ecosystems:

  • Ethereum (mainnet and goerli)
  • Base (currently in alpha testing)
  • Polygon
  • BNB Smart Chain
  • Arbitrum
  • Optimism

Dependencies

Installation

via pip

You can install the latest release via pip:

pip install ape-llamanodes

via setuptools

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

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

Quick Usage

First, make sure you have one of the following environment variables set (it doesn't matter which one):

  • WEB3_LLAMANODES_API_KEY
  • WEB3_LLAMANODES_PROJECT_ID
  • WEB3_LLAMARPC_API_KEY
  • WEB3_LLAMARPC_PROJECT_ID

Either in your current terminal session or in your root RC file (e.g. .bashrc), add the following:

export WEB3_LLAMANODES_API_KEY=MY_API_TOKEN

The provider will work without the environment variables, but it uses the free tier which has stricter limits.

To use the LlamaNodes provider plugin in most commands, set it via the --network option:

ape console --network ethereum:mainnet:llamanodes

To connect to LlamaNodes from a Python script, use the networks top-level manager:

from ape import networks

with networks.parse_network_choice("ethereum:mainnet:llamanodes") as provider:
    ...