Use a running Appchain

Overview

This quick-start guide helps you interact with an Appchain. Please make sure you are running a Madara Appchain in a separate terminal before continuing.

We will prepare an account and use that to interact with an example contract.

Prepare an account

Account creation in Madara, and the SN Stack in general, works quite differently from traditional blockchains like Ethereum. In our Appchain, the process involves:

1. Generating an account address.
2. Sending assets to the newly created address so the account can be deployed.
3. Deploying the account from itself.

Since the account must be funded before deployment, you first need to know its address to send assets. Since we are using an Appchain, the required assets can be bridged from the settlement layer.

Generate account data

First, let's generate the account data.

The required parameters for the command are:

• Account type
  • Used value: oz
  • Use a generic OpenZeppelin account type
• Appchain RPC URL
  • Used value: http://localhost:9945
  • This is the default URL.
• Class hash for the account
  • Used value: 0x5c478ee27f2112411f86f207605b2e2c58cdb647bac0df27f660ef2252359c6
  • This is a class hash for an OpenZeppelin account. This hash is already declared in the Appchain.
• Account name
  • Used value: account-for-guide
  • This is the name we will use in this guide for our account.

The full command is:

sncast account create --type oz \
--url http://127.0.0.1:9945 \
--class-hash 0x5c478ee27f2112411f86f207605b2e2c58cdb647bac0df27f660ef2252359c6 \
--name account-for-guide --silent

Note the returned account address. You will now need to bridge assets to this address.

Bridge assets to the address

Go to the bridging guide and bridge Eth to the address you received in the previous section. Remember to bridge from the settlement layer to the Appchain. You will need to modify the guide's default command to use a different target address.

Once the address has Eth, we can start deploying an account to that address.

Luckily, the account address is stored in an account file in your computer. From now on we can reference the account only by its name.

Deploy the account

Once the account has been created and it has assets, it still needs to be deployed to the Appchain.

The required parameters for the command are:

• Appchain RPC URL
  • Used value: http://localhost:9945
  • This is the default URL.
• Account name
  • Used value: account-for-guide
  • This is the same name used above. The underlying address is not relevant.
• Fee token
  • Used value: eth
  • Use Appchain version of Eth to pay for transaction fees.

The full command is:

sncast account deploy --url http://127.0.0.1:9945 --name account-for-guide --fee-token eth

Contract interaction

In this section you will learn how to deploy a contract and interact with it.

Prepare an example contract

First we need to prepare an example smart contract.

An example contract is introduced in the use a running devnet guide's section prepare your contract. Please follow that section for preparations and return here once you have compiled the contract.

Declare your contract

At this point, the contract needs to be declared to the network.

The required parameters for the command are:

• Account name
  • Used value: account-for-guide
  • This is the same name as was used above.
• Appchain RPC URL
  • Used value: http://localhost:9945
  • This is the default URL.
• Fee token
  • Used value: eth
  • Use Appchain version of Eth to pay for transaction fees.
• Contract name
  • Used value: Balance
  • The name of our example contract we want to declare.

The full command is:

sncast --account account-for-guide declare --url http://localhost:9945 --fee-token eth --contract-name Balance

Note the declared class hash. It may take up to a minute for the declaration to be available in the Appchain.

Deploy it

You are now ready to deploy the contract.

The required parameters for the command are:

• Account name
  • Used value: account-for-guide
  • This is the same name as was used above.
• Salt for contract deployment
  • Used value: 1
  • Use a hardcoded salt value so the deployment address is deterministic.
• Appchain RPC URL
  • Used value: http://localhost:9945
  • This is the default URL.
• Fee token
  • Used value: eth
  • Use Appchain version of Eth to pay for transaction fees.
• Class hash
  • Used value: 0x02666eeed059c91ebe80f6ca66bdb1d5ebb598d0e96e49383bf736c0f6bc7395
  • The class hash declared earlier.

The full command is:

sncast --account account-for-guide deploy --salt 1 \
--url http://localhost:9945 \
--fee-token eth \
--class-hash 0x02666eeed059c91ebe80f6ca66bdb1d5ebb598d0e96e49383bf736c0f6bc7395

Note the deployed contract's address.

Issue transactions

The contract keeps track of an imaginary balance. First, let's query the initial balance.

Query balance

The required parameters for the command are:

• Appchain RPC URL
  • Used value: http://localhost:9945
  • This is the default URL.
• Contract address
  • Used value: 0x0496048f48618558e0e0beef4c47d8c7f703210fbc548b864b03210b3547fed2
  • The contract address deployed earlier. You may need to change this to reflect the deployment address.
• Function name
  • Used value: get
  • This is the name of the function we are calling inside the example smart contract.

The full command is:

sncast call \
--url http://localhost:9945 \
--contract-address 0x0496048f48618558e0e0beef4c47d8c7f703210fbc548b864b03210b3547fed2 \
--function get

You should see value 5 as the initial value (in hexadecimal format).

Increase balance

Let's try to increase this value by a transaction.

The required parameters for the command are:

• Account name
  • Used value: account-for-guide
  • This is the same name as was used above.
• Appchain RPC URL
  • Used value: http://localhost:9945
  • This is the default URL.
• Contract address
  • Used value: 0x0496048f48618558e0e0beef4c47d8c7f703210fbc548b864b03210b3547fed2
  • The contract address deployed earlier. You may need to change this to reflect the deployment address.
• Fee token
  • Used value: eth
  • Use Appchain version of Eth to pay for transaction fees.
• Function name
  • Used value: increase
  • This is the name of the function we are calling inside the example smart contract.
• Function arguments
  • Used value: 3
  • This is the argument we are passing to the function. We pass 3 because we want to increment the counter by three.

The full command is:

sncast --account account-for-guide invoke \
--url http://localhost:9945 \
--fee-token eth \
--contract-address 0x0496048f48618558e0e0beef4c47d8c7f703210fbc548b864b03210b3547fed2 \
--function increase --arguments "3"

If you query the balance again, you should see value 8.

Congratulations, you have successfully modified the state of your contract and Appchain!