Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Balanced docs #420

Open
AntonAndell opened this issue May 23, 2024 · 5 comments
Open

Balanced docs #420

AntonAndell opened this issue May 23, 2024 · 5 comments
Assignees

Comments

@AntonAndell
Copy link
Collaborator

Balanced docs

Loans

Should cover the following topics.

  • Taking loans
  • Repaying loans
  • Reading a position
  • Liquidations
  • Bad debt redemptions
  • Cross chain interactions.
  • Highlight all limits and protections

Router

  • How to create a routed swap. data fromat etc

Crosschain basics/XCall integration

  • How balanced uses xCall
  • what contracts uses xCall
  • overview of contracts on spokes

AssetManager

  • Cover the overall structure and how the spoke and hub versions work together
  • How to bridge tokens and interact with the differnt contract. should be kept general and refer to the correct sections in ex, loans or router on how to format the data for seperate actions.
  • withdrawing tokens
  • Highlight all limits and protections

xCallManager

  • What it does
  • How the spoke xCallManagers can be used to manage spoke contract.
  • How to go through a protocol migration

BnUSD

  • How to transfer accross chains
  • Outline fee logic
  • Do not spend to much on the standard since it will be done by CPS?
@FezBox
Copy link
Collaborator

FezBox commented Jun 17, 2024

Anton is reviewing the docs

@AntonAndell
Copy link
Collaborator Author

For mentioning handleCallMessage on contracts, instead we should say which incoming messages they can handle and what they do. The handleCallMessage is mostly irrelevant i think.
We should probably clean up the language a bit to be less verbose but that is my preference. Devs mostly do not want to read to much about functions. We should also take a bit of a wider stance on what each functions actually does. Looks alot like chatgtp generated a lot of this text since it is very shallow and does not add much to the understanding.

The deposit function on assetManager, it should be explains how the tokens are relayed on the ICON chain. triggering xTokenFallback etc. Which can be used to for example do swaps or deposit collateral. Or for other devs on ICON to understand how to integrate our tokenservice

I think we can remove conclusions.

I think we got enough text giving outlines. What we would need now is to give different usecases and how to do them.

Like how to actually do a swap using mainnet contracts.
A few examples on creating different kinds of data preferably in Javascript
Swap to bnUSD or back
Swap to another chain
Stable swaps
Bridge to ICON
Deposit collateral
Repay debt
Borrow
Withdraw collateral
Then a few examples on each chain how to deposit token and bnUSD (how to use the data created for each scenario)

@parrot9design
Copy link

@AntonAndell Where were you planning to publish this info? Happy to work with you to update the official docs so we can keep everything in one location.

@FezBox
Copy link
Collaborator

FezBox commented Jul 18, 2024

@FezBox to organise meeting to work through pending items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

4 participants