TO USE:
Clone the sdk repo right next to the figswap repo. add the dependencies to the figswap package.json `yarn add @sdk:../sdk/
Issue / Change Tags: Use and collate these to mark groups of issues / changes throughout the project. Use them like so:
Demo Feature Roadmap (by priority):
- Get wrapping and unwrapping working. (done)
- Get liquidity adding and removing working. (Not started. Relies on working Liquidity Factory)
- Get swaps working. Relies on 1 and 2. (Research In progress. Relies on Liquidity adding and removing).
- Multicaller (Done)
- If this works we can deploy SDK and change interface to use it.
pattern:
// Note (<dev>): <Issue Tag> <Issue Description>
// <Deprecated / Changed line >
Example:
// Note (al): #SdkChange: Implemented interim SDK for testing
// import { ChainId } from `@sushsiswap/core-sdk`
import { ChainId } from `../sdk/core-sdk/ChainId`
#SdkChange
: Designates where an SDK import has been redeclared. Should be used for experimental / interim updates to the SDK
#MetamaskOnly
: Designates where a line has been deprecated or changed due to deprecating unused code for the demo - Note: Deprecated, but should be used to look for places where wallet functionality has been deprecated.
#WallabyOnly
: Designates where a line supporting chains other than Wallaby has been deprecated and commented out - Should be used with #FilecoinMainnet TODO tag for guiding Mainnet implementation
Quality of Life Updates:
-
#Sentry
Indicates where Sentry has been deprecated from Sushi's deployment. We need to figure out our own config and implement it -
#Jest
We have not even tried using the test framework they have in place, we need to research it for speeding up dev later -
#StrAPI
The original fork used StrAPI for some media (not really sure what) but this might be something to look into
Backend TODOs and Tags:
-
#ReactIssue
-
#FilecoinManinnet
Where Implementation of Filecoin is required for Production -
#SdkPublish
Where imports to any sdk needs to updated with published version - For some reason there's a lingering Invalid Hash error that keeps raising randomly in dev mode. We need to fix this.
-
#Contributing
Write up documentation for contributing to the project (Mininmum specs for implementing different features on different chains, Adding new chains, tokens, etc)
Front End TODOs and Tags:
-
#LogoBanner
Implement a re-sizable logo banner for the top of the page / sidebar -
#LogoBackground
logo motif on background of pages -
#AccountButtons
Change account info buttons to match Vitaly's designs -
#DisconnectButton
Add a disconnect button in the sidenav -
#MobileHeaderReady
Implement folding header that renders based on useDesktopMediaQuery -
#Footer
Implement footer that renders based at +100vh -
#PortfolioRender
Portfolio renders under the nav bar, we should fix this. -
#NetworkModal
Change login userflow to match Vitaly's designs (open intermediary modal to hide page, deprecate wrong network modal, add disconnect to bottom of sidebar) -
#SwapSettingsAnimation
Implement animation for swap settings (low priority) -
#Copy
Copy changes to make disclaimers / branding more accurate / better (low priority)