This document is a summary description of a new project managed and funded by the Permissionless Software Foundation. It contains the information for developers who are interested in this contract. Interested developers should reach out via the PSF Telegram channel. They will be required to complete a screening task (at the bottom) before being considered for this contract.
Scope of Work
The purpose of this project is to transfer tokens between the BCH and AVAX blockchains. The deliverable should be a protocol specification and software implementation that can burn received SLP tokens on the BCH chain and mint new tokens on the AVAX chain, and also burn received tokens on the AVAX chain while having them be minted on the BCH chain.
The developer selected to do this work will be rewarded a weekly stipend, equivalent to $200 USD per week, paid in PSF tokens. The work may be terminated after three months, but may be continued if additional funding can be found. The developer is expected to put in at least 20 hours per week of effort towards the project.
A workgroup will be formed under the PSF TSC. The developer selected to do the work is expected to meet with the workgroup once per week over Zoom and present a status update to the members of the workgroup. The workgroup will help mentor the developer and guide them around technical issues. The following tools will be used to manage work and communicate information:
- This Trello Board will be used to manage individual tasks and communicate on-going project status.
- GitHub Issues will be used to flag bugs and record potential improvements.
- A Telegram chat room will be used for the workgroup to coordinate on a daily basis.
- message.FullStack.cash will be used for private communication, using encrypted messages.
The selected developer should meet all these requirements:
- Fluent in the English language
- Experienced mocking unit tests using sinon.
- They should have read Mastering Bitcoin or Mastering Bitcoin Cash and have a firm grasp of blockchain concepts like UTXOs, the Bitcoin transaction format, and using block explorers.
Roadmap of Milestones
The following list are the milestones that should be achieved as development progresses, to complete the scope of work. The completion of each milestone should be accompanied with unit and integration tests, and unit tests should maintain near-100% test coverage.
- Done: slp-avax-bridge
- Create a mintable SLP token on the BCH blockchain.
- Add a method to slp-avax-bridge that can mint new SLP tokens.
- Add a method to slp-avax-bridge that can burn SLP tokens.
- Create a new class library in slp-avax-bridge for AVAX. Add avalanch.js as a dependency.
- Create a mintable token on AVAX.
- Add a method to slp-avax-bridge that can mint a new AVAX token on the X-chain.
- Add a method to slp-avax-bridge that can burn the AVAX token.
- Fork the token-liquidity app to a ‘token-transfer app’, and add slp-avax-bridge as a dependency.
- Modify the token-liquidity app so that it mints a new AVAX token when receiving the SLP token. This is opposed to the current functionality which sends BCH in response to receiving an SLP token.
- Replace the BCH receiving library with one that mints a new SLP token when an AVAX token is received.
- Add a PSF specification document describing the protocol for transferring tokens between the blockchains.
- Add installation and usage instructions to the README of the token-transfer app.
- Stand up a simple web page, and customize the token-transfer app, to enable users to transfer PSF tokens between the AVAX and BCH blockchains.
- Mastering Bitcoin Cash
- Getting started with bch-js
- Introduction to AVAX
- AVAX developer documentation
- How we manage remote teams
Use the bch-js-examples repository to create a new SLP token: https://github.com/Permissionless-Software-Foundation/bch-js-examples
You can watch the video on the examples page to see how it's done: https://fullstack.cash/examples
Send at least one of your newly created tokens to this SLP address: simpleledger:qzjgc7cz99hyh98yp4y6z5j40uwnd78fw5napqqkm4
Want to leave feedback or discuss this blog post? Please leave comments on this Member.cash thread: