Trx. Id: 304236d7325b9aed67caa48f4ffb3a8ff362b853874c1bf2d7b7d92e66f7da36
Expiration Time: 2024-02-28T08:06:13.500
ACTIONS
| CONTRACT | NAME | AUTHORIZATION | DATA |
|---|---|---|---|
| labs.wax | editprop | waxpaca.fx active |
road_map : A total 47 425$ (tax included) for 20 weeks is requested to complete the whole proposal. Since estimating a deadline is difficult, if it takes us more than 20 weeks, we are willing to work for the whole year of 2024 to get this done within the budget. If it takes us less than 20 weeks, we will spend the remainder of that 20 weeks polishing things to make them even better. * Open-Source API : 23 571$ - 10 weeks * Deliverable 1/2 (Pools, Markets, Tokens, Trade History, Liquidity HIstory, Smart Order Routing) * Deliverable 2/2 (Statistics, Candlesticks charts, Indexed Rows, Mapped rows, Socket io server) * Documentation : 1192$ - 0.5 weeks * API SDK : 7157$ - 3 weeks * Widget : 9542$ - 4 weeks * Smart Contract : 3578$ - 1.5 weeks * Tutorials : 2385$ - 1 week proposal_id : 191 mdbody : In order to enhance the Wax ecosystem and allow everyone to create an equivalent of WaxOnEdge or other projects relying on trading data, we would like to open-source the API in the hope of making it a standard equivalent to the Atomic API for swaps. The idea is to open-source the API, which was 70 % of the required work to build WaxOnEdge, so other developers can start building on it. There are many tools that could be developed but require too much work ; using WaxOnEdge API there will be no backend work, only frontend. ### OPEN-SOURCE API This won?t be as simple as opening the Github repo of the current API, it will require reworking the architecture to make it robust, redoing some parts that can be improved, writing documentations + tutorials, and also upgrading the code to TypeScript. The current closed-source API has been designed to work in pair with a ship node state\_history plugin to be able to process live data from the blockchain. It can provide : * Pools (Alcor, Taco, Defibox) * Markets * Tokens and their prices * Trade History * Liquidity History * Smart order routing algorithm. * Volume stats + price changes * Candlesticks charts data * Indexed rows (copy of all scopes table updated through table delta) of Alcor positions + market orderbooks * Mapped rows (indexed row browsable by account name) of Alcor Positions / Market Open orders * Socket IO Server for streams of candlestick updates, trades history, volumes stats and orderbooks delta. All those features will be rewritten from scratch in TypeScript to become open-source. The current code is already working in real time, but it will be improved to process full transactions instead of actions (it will allow better tracking of trade history by adding exchange fees, indicate proxied trade by WaxOnEdge smart contract). Also the candlestick chart processing will be improved for better scalability because on busy hours it can get few seconds of delay. ### DOCUMENTATION Writing documentation of all endpoints from the open-source API and allow everyone to migrate from the closed-source one. ### API SDK In addition to the open source api, a TypeScript sdk will be done, it will be similar to any SDK we can find on any CEX and the Alcor sdk. Wrapping all API endpoints into a library. ### WIDGET An open-source TypeScript widget similar to [https://widget.tfm.com/config](https://widget.tfm.com/config) will be made to allow everyone to easily implement the swap api frontend. There will be several options : Iframe, React snippet or pure javascript snippet. ### SMART CONTRACT The current smart contract « swap.we » account on mainnet is not complex, it?s only chaining through swaps and checking received amount for price protection. It will require a small amount of work to add configuration table for the fee and cleaning the code in order to open source it. It will also allow anyone running a public waxonedge api server to configure their own smart contract to be able to collect fees if the smart order routing has been made through their servers. ### TUTORIAL Once everything is done, written + video tutorials will be created to explain how to use the SDK + how to implement the widget. image_url : https://waxonedge.app/og_preview.jpg description : Enhance the Wax ecosystem and allow everyone to create an equivalent of WaxOnEdge or other projects relying on trading data by open-sourcing WaxOnEdge API. title : Open-source WaxOnEdge API ? Trading API category : infra.tools estimated_time : 1 |