EPIC: Centrifuge SDK

[sophialittlejohn]

Centrifuge SDK

MVP Scope

• transfer tranche tokens
• request deposit

First steps

1. discover Viem - how to connect to node --> create repo outside of monorepo centrifuge-sdk
2. deployment setup --> ask Guillermo
3. new multicall not linked to etherjs - maybe viem has an implementation? viem has a multicall implementation
4. base class that provides default, accepts signer as arg, be multichain/chain agnostic for fetching, chain-specific for transactions, explore using observables in SDK and expose promise AND observable API for users
5. caching layer in SDK - learn how to leverage RxJs for caching. Learn from useCentrifugeQuery shareReplayWithDelayedReset
6. Subquery integration --> are subscriptions possible?
7. Utilities: CurrencyBalance, Rate, Tokens etc ideally without BN.js instead using native BigInt
8. Docs!!
9. Tests - ideally TDD. Figure out which test runners to use and how to fork chain for best results (Tenderly)

Questions

• how do we query pools without polkadot connection? Should we use centrifuge-js to query pools under the hood?
• how do we want to handle onboarding
• do we want to integrate IPFS pinning and reading into SDK?

TBD

• Adopt new terminology (share pools instead of pools, subscriptions instead of investments, loans?)
• Set up sync where new info is shared about upcoming changes

Protocol specs

• https://www.notion.so/Centrifuge-Protocol-V1-1112eac24e178040bdfafb6a8e9b090c

SDK specs

• https://www.notion.so/Centrifuge-SDK-1052eac24e178011be84c97ea772536b

We want each type to be a class with getters and setter.
Group by: Entity (Loan, Pool, AccountPermissions)

// borrow
const pool = await cent.getPool(poolId) // returns type Pool that contains methods to fetch anything pool related
const loans = await pool.getLoans() // returns type Loan[] where each loan contains methods for anything loan related
// examples
const loan = loans.find(...) 
await loan.borrow(amount)
await loan.repay(amount)