Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mgthetrain/cardano-blockchain-sample

Sample repository implemented in regards to the Cardano blockchain.
https://github.com/mgthetrain/cardano-blockchain-sample

cardano-blockchain cardano-node cardano-smart-contracts cardano-wallet sample

Last synced: about 1 month ago
JSON representation

Sample repository implemented in regards to the Cardano blockchain.

Awesome Lists containing this project

README 

        
# cardano-blockchain-sample



## Table of Contents



+ [Summary](#summary)

+ [References](#references)

+ [How to use](#how-to-use)



## Summary



Sample repository implemented in regards to the Cardano blockchain.



Copilot: *Smart contracts are self-executing contracts with the terms of the agreement between buyer and seller being directly written into lines of code. They are stored on a blockchain network and automatically execute when certain conditions are met. Here are some examples of smart contract use cases:*

- *Finance: Smart contracts can be used for trading, investing, lending, and borrowing*

- *Healthcare: Smart contracts can be used to store and share medical records securely and efficiently*

- *Gaming: Smart contracts can be used to create decentralized gaming platforms that allow players to earn cryptocurrency rewards* 

- *Real Estate: Smart contracts can be used to automate the process of buying and selling real estate, reducing the need for intermediaries*

- *Legal Industry: Smart contracts can be used to automate legal agreements, such as wills and trusts*



## References



### Cardano basics (e.g. cardano-node and cardano-wallet)



- [Python cardano-tools pip package](https://pypi.org/project/cardano-tools/)

- [Cardano Python Module quickstart](https://cardano-python.readthedocs.io/en/latest/quickstart.html)

- [cardano-wallet](https://github.com/cardano-foundation/cardano-wallet/tree/master)

- [Getting started with Cardano testnets](https://docs.cardano.org/cardano-testnet/getting-started/#:~:text=To%20get%20started%20and%20join,ada%20to%20test%20your%20transactions.)

- [The official Cardano Environment configuration files](https://book.world.dev.cardano.org/environments.html#vasil-dev)



### Deploying smart contracts to Cardano blockchain



- [Smart Contracts](https://developers.cardano.org/docs/smart-contracts/)

- [Plutus Pioneer Program - Part 2: How to “deploy” a Smart Contract in Cardano](https://www.essentialcardano.io/article/plutus-pioneer-program-part-2-how-to-deploy-a-smart-contract-in-cardano)

- [how to deploy smart contract on cardano](https://www.youtube.com/results?search_query=how+to+deploy+smart+contract+on+cardano)



## How to use



### Prerequisite



- Install the [Docker Engine](https://docs.docker.com/engine/install/)

- Install [Python 3 from the official site](https://www.python.org/downloads/) or via package manager (apt, choco, brew)



### Ramp up the docker-compose cluster containing the cardano-node container and cardano-wallet container



Refer to [`Quickstart` section here](https://github.com/cardano-foundation/cardano-wallet/tree/master). Ramp up the docker-compose and select one of the  Cardano Environment:



```sh

# On Unix systems or on Windows OS 10 with Git Bash or WSL

NETWORK=preview docker-compose up -d --build # Preview Testnet (preferred for development)

NETWORK=preprod docker-compose up -d --build # Pre-Production Testnet

NETWORK=mainnet docker-compose up -d --build # Production (Mainnet)

# This will start up the Cardano node and wallet applications and connect to the specified network (mainnet, preview, preprod)

```



### Execute commands within a running container interactively



```sh

docker exec -it  sh

```



### Test connection to the cardano-wallet



```sh

# with curl

curl http://localhost:8090/v2/network/information

# with cli in cardano-wallet container

docker run --network host --rm cardanofoundation/cardano-wallet network information



# Wallet operations

docker run --network host --rm cardanofoundation/cardano-wallet wallet list

docker run --network host --rm cardanofoundation/cardano-wallet wallet delete 

```



### Run Python sample app interfacing with the Cardano wallet



Execute sample app:



```sh

cd cardano-wallet-app

pip install -r requirements.txt

python main.py

```



Execute sample app in a docker container:



```sh

cd cardano-wallet-app

docker build -t python-cardano-sample-app:stable . # Build docker image

docker run --network host --rm python-cardano-sample-app:stable sh "python main.py" # Start a container

```



### Compile Python smart contract



Compile contract:



```sh

cd cardano-smart-contract

pip install -r requirements.txt

opshin build simple-withdraw-contract.py # It checks the presence of a specific signature in the transaction to approve spending funds

opshin build simple-healthcare-contract.py # This smart contract defines a HealthDatum data class that inherits from PlutusData. The HealthDatum class has five attributes: patient_id, doctor_id, diagnosis, treatment, and cost. The validator function checks if the cost attribute of the datum object is greater than zero and if the length of the patient_id and doctor_id attributes is 32 bytes. If any of these conditions are not met, the function raises an AssertionError with an appropriate message.

```



Compile contract in a docker container:



```sh

cd cardano-smart-contract

docker build -t python-cardano-sample-smart-contract:stable . # Build docker image

docker run --rm -v $(pwd)/contract/:/app/build/simple-withdraw-contract/ python-cardano-sample-smart-contract:stable sh "opshin build simple-withdraw-contract.py" # Start a container, It checks the presence of a specific signature in the transaction to approve spending funds

docker run --rm -v $(pwd)/contract/:/app/build/simple-healthcare-contract/ python-cardano-sample-smart-contract:stable sh "opshin build simple-healthcare-contract.py" # Start a container, It checks the presence of a specific signature in the transaction to approve spending funds

```



Smart contracts need to be deployed to the Cardano blockchain. See [Plutus Pioneer Program - Part 2: How to “deploy” a Smart Contract in Cardano](https://www.essentialcardano.io/article/plutus-pioneer-program-part-2-how-to-deploy-a-smart-contract-in-cardano).



### Clear docker resources



```sh

docker rm -f $(docker ps -qa)

docker system prune --volumes --force

```