CI/CD for smart contracts in Blockchain / Solidity - Mini Project: Build & Apply

CI/CD for Smart Contracts

📖 Scenario: You are working on a blockchain project that uses smart contracts. To make sure your smart contracts are always tested and deployed safely, you want to set up a simple Continuous Integration and Continuous Deployment (CI/CD) pipeline.This pipeline will automatically test your smart contract code and deploy it to a test network when changes are made.

🎯 Goal: Build a basic CI/CD pipeline script that:Defines the smart contract source filesSets a test network configurationRuns tests on the smart contractsDeploys the smart contracts to the test network

📋 What You'll Learn

Create a list of smart contract files

Add a variable for the test network name

Write a command to run smart contract tests

Write a command to deploy smart contracts to the test network

Print deployment success message

💡 Why This Matters

🌍 Real World

Blockchain developers use CI/CD pipelines to automate testing and deployment of smart contracts, ensuring code quality and faster updates.

💼 Career

Understanding CI/CD for smart contracts is valuable for blockchain developer roles and DevOps positions supporting blockchain projects.

1

Define smart contract files

Create a list called contract_files with these exact smart contract filenames: "Token.sol", "Crowdsale.sol", and "Wallet.sol".

Blockchain / Solidity

# Create a list called contract_files with the given filenames
# Your code here

Hint

Use square brackets [] to create a list and include the filenames as strings inside.

2

Set test network configuration

Add a variable called test_network and set it to the string "sepolia" to specify the Ethereum test network.

Blockchain / Solidity

contract_files = ["Token.sol", "Crowdsale.sol", "Wallet.sol"]
# Set the test network name in test_network
# Your code here

Hint

Assign the string "sepolia" to the variable test_network.

3

Run smart contract tests

Write a line that runs the command npx hardhat test using Python's os.system function to execute tests on the smart contracts.

Blockchain / Solidity

import os

contract_files = ["Token.sol", "Crowdsale.sol", "Wallet.sol"]
test_network = "sepolia"
# Run smart contract tests using os.system
# Your code here

Hint

Use os.system to run shell commands from Python.

4

Deploy contracts and print success

Write a line that runs the command npx hardhat run scripts/deploy.js --network sepolia using os.system to deploy the contracts to the test network. Then write a print statement that outputs exactly "Deployment to sepolia successful!".

Blockchain / Solidity

import os

contract_files = ["Token.sol", "Crowdsale.sol", "Wallet.sol"]
test_network = "sepolia"
os.system("npx hardhat test")
# Deploy contracts to sepolia network
# Print deployment success message
# Your code here

Hint

Use os.system to run the deploy command with the --network sepolia option. Then print the success message exactly.

Practice

1. What is the main purpose of using CI/CD pipelines for smart contracts?

easy

A. To manually write smart contract code faster

B. To avoid writing tests for smart contracts

C. To store smart contracts on a local machine only

D. To automate compiling, testing, and deploying smart contracts

Solution

1. Step 1: Understand CI/CD role in smart contracts

   CI/CD pipelines automate repetitive tasks like compiling, testing, and deploying smart contracts to reduce errors and save time.

2. Step 2: Compare options with CI/CD purpose

   Only To automate compiling, testing, and deploying smart contracts describes automation of compile, test, and deploy steps, which is the core of CI/CD.

3. Final Answer:

   To automate compiling, testing, and deploying smart contracts -> Option D

4. Quick Check:

   CI/CD automates smart contract lifecycle steps = B [OK]

Hint: CI/CD means automate build, test, deploy steps [OK]

Common Mistakes:

• Thinking CI/CD is for manual coding
• Confusing storage with deployment
• Skipping testing in CI/CD

2. Which of the following is the correct syntax to trigger a GitHub Actions workflow on every push to the main branch for smart contract CI/CD?

easy

A. on: push:
branches: [main]

B. trigger: push main

C. on_push: main_branch

D. when: push to main

Solution

1. Step 1: Identify correct GitHub Actions event syntax

   The correct syntax uses 'on:' followed by the event type and branches list, like 'on: push:\n branches: [main]'.

2. Step 2: Compare options to GitHub Actions docs

   Only on: push: branches: [main] matches the official YAML syntax for triggering workflows on push to main branch.

3. Final Answer:

   on: push: branches: [main] -> Option A

4. Quick Check:

   GitHub Actions uses 'on: push' with branches list = A [OK]

Hint: GitHub Actions uses 'on:' with event and branches [OK]

Common Mistakes:

• Using incorrect keywords like 'trigger' or 'when'
• Wrong indentation or missing colon
• Confusing event names

3. Given this GitHub Actions step in a smart contract pipeline:

 - name: Compile Contract
   run: solc --bin MyContract.sol -o build/

What will this command do?

medium

A. Run tests on MyContract.sol

B. Deploy MyContract.sol to blockchain network

C. Compile MyContract.sol and output binary files to build/ directory

D. Delete build/ directory

Solution

1. Step 1: Understand solc compile command

   The command 'solc --bin MyContract.sol -o build/' compiles the Solidity file and outputs binary files to the specified build directory.

2. Step 2: Match command purpose to options

   Only Compile MyContract.sol and output binary files to build/ directory correctly describes compiling and outputting binaries, while others describe unrelated actions.

3. Final Answer:

   Compile MyContract.sol and output binary files to build/ directory -> Option C

4. Quick Check:

   solc --bin compiles and outputs binaries = C [OK]

Hint: solc --bin compiles Solidity to binary output [OK]

Common Mistakes:

• Confusing compile with deploy
• Assuming tests run automatically
• Thinking it deletes files

4. You have this GitHub Actions step to deploy a smart contract:

 - name: Deploy Contract
   run: truffle migrate --network mainnet

But the deployment fails with an error about missing network configuration. What is the likely cause?

medium

A. The 'truffle migrate' command is misspelled

B. The 'mainnet' network is not defined in truffle-config.js

C. The GitHub Actions runner lacks internet access

D. The smart contract code has syntax errors

Solution

1. Step 1: Analyze error about missing network configuration

   The error indicates the deployment tool cannot find the 'mainnet' network settings in the configuration file.

2. Step 2: Identify cause of missing network config

   If 'mainnet' is not defined in truffle-config.js, deployment fails. Syntax errors or internet issues cause different errors, and the command spelling is correct.

3. Final Answer:

   The 'mainnet' network is not defined in truffle-config.js -> Option B

4. Quick Check:

   Missing network config causes deployment failure = D [OK]

Hint: Check truffle-config.js for network definitions first [OK]

Common Mistakes:

• Blaming code syntax for network config errors
• Ignoring configuration files
• Assuming internet issues without checking config

5. You want to ensure your smart contract CI/CD pipeline only deploys contracts after all tests pass and on the 'release' branch. Which GitHub Actions workflow snippet correctly enforces this?

hard

A. on:
push:
branches: [release]
jobs:
build:
steps:
- run: npm test
deploy:
needs: build
if: success()
steps:
- run: truffle migrate --network mainnet

B. on:
push:
branches: [main]
jobs:
deploy:
steps:
- run: truffle migrate --network mainnet

C. on:
pull_request:
branches: [release]
jobs:
test:
steps:
- run: npm test
deploy:
steps:
- run: truffle migrate --network mainnet

D. on:
push:
branches: [release]
jobs:
deploy:
steps:
- run: truffle migrate --network mainnet

Solution

1. Step 1: Identify branch trigger and job dependencies

   The pipeline triggers on push to 'release' branch. It runs tests first in 'build' job, then deploys only if tests succeed using 'needs: build' and 'if: success()'.

2. Step 2: Compare options for correct workflow logic

   on: push: branches: [release] jobs: build: steps: - run: npm test deploy: needs: build if: success() steps: - run: truffle migrate --network mainnet correctly sequences test then deploy with condition and branch filter. Others miss test step, branch, or job dependency.

3. Final Answer:

   on: push: branches: [release] jobs: build: steps: - run: npm test deploy: needs: build if: success() steps: - run: truffle migrate --network mainnet -> Option A

4. Quick Check:

   Test before deploy on release branch = A [OK]

Hint: Use job dependencies and branch filters in workflow [OK]

Common Mistakes:

• Deploying without testing first
• Triggering on wrong branch
• Missing job dependencies or conditions