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

Update docs #91

Merged
merged 43 commits into from
Jul 13, 2023
Merged

Update docs #91

merged 43 commits into from
Jul 13, 2023

Conversation

ethanfrey
Copy link
Collaborator

@ethanfrey ethanfrey commented Jun 28, 2023

Closes #82

Let's make sure they all reflect the current implementation and design.

  • Top level intro
  • Use cases and diagrams
  • Provider overview
  • Vault
  • Local Staking
  • Consumer overview
  • Converter + Price Oracle
  • Virtual Staking + Go Module
  • Review IBC (most recent, likely up to date)

Notes:

  • Changed the concept of Creditor in the Vault doc, for that of Lien Holder. Though Creditor is technically correct, I found it really confusing. Lien Holder is clearer. It also better reflects the current implementation's naming and functions.

@maurolacy maurolacy force-pushed the update-docs branch 2 times, most recently from 3183a02 to c5fab70 Compare June 30, 2023 08:25
@maurolacy maurolacy self-assigned this Jun 30, 2023
@maurolacy maurolacy requested review from hashedone and alpe July 4, 2023 09:02
@maurolacy maurolacy marked this pull request as ready for review July 6, 2023 11:47
Copy link
Collaborator

@alpe alpe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have read most of this now. Provider + Vault missing.
Lot of good updates. I added some notes where more context would be helpful or some terms were not correct in context of IBC

docs/UseCases.md Outdated Show resolved Hide resolved
docs/consumer/Consumer.md Show resolved Hide resolved
docs/consumer/Consumer.md Outdated Show resolved Hide resolved
docs/consumer/Consumer.md Outdated Show resolved Hide resolved
docs/consumer/Consumer.md Outdated Show resolved Hide resolved
docs/ibc/ControlChannel.md Outdated Show resolved Hide resolved
2. Instantiate external staking contract on the Provider chain (referencing IBC port of the converter).
3. Create IBC channel from Provider to Consumer.
4. Apply to Consumer governance to provide a virtual staking max cap to the associated virtual staking contract,
so that this connection may have voting power.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO max cap limits should be in place before the IBC connection. Technically not mandatory but it would be easy to miss when people see the IBC packets from the Converter

Copy link
Collaborator

@maurolacy maurolacy Jul 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Max cap limits are in place before the IBC connection. Max cap is effectively zero until and unless governance increases it.

Update: AFAIK this is a custom query of type VirtualStakeQuery::BondStatus (See

pub fn bond_status(&self, contract: String) -> StdResult<BondStatusResponse> {
let full_denom_query = VirtualStakeQuery::BondStatus { contract };
self.querier.query(&full_denom_query.into())
}
).
This behaviour (returning zero if no gov auth) must be properly enforced by the blockchain answering said query.

docs/ibc/ControlChannel.md Outdated Show resolved Hide resolved
docs/ibc/Overview.md Outdated Show resolved Hide resolved
docs/ibc/Overview.md Outdated Show resolved Hide resolved
@maurolacy maurolacy merged commit 0fc09f2 into main Jul 13, 2023
2 checks passed
@maurolacy maurolacy deleted the update-docs branch November 6, 2023 08:27
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

Successfully merging this pull request may close these issues.

Review and modernize documentation
3 participants