algoworld-contracts 1.2.4

AlgoWorld Smart Contracts and Signatures

📃 About

The following repository hosts the source codes for:

• AlgoWorld Swapper's algorand smart signatures.
• AlgoWorldExplorer's stateful smart contracts for card auctions and card trading. Modified version of OpenNFT's smart contracts.

⚠️ NOTE: These contracts are not formally audited by accredited third parties. However, contracts are a basis for certain functionality on the AlgoWorldExplorer.io platform and were created in collaboration with Solution Architect from Algorand (credits @cusma). Code is provided under MIT license.

Prerequisites

• poetry
• pre-commit
• Algorand Sandbox
• Docker

🚀 Overview

AlgoWorld currently offers stateful contracts used for auction trading on AlgoWorldExplorer and several smart signatures used for swapping on AlgoWorld Swapper.

Swapper

There are two different types of smart signatures available:

• ASA to ASA swap | 🎴↔️🎴:
  Allows performing a swap of any single ASA of specified amount to any other single ASA of specified amount.

• ASAs to ALGO swap | 🎴🎴🎴↔️💰:
  Allows performing a swap of multiple ASAs of specified amount to ALGO of specified amount.

Auction

A set of stateful smart contracts for card auctions and card trading:

• ASAs for ALGO with trades and bidding | 🎴💰🔨:
  Allows trading ASA via auctions, selling or purchasing directly.

⚙️ Installation

This section assumes that poetry and pre-commit are installed and executed from the root folder of this repository.

1. Clone the repo

git clone https://github.com/AlgoWorldNFT/algoworld-contracts

2. Install python requirements

poetry install # install all dependencies
poetry shell # activate virtual env

(OPTIONAL) 3. Configure pre-commit hooks

pre-commit install

If you are not going to setup pre-commit locally, there is a Github Actions plugin that will autoformat your branch if you are opening a PR with commits that contain un-formatted code.

🧪 Testing

Testing assumes that docker-compose is installed and available. Project is relying on pytest-docker-compose plugin that automatically boots up temporary algorand sandbox and destroys the containers after the tests are finished.

(.venv) pytest

You can also include [pytest] into your commit message to trigger the test in CI pipeline on push action (on pr it is triggered automatically).

🚧 Contribution guideline

See CONTRIBUTING.md

⭐️ Stargazers

Special thanks to everyone who forked or starred the repository ❤️