Validating and deploying a Smart Contract with REST API
Introduction
This article illustrates how to use REST API to work with the Smart Contracts on the Credits Blockchain Platform.
A Smart Contract is a program written in Java that compiles in byte code and is deployed on the blockchain. Each successful Smart Contract launch results in saving its new state in the blockchain. The next launch of the Smart Contract uses its previous state.
Description of cURL Parameters
-X POST - type of HTTP request, in this case we use POST. More info here: Wikipedia
-H “accept: application/json”
-H “Content-Type: application/json” - Specification for the transferred parameters and response to be in JSON format
-d {parameters} - With this key, we specify the data transferred with the request. Let’s look at them in more detail:
“authKey”: “” - Authorization key. Not used at present, should be passed “”
“networkAlias”: “Mainnet” - We specify the network, where the request should be executed. Either Testnet or Mainnet.
“sourceString": "source code" - Here we specify the source code of a smart contract.
Code
For compatibility check, REST API provides a “Validate” function. The easiest way to invoke it is to use CURL tool. Example of CURL tool uses is provided below.
Let's try it out with the following code !
curl -X POST "http://apinode.credits.com/api/contract/validate" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"authKey\":\"\",\"networkAlias\":\"Mainnet\", \"sourceString\":\"package com.example.contract;import com.credits.scapi.annotations.*;import com.credits.scapi.v2.SmartContract;import com.credits.scapi.v1.*;mport java.math.BigDecimal; public class my extends SmartContract { public my() { } @Override public String payable(BigDecimal amount, byte[] userData) { return null; } public String hello() { return "Hello!"; }}\"}"Response
Upon successful compilation REST should return JSON response containing the status “success”: “true”. Example of the successful launch in cURL is provided below.
{ "deploy":{ "sourceCode":"package com.example.contract;import com.credits.scapi.annotations.*;import com.credits.scapi.v2.SmartContract;import com.credits.scapi.v1.*;mport java.math.BigDecimal; public class my extends SmartContract { public my() { } @Override public String payable(BigDecimal amount, byte[] userData) { return null; } public String hello() { return Hello!; }}", "byteCodeObjects":[ ] }, "tokenStandard":0, "success":true, "message":null}Great now we know that the smart contract is validated so let's move on the deployment of the Contract !
Deployment
To deploy a Smart Contract you should sign the resulting byte code with a digital signature. The following Python code allows us deploying the Smart contract in 2 steps:
- Compile a Smart Contract into byte code
- Sign the resulting byte code and sent the transaction for Smart Contract deployment
import jsonimport base58checkimport ed25519from struct import *contract_code = """package com.example.contract;import com.credits.scapi.annotations.*;import com.credits.scapi.v2.SmartContract;import com.credits.scapi.v1.*;import java.math.BigDecimal;public class my extends SmartContract { public my() { } @Override public String payable(BigDecimal amount, byte[] userData) { return null; } public String hello() { return "Hello!"; }}"""priv = '2SeqBtsQpoSD7DJQpmY6ZnfDosg9VGndoaPSMSh8hrTALySWPEXxQKMrnAVy79U2GxWNAXm6dnmzYdNUToJpLzFm' #put here private Key in base58 formpubl = 'AU8iyCcpwRehfsMv2myrykxWjAsxyrpQbPTaymAxjDYF' #put here public Key in base58 formproposed_fee = 0.1headers = { 'Content-type': 'application/json' , 'Accept': 'application/json' , 'Content-Encoding': 'utf-8' }url = 'http://apinode.credits.com/api/Transaction/Pack'data = { "authKey": "" , "NetworkAlias":"TestNet" , "networkIp":"" , "networkPort":"" , "MethodApi" : "SmartDeploy" , "PublicKey":publ , "SmartContractSource":contract_code , "Fee":proposed_fee}answer_pack = requests.post(url, data=json.dumps(data), headers=headers)if answer_pack.status_code == 200: ts = json.loads(answer_pack.text) transaction_packed = ts['dataResponse']['transactionPackagedStr'] src_priv = base58check.b58decode(priv) signing_key = ed25519.SigningKey(src_priv) # Create object for calulate signing signature_code = signing_key.sign(base58check.b58decode(transaction_packed)) signature = base58check.b58encode(signature_code).decode('utf-8') url = 'http://apinode.credits.com/api/Transaction/Execute' data = { "authKey": "" , "NetworkAlias":"TestNet" , "MethodApi" : "SmartDeploy" , "PublicKey":publ , "SmartContractSource":contract_code , "TransactionSignature":signature , "Fee":0.1 } answer_execute = requests.post(url, data=json.dumps(data), headers=headers) ts = json.loads(answer_execute.text)print(ts)Response
After the script execution, you should receive an output similar to the one below (except the addresses).
{ "transactionInnerId":5, "amount":0, "dataResponse":{ "publicKey":"FAe2em5gQkUaFcWQ1nKVXy2nUwW51p2pgzsZuo1bNpzn", "transactionPackagedStr":"None" }, "listItem":[ ], "transactionInfo":"None", "listTransactionInfo":"None", "blockId":0, "transactionId":"13707845.1", "flowResult":"None", "success":True, "message":"None"}Great now you deployed a smart contract on the Credits Blockchain !
Execution status shows the deployment was successful (‘success’: True)
Transaction number in the Blockchain 'transactionId': '13707845.1'
Smart Contract address FAe2em5gQkUaFcWQ1nKVXy2nUwW51p2pgzsZuo1bNpzn.