Roamin
Roamin's Blog

Roamin's Blog

Deploy you smart contract to the Koinos blockchain

(FOR FREE! ๐Ÿคฏ)

Roamin's photo
Roamin
ยทMay 13, 2022ยท

8 min read

Table of contents

  • Koinos CLI installation
  • Generate a wallet
  • Get some tKoin from the Discord faucet
  • Deploy the smart contract
  • Interact with the smart contract
  • Update a smart contract
  • Summary

Today we're going to learn how to deploy a smart contract to the Koinos blockchain. We won't be writing any code, so if you don't have a compiled Koinos smart contract ready to deploy, I invite you to check my previous blog where we learned how to "Create your first Koinos smart contract in minutes".

Like most other blockchains, Koinos has a testnet available, so we're going to use it to create a test account, top it up with some tKoin, which is the native test token of the blockchain, and deploy our smart contract.

Koinos CLI installation

The Koinos team provides a CLI that will help you manage your keys/wallets and also will allow you to interact with smart contracts. The official repository is hosted at github.com/koinos/koinos-cli.

First, let's download the CLI that's compatible with our Operating System (OS), to do that:

  • simply head over to the release page of the Github repo github.com/koinos/koinos-cli/releases
  • download the .zip file that's compatible with your system, in my case, it is the zip file called koinos-cli.v0.3.1.osx.zip
  • once downloaded, extract the content of the zip file and you should end up with an executable file called:
    • koinos-cli for Linux and MacOS users
    • koinos-cli.exe for Windows users

That's all for the installation, now, let's start it to make sure it's working properly. Open a terminal/command window where the above executable file is located and type:

./koinos-cli -v

If you're getting a permission error like:

โžœ  tutorial ./koinos-cli 
zsh: permission denied: ./koinos-cli

try to run this command first, and then run the first command again:

chmod a+x koinos-cli

If the CLI is correctly installed and ready to used you should see something like this in your terminal:

โžœ  tutorial ./koinos-cli -v
open .env: no such file or directory
v0.3.1

Generate a wallet

In order to interact with the Koinos blockchain we need to have a wallet. To create one, simply type the following commands:

start the CLI

./koinos-cli

and then use the create command

create my.wallet azerty

where:

  • create is the command used to create a new wallet
  • my.wallet is the name of the wallet that you want to create, it can be anything you want
  • azerty in this case is the password for my wallet, this password is basically used to encrypt your wallet file on your computer. (The wallet file contains the private key of the wallet)

You should see something like this printing in your terminal:

๐Ÿšซ ๐Ÿ” > create my.wallet azerty
Created and opened new wallet: my.wallet
Address: 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4

the Address 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4 is what's also called the public key of your wallet. (but yours will be different)

Get some tKoin from the Discord faucet

Now that we have generated a wallet, let's top it up with some tKoin! To do that you'll need to have a Discord account. If you don't have one, you can easily create one at discord.com/register

Once you have your Discord account setup, koin the Koinos Discord server by clicking on the following link: discord.gg/gMGMADsmfk

You might be asked to introduce yourself or go through some anti-bot verification. Once the verification completed, you should be able to have access to the Koinos Discord channels, and there's one channel in particular that we're going to use, it's called faucet and it's located in the Testnet category:

Screen Shot 2022-05-13 at 3.37.14 PM.png

Just join this channel and type the following command:

!faucet 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4

where 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4 is the address of the wallet we just generated (so yours will be different)

The Koinos Testnet Faucet bot should reply in a few seconds with a message stating that 100 tKoin were just sent to the address you provided:

Screen Shot 2022-05-13 at 3.38.50 PM.png

Now, let's wait a few seconds and let's go back to our terminal where our koinos-cli and our wallet is open and type the following command:

connect http://api.koinos.io:8080

should output:

๐Ÿ”“ > connect http://api.koinos.io:8080
Connected to endpoint http://api.koinos.io:8080

This command will connect the CLI to a Koinos RPC node, in this case it's the Koinos node. Then type:

balance

This should output the following in your terminal:

๐Ÿ”“ > balance
100 tKOIN
100 mana

If not, just wait a couple of minutes, transaction don't happen instantaneously so it might take some time before it will show the correct balance.

Alright, we're now all set to deploy our contract!

Deploy the smart contract

Once you have some tKoin available, you can just type the following command to upload your smart contract onto the blockchain:

upload myawesomecontract/build/release/contract.wasm myawesomecontract/abi/myawesomecontract.abi

where:

  • upload is the name of the command to upload a smart contract
  • myawesomecontract/build/release/contract.wasm is the path to you smart contracts's WASM file
  • myawesomecontract/abi/myawesomecontract.abi is the path to you smart contracts's ABI file

Uploading the ABI file is not mandatory although highly encouraged if you plan on distributing your smart contract as this will allow users to interact with your contract in seconds!

This command should output a transaction id as well as the Mana used to upload the contract:

๐Ÿ”“ > upload myawesomecontract/build/release/contract.wasm myawesomecontract/abi/myawesomecontract.abi
Contract uploaded with address 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4
Transaction with ID 0x122096042fb2e2c085eb4e78cb80a4933e6cda21ebf65722e2c0f283f39a9ba40f2a containing 1 operations submitted.
Mana cost: 0.38643078 (Disk: 16472, Network: 17562, Compute: 177948)

Very important note here, the wallet/address you use to upload a contract will be the address of the contract itslef. This means that the address14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4 is the address of the wallet we created earlier, but it's also the address of our contract now. Smart contracts are just users in Koinos. Also, right now, the block size limit on the Koinos blockchain is set to 200kb which means that your contract's WASM files cannot exceed this size. (if it does, you'll probably have to rething the architecture of your contract by splitting the logic into several smaller contracts)

As you can see, the upload cost us 0.38643078 Mana, which means we didn't spend any actual tKoin, which also means that we basically uploaded the contract for free!!!! (since Mana is a property of tKoin that regenerates overtime)

Let's now check our transaction on a blockchain explorer, we'll use "Koino Explorer", created by @ederaleng_coc. Let's head over to: v3.koinosexplorer.com/tx/0x122096042fb2e2c0..

where 0x122096042fb2e2c085eb4e78cb80a4933e6cda21ebf65722e2c0f283f39a9ba40f2a is the transaction ID that was printed in our terminal. If you get a 500 Internal Server Error. this means that either you didn't type the transaction ID correctly, or the transaction hasn't been processed yet. Just reload until the transaction details show up. This is what shows up for my transaction:

Screen Shot 2022-05-13 at 4.01.19 PM.png

Let's click on the Operations tab:

Screen Shot 2022-05-13 at 4.04.04 PM.png

On this tab you can see:

  • our contract id, which in my case is 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4
  • the bytecode of our smart contract (encoded in base64)
  • the content of the abi file that we uploaded

Interact with the smart contract

Now that our smart contract and our abi file have been successfully uploaded onto the Koinos blockchain (the testnet to be precise), let's start interacting with it!

In the Koinos CLI, type the following command to register your contract:

register mycontract 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4

where:

  • register is the command used to register the contract with the CLI. Register basically tells the CLI that you want to load the ABI file of a smart contract
  • mycontract is the alias for the smart contract, that's what you'll type in the CLI to access the smart contract's functions that are available in the ABI file (this is an arbitrary name, it doesn't have to be the real name of the contract you're trying to register)
  • 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4 is the address of the smart contract you want to register

this should output something like:

๐Ÿ”“ > register mycontract 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4
Contract 'mycontract' at address 14JP7iJP1CtGvGhgczMwBE7i9igsKvNdK4 registered

Now, if you type mycontract in the CLI, you should see the functions available in the smart contract:

Screen Shot 2022-05-13 at 4.33.37 PM.png

If you're using the smart contract that we built in the article "Create your first Koinos smart contract in minutes", you should see 2 functions, add and hello.

Let's try the add function. Type the following in the CLI:

mycontract.add 40 2

this will output:

๐Ÿ”“ > mycontract.add 40 2
value:42

Yes, 42!!!

Update a smart contract

By default, smart contracts are upgradeable on Koinos! To do so, it's super simple, just follow the same steps we used to upload the contract, which basically means, you just need to use the upload command and pass the path to new WASM and ABI file as arguments.

Summary

Alright, so we just saw how to upload a smart contract to the Koinos blockchain, the first 2 steps only need to be done once. Once your wallet is setup with some tKoin on it, you can iterate your development super quickly by simply using the upload command of the CLI. As you can see, you can start creating and interacting with a smart contract in literally just minutes! You don't need to build any frontend or you don't need to create additional scripts, the Koinos CLI is all you need! One last thing, as you saw, to upload our smart contract, we only had to use our Mana, which means that we didn't have to spend any money to upload it, FREE SMART CONTRACTS ๐Ÿคฏ๐Ÿคฏ๐Ÿคฏ

ย 
Share this