cw-swaggy – Round 6

This grant was approved through the Quadratic Funding (QF) program. The Atom Accelerator DAO contributes $20,000 USDC to the matching pool for each round of the QF program, and this page states the amount a project received from our allocation. Any amount contributed from the matching pool to this particular project is based on public voting and contributions. As such, AADAO is neither endorsing nor otherwise indicating support for this project. Learn more about the Quadratic Funding program. Some projects might have also been funded through another of our funding programs. View our FAQs on how we deal with potential double-funding.

Generate an interactive documentation for your smart contract with a single command. The generated documentation allows the users to call your smart contract’s functions through a graphical interface familiar from Web2 Development.

The Problem

Usually in enterprise environments, it is very important to have an up-to-date documentation for projects. There’s two main reasons for that:

Being able to show work progress on backend components of the system to non-technical people, which also includes demo-ing the product to the client or investors, as well as allowiing the QA team to interact with the backend in a straightforward way
Providing a guideline for the frontend team, which helps with integrating backend services into the end product.

In this case, we are treating blockchain smart contracts as a backend for a DApp, as that is essentially what they are in practice.

The Solution

Swagger UI and OpenAPI standard is widely used for APIs and backend documentation/testing in Web2, but we don’t currently have a similar solution for Web3. As such, why reinvent the wheel, when we can repurpose the tools that people are already familiar with for the new needs?

That is the goal of CosmWasm Swaggy – to bring Swagger UI with all of its features to the Cosmos Ecosystem.

Swaggy in Practice

The goal of the project is to allow for the following operations on CosmWasm smart contracts:

Documentation of all major endpoints that a contract exposes publically: Instantiate, Execute messages, and Query messages
Support for executing each message according to schema defined in the CW project – query and publish tx to the chain through Swagger
Provide the option to adjust the network (mainnet, testnet, localhost, etc) and a chain selector
Provide an option to deploy the contract bytecode and instantiate the contract directly from the Swagger UI
Integrate the Keplr wallet to provide a smooth experience for submitting transactions to the blockchain

Technical Deep Dive

More technical breakdown of all the features, technologies used, and assumptions will be available on GitHub.

More about this grant