Docs

Docs

  • Develop
  • Validate
  • Integrate
  • Learn

›erdpy

Welcome to Elrond

  • Welcome to Elrond

Technology

  • Architecture Overview
  • Glossary
  • Entities
  • Chronology
  • Secure Proof of Stake
  • Adaptive State Sharding
  • The Elrond WASM VM
  • Cross Shard Transactions

Wallet

  • Wallets - Overview
  • Web Wallet
  • Maiar Web Wallet Extension
  • Webhooks
  • Ledger

Tokens

  • Native Tokens
  • ESDT tokens
  • NFT tokens

Validators

  • Validators - Overview
  • System Requirements
  • Install a Mainnet Node

    • Scripts & User config
    • Installing a Validator Node
    • Optional Configurations
    • How to use the Docker Image

    Install a Testnet/Devnet Node

    • Scripts & User config
    • Installing a Validator Node
    • Manage a validator node
    • How to use the Docker Image

    Manage your keys

    • Validator Keys
    • Wallet Keys
    • Protecting your keys

    Staking, Unstaking, Unjailing

    • Staking, unstaking and unjailing
    • Staking
    • Unjailing
    • The Staking Smart Contract
  • The Delegation Manager
  • Convert An Existing Validator Into A Staking Pool
  • Merging A Validator Into An Existing Delegation Smart Contract
  • Rating
  • Elrond Node upgrades
  • Node redundancy
  • Import DB
  • Node CLI
  • Node Databases
  • Useful Links & Tools
  • FAQs

Developers

  • Developers - Overview
  • Tutorials

    • Build a dApp in 15 minutes
    • Build a Microservice for your dApp
    • The Crowdfunding Smart Contract (part 1)
    • The Crowdfunding Smart Contract (part 2)
    • The Counter Smart Contract
    • Custom Wallet Connect

    Signing Transactions

    • Signing Transactions
    • Tools for signing
    • Signing programmatically

    Gas and Fees

    • Overview
    • EGLD transfers (move balance transactions)
    • System Smart Contracts
    • User-defined Smart Contracts

    Developer reference

    • The Elrond Serialization Format
    • Smart contract annotations
    • Smart contract modules
    • Smart contract to smart contract calls
    • Smart Contract Developer Best Practices
    • Code Metadata
    • Smart Contract API Functions
    • Storage Mappers
    • Rust Testing Framework
    • Rust Testing Framework Functions Reference
    • Rust Smart Contract Debugging
    • Random Numbers in Smart Contracts

    Developers Best Practices

    • Basics
    • BigUint Operations
    • The dynamic allocation problem
    • Multi-values

    Mandos tests reference

    • Mandos Overview
    • Mandos Structure
    • Mandos Simple Values
    • Mandos Complex Values
    • Embedding Mandos code in Go
  • Constants
  • Built-In Functions
  • Account storage
  • Setup a Local Testnet
  • Set up a Local Testnet (advanced)
  • Creating Wallets

SDK and Tools

  • SDKs and Tools - Overview
  • REST API

    • REST API overview
    • api.elrond.com
    • Gateway overview
    • Addresses
    • Transactions
    • Network
    • Nodes
    • Blocks
    • Virtual Machine
    • Versions and Changelog
  • Proxy
  • Elasticsearch
  • erdpy

    • erdpy
    • Installing erdpy
    • Configuring erdpy
    • erdpy CLI
    • Deriving the Wallet PEM file
    • Sending bulk transactions
    • Writing and running erdpy scripts
    • Smart contract interactions

    erdjs

    • erdjs
    • Cookbook
    • Extending erdjs
    • Writing and testing interactions
    • Migration guides
    • Signing Providers for dApps
  • erdgo
  • erdcpp
  • erdjava
  • erdkotlin
  • erdwalletjs-cli

Integrators

  • Integrators - Overview
  • EGLD integration guide
  • ESDT tokens integration guide
  • Observing Squad
  • Accounts Management
  • Creating Transactions
  • Querying the Blockchain

Installing erdpy

How to install erdpy

erdpy is currently supported on Linux and MacOS. Some of its features might work on Windows as well, although using erdpy on Windows is neither recommended, nor supported at this time.

Prerequisites

Before installing erdpy, please make sure you have a working Python 3 environment:

  • 3.8 or later on Linux and MacOS

Smart contracts written in C require the ncurses library routines for compiling. Install them using the following:

For Linux:

sudo apt install libncurses5

For MacOS:

brew install ncurses

Install using erdpy-up (recommended)

In order to install erdpy using the erdpy-up installation script, run the following commands in a terminal:

wget -O erdpy-up.py https://raw.githubusercontent.com/ElrondNetwork/elrond-sdk-erdpy/master/erdpy-up.py
python3.8 erdpy-up.py

This will create a light Python virtual environment (based on venv) in ~/elrondsdk/erdpy-venvand also include ~/elrondsdkin your $PATH variable (by editing the appropriate .profile file).

Troubleshooting and other notes

On Ubuntu 20.04, if you receive the error: invalid command 'bdist_wheel' - run the following command, then retry erdpy-up:

pip3 install wheel
python3 erdpy-up.py

On MacOS, you can switch to Python 3.8 as follows:

brew info python@3.8
brew unlink python
brew link --force python@3.8
python3 --version

Install without erdpy-up

If you'd like to install without relying on the easy installation script, please read this section. Otherwise, feel free to skip it.

Make sure you also have pip3 installed.

Prepare PATH

In order to have the command erdpy available in your shell after install, make sure you adjust the PATH environment variable as described below:

On Linux in ~/.profile:

export PATH="$HOME/.local/bin:$PATH"

On MacOS in ~/.bash_profile or ~/.zshrc if you’re using zsh:

export PATH=$HOME/Library/Python/3.8/bin:${PATH}
add the right version

In the snippet above, replace 3.8 with your actual MAJOR.MINOR version of Python. This can be found by running:

python3 -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')"

You may need to restart your user session for these changes to take effect.

Install and smoke test

In order to install erdpy, issue the following command:

pip3 install --user --upgrade --no-cache-dir erdpy

Troubleshooting

If you encounter encoding-related issues at installation time, such as: UnicodeDecodeError: 'ascii' codec can't decode byte, then please set PYTHONIOENCODING before running the installation command:

PYTHONIOENCODING=utf8 pip3 install --user --upgrade --no-cache-dir erdpy
← erdpyConfiguring erdpy →
  • Prerequisites
  • Install using erdpy-up (recommended)
    • Troubleshooting and other notes
  • Install without erdpy-up
    • Prepare PATH
    • Install and smoke test
    • Troubleshooting
Made withby the Elrond team.
GithubChat
Main siteWalletExplorerBridgeDocsGrowthMaiarMaiar Exchange