Aquafarm withdraw/deposit support - Githubissues

orca-so / typescript-sdk

The Orca SDK contains a set of simple to use APIs to allow developers to integrate with the Orca platform.

155 stars 49 forks source link

Aquafarm withdraw/deposit support #41

Closed ghost closed 3 years ago

ghost commented 3 years ago

Context

Current withdraw/deposit does not support aquafarm (reward earning pool token). It only works with base pools (none reward earning)
Implement logic to
- Convert pool tokens to aquafarm tokens when depositing
- Revert aquafarm tokens to pool tokens when withdrawing

Notes

Installed @orca-so/aquafarm
Added a new getFarm() api
Added a new OrcaFarm interface and implementation for interacting with farm: getFarmBalance, getFarmSupply, deposit, withdraw
Added new constants in orcaFarmConfigs conforming to OrcaFarmParams

Usage

OrcaPool Deposit -> buidl deposit pool txn -> if aquafarm exists, get ref of farm object -> build farm deposit txn -> run txn
OrcaPool Withdraw -> if aquarfarm ref exists, get ref of farm & build withdraw txn, build pool withdraw txn -> run txn

Tests

Tested deposit() and verified that aquafarm tokens were received; also verified on the website.
Tested withdraw() and verified that aquafarm tokens could be redeemed back to tokenA and tokenB.

ghost commented 3 years ago

@odcheung - thanks for the review! Agree, that having aquafarm as a separate api makes more sense, as it will be more extensible for the future (e.g. when it comes to double-dip). Pushed a new commit that extracts the farm logic and created a new farm api, along with new constants.