Deploying an Etch Contract with the Python Ledger API

The following tutorial assumes that you already have a constellation instance running on port 8000 and that you have installed the the Python API.

Details for running a node are here.

Details of the Python API are here.


We're going to keep this simple, and refer to FIP-1, our basic token generation contract.

The FIP-1 contract implements the following functions:

  • totalSupply() : UInt256 gets the total token supply.
  • balanceOf(owner: Address): UInt256 gets the balance of an account having address owner.
  • transfer(to: Address, value: UInt256) : Bool sends value amount of tokens to address to.

Deploying the contract:

We're going to create a new script, let's call it


Let's get the initial things out of the way, let's import:

from fetchai.ledger.api import LedgerApi, TokenApi
from fetchai.ledger.contract import Contract
from fetchai.ledger.crypto import Entity, Address
from contextlib import contextmanager

Connect to network

Then, connect to a local running node:

api = None
if api is None:
    api = LedgerApi(host="", port=8000)

Setup accounts

Now, we'll read in our etch contract, and create a couple of entities to test with:

with open ('contract.txt', 'r') as ct:
    contract_text =

print (contract_text)

# create our first private key pair
entity1 = Entity()
address1 = Address(entity1)

# create a second private key pair
entity2 = Entity()
address2 = Address(entity2)

Create balance

To test, we need a balance:

api.sync(api.tokens.wealth(entity1, 10000))
(Note this will functionality will be removed and a faucet will take it's place).

Create the smart contract object

We create the contract object, and deploy it:

contract = Contract(contract_text, entity1)
api.sync(contract.create(api, entity1, 4000))

Query the contract

The named argument has to be the exact name of the variable we're accessing in balanceOf for example, if the state had a named var of "userX" the below code would be: print (contract.query(api, 'balanceOf', userX=address1)) this is an important note for other functions you might create.

print (contract.query(api, 'totalSupply'))
print (contract.query(api, 'balanceOf', address=address1))

Make a transaction

Using the two entities we created earlier, and their addressed we transact 200 from entity1 to entity2, then check the balance:

# transfer from one to the other using our newly deployed contract
tok_transfer_amount = 200
fet_tx_fee = 160
api.sync(contract.action(api, 'transfer', fet_tx_fee, [entity1], address1, address2, tok_transfer_amount))

#Query new balance: 
print (contract.query(api, 'balanceOf', address=address1))

You can find the source here.