AMM Module and Front End Proof of Concept
amm, auto market maker, uniswap, pancakeswap, cosmos, bluzelle, stargate, module, trading, exchange
### Prize Title
AMM Module and Front End Proof of Concept
### Prize Bounty
$5,000 USD worth of ERC20 BLZ, at time of payout
### Challenge Description
Bluzelle provides decentralized data services, powered by the Cosmos blockchain. Our services include a key-value-store (CRUD), oracle, and NFT. We are also building toward providing support to EVM (Ethereum Virtual Machine) and Polkadot support for our services. Our bounties reflect our aggressive approach to consistently improve our ecosystem and value proposition.
While the Hackathon has a specific start and end date, we are ok with work continuing after the hackathon, for the chosen winners to finish their projects to our standards.
Setup and demonstrate a working Stargate testnet fork of the Bluzelle network, enabled with the AMM module. Cosmos currently has several AMM modules that potentially can be "pulled off the shelf" and integrated into a Bluzelle chain. Once the AMM module is integrated into Bluzelle, a suitable front-end needs to be also demoed, showing the use of the AMM running on Bluzelle.
In order to accomplish this, you will likely need to have multiple tokens on your project's testnet, so that you can demonstrate trading between them. Please ensure one of these tokens is named as the BLZ token, of course.
We suggest deploying your own fork of the Bluzelle Stargate network with multiple tokens, and create your own downstream fork of the AMM module (like say GravityDex). Alternatively, of course, you can create your own AMM module from scratch. But if you choose to do an AMM fork, please ensure you setup your project so that you can pull down changes from upstream. It is good to be able to benefit from improvements made from the original project developers in their own repo.
You should submit full documentation on how to deploy your PR’s fork of our Stargate testnet and how to configure it, step by step, to work with the other side, as well as explain what tests we can run to prove it works. You should also include all documentation on how to deploy and configure your front-end.
Your demo should show all of the above (both the setup process and usage), and, as a sanity check, also demonstrate that other Bluzelle services (DB, NFT, etc) are still functioning as expected. We will attempt to test and apply the code and steps provided here with our own existing testnets/mainnet, to validate that the AMM is functioning as expected. For example, we will follow your instructions and attempt to add your AMM to one of our testnets, as well as deploy your front-end and validate your AMM works via your front-end.
Our JS library:
To install our libraries:
install @bluzelle/sdk-js with “yarn” or “npm”
### Submission Requirements
The submission should include sufficiently QA’d documentation on how to deploy the service/product, and how to use the submission as per the requirements of the bounty.
These should include documentation on the commands to be used to interact with the submission, and how the submission is configured to work properly with BluzelleDB, etc.
A video demo should be included. It would nice to have a voice-over in English where we can fully understand the submission, but this is not a strict requirement. A computer-generated voice over is ok too, if you prefer.
The demo should also walk through the code and explain all the items that are being provided. The demo should walk through the process of deploying the submission, and how to use it, etc.
It is expected that the documentation is accurate. We will follow your documentation, to properly evaluate the submission. If it is incorrect, we may be unable to fairly evaluate your submission.
Including tests with your submission will greatly improve your chances of winning. We like to run tests that are highly verbose and explicit in terms of what they are doing, so we can gain confidence in the correctness of what you have submitted. If you provide tests and expect us to run them, like everything else, document it well, and ensure that the tests can be run by us -- give us the steps to setup and run the tests.
If the documentation is incomplete or incorrect, there is a possibility that we may not be able to fairly assess the submission, as we will walk through the documentation to validate the project. Due to practical limitations on time and resources, once a project is submitted, we are not able to provide much assistance in correcting a project’s that may not be properly working, nor to inquire to get proper steps, if the documentation that comes with a submission is insufficient.
Your project will be judged based on what you submit. Please submit something that is complete, well thought out, and tested, from a documentation and product features and code quality standpoint. We will do our best to evaluate, but obviously, the easier you make our life, the better the chances are that you win.
WE LOVE VERBOSITY AND DOCUMENTATION. There is no such thing as too much information. Explain what you have built, and please ensure it will run CORRECTLY, when we follow your directions literally. Just doing this alone will vastly improve your chances of victory.
### Judging Criteria
Our goal is to, as part of the evaluation process, fully setup, and use your submission, successfully, and without any major hiccups.
Based on the ease of doing this and the quality of your documentation, product, code, and features, we will choose the winner.
There is no preference to ordering of submissions -- just be sure to submit them on time. Once submitted, we will evaluate and there will not be alot of opportunity for back and forth. Please ensure your submitted documentation and code is complete, enabling us to properly judge it based on its merit.
We will choose the best based on quality. Documentation and properly written code is a large part of the criteria. A project that we cannot deploy ourselves is difficult to give a prize to. We will do our best to contact you, if there is an issue. Practically, we probably won’t have much time to contact you, after submission, to get clarification or to ask you to fix a bug. It ideally should work when we judge it.
Note: While the descriptions given for bounties are quite explicit and even tend to suggest how an actual solution to each problem can be built, you as a developer have the option to architect the solution your own way. We have provided guidance on a solution we see as reasonable, but we are open to considering other solutions. Obviously, we will choose the best overall submission, based on various factors including the elegance of the solution.