algoworldnft / algoworld-contracts Goto Github PK

View Code? Open in Web Editor NEW

30.0 2.0 5.0 237 KB

🤖 A collection of Algorand Smart Signatures and Contracts for swaps and trading 🎴

License: MIT License

Python 100.00%

blockchain algorand python pytest algoworld teal nft awesome-algorand

algoworld-contracts's Introduction

📃 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 were created in collaboration with Solution Architect from Algorand (credits @cusma) and audited by TENSET security. Code is provided under MIT license.

Prerequisites

🚀 Overview

AlgoWorld currently offers several smart signatures used for swapping on AlgoWorld Swapper.

If you are looking to install algoworld contracts into your project run the following command:

pip install algoworld-contracts

Example usage

from algoworld_contracts import contracts

# Replace inputParams with real values
asa_to_asa_swap = contracts.get_swapper_teal(
        inputParams.creator_address,
        inputParams.offered_asa_id,
        inputParams.offered_asa_amount,
        inputParams.requested_asa_id,
        inputParams.requested_asa_amount,
        inputParams.incentive_wallet,
        inputParams.incentive_fee,
    )

# asa_to_asa_swap is a string of TEAL code
response = algod.compile(asa_to_asa_swap)
...

Swapper

There are two main types of smart signatures available:

ASA to ASA swap | 🎴↔️🎴: Smart signature that allows performing a swap of any single ASA of specified amount to any other single ASA of specified amount.
- Swap Configuration Proxy 📝: Smart signature that powers the AlgoWorld Swapper by allowing users to issue certain transactions that contain links to swap configuration files stored as .json files on ipfs. Proxy is then used to obtain those ipfs files by grabbing the latest pay transaction using Algorand Indexer queries.
ASAs to ALGO swap | 🎴🎴🎴↔️💰: Smart signature that allows performing a swap of multiple ASAs of specified amount to ALGO of specified amount.

⚙️ Installation

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

Clone the repo

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

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 ❤️

algoworld-contracts's People

Contributors

Stargazers

Watchers

Forkers

ediomi-udoh codinronan eugenennamdi matmilbury bmscis

algoworld-contracts's Issues

Replace `pytest-cov` with `coverage` & enable codecov

The goal is to replace the redundant pytest-cov package with coverage.

Additionally, the pipeline should be updated to inlcude codecov reporting stage.

Improve Multi ASA contract and trim down total compiled size

The goal is to follow up and address comments mentioned in the following PR -> AlgoWorldNFT/algoworld-swapper#18

Swapper contract can fit up to 5 ASAs with PR 18 merged, but can be trimmed down even further and total ASAs per swap can increase to a higher value (~6-10 ASAs).

Wrong default incentive amount

https://github.com/AlgoWorldNFT/algoworld-swapper/blob/888b0024445b1c6b02b9406947ada5e236d21bc1/tests/utils/utils.py#L418

The default incentive amount should be 10000. I suggest to import and use 'INCENTIVE_FEE' directly from here: https://github.com/AlgoWorldNFT/algoworld-swapper/blob/888b0024445b1c6b02b9406947ada5e236d21bc1/src/algoworldswapper.py#L19

Propose and implement auto semantic version increments for `algoworld-contracts` python package

Goal

Propose a mechanism to automatically increase algoworld-contracts version on merge to the repository.
Discuss mechanism in github issue, upon agreement proceed to next step.
Implement the solution, refine github ci yaml so that on each merge (push aciton) to master branch, package version is updated following semver conventions before package is published to pypi. Additionally final step in the pipeline should make a new github pre-release automatically as well as setting the tag equal to package version that was just published.
Open PR against main branch, complete pr review.

An issue will be closed after enhancement is implemented reviewed and merged to main branch.

Further notes

The flow doesn't have to be fully automated, if there is a better, popular pattern for pypi releases for packages on github (that rely on github actions), please describe it in detail before implementation.

stateless ASC1 smart contracts

Stateless ASC1 smart contracts are now called Smart Signatures. Might want to update readme.

Concurrent ASA-to-ASA swaps

Issue
Since the ASA-to-ASA swap requires the offered ASA to be deposited in the Swapper Contract, there is a limitation for those users willing to concurrently swap a card for different possible requested cards.

Example
Let's say a user offers card A accepting either cards B, C or D as possible requested ASA. Since user has just 1 card A is not possible to open multiple requests for card B, C or D at the same time, since the user can only deposit A in one Swapper Contract at time.

Proposal
Adding an Or condition on requested ASA, so that the Swapper Contract could approve concurrent swaps with B, C or D at the same time, in the same Swapper Contract.

Incentive fee sender

https://github.com/AlgoWorldNFT/algoworld-swapper/blob/705d1d2c7fb554e1723711b0ed09b664ad74ffa0/src/algoworldswapper.py#L124

This is not a critical check, but should the contract enforce also that:

Gtxn[INCENTIVE_FEE].sender() == Gtxn[REQUESTED_ASA_XFER].sender()

Otherwise any account could potentially pay for the incentive fee (which is not dangerous for swapper users).

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

chore(deps): update all non-major dependencies (abatilo/actions-poetry, styfle/cancel-workflow-action)
chore(deps): update abatilo/actions-poetry action to v3
chore(deps): update actions/checkout action to v4
chore(deps): update actions/setup-python action to v5
chore(deps): update codecov/codecov-action action to v4
chore(deps): update github/codeql-action action to v3
Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/ci.yaml

styfle/cancel-workflow-action 0.11.0

actions/checkout v3

actions/setup-python v4

abatilo/actions-poetry v2.3.0

codecov/codecov-action v3

.github/workflows/codeql-analysis.yml

actions/checkout v3

github/codeql-action v2

github/codeql-action v2

github/codeql-action v2

.github/workflows/release.yaml

actions/checkout v3

actions/setup-python v4

abatilo/actions-poetry v2.3.0

CasperWA/push-protected v2

pep621

pyproject.toml

poetry

pyproject.toml

Check this box to trigger a request for Renovate to run again on this repository

Decouple swap proxy escrow funding from main `save` transaction group

The goal is to decouple the funding logic from the logic that performs the main save operation (of ipfs note in pay transaction field issued by escrow).

Original suggestion by @cusma - #47 (comment)

After decoupling, a change on algoworld swapper needs to follow to implement a little dialog popup that will appear on wallet's who are making first ever login to algoworld swapper. The popup should take care of initial funding transaction (can be later used to present Terms and Conditions checkbox as well)

Running the sandbox in `dev` mode

I think the sandbox should be run in dev mode to speed up the PR testing process:

https://github.com/AlgoWorldNFT/algoworld-swapper/blob/0323a1a8e12a21b05260282bae1517e8cb9baa6b/.github/workflows/awe-swapper-build-test.yaml#L36