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

Internal review of version v0.0.0 #23

Closed
cyphersnake opened this issue Apr 7, 2023 · 3 comments
Closed

Internal review of version v0.0.0 #23

cyphersnake opened this issue Apr 7, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@cyphersnake
Copy link
Contributor

A full review of this crate must be carried out.

The focus should be on how well the crate understands how to easily integrate with the Debridge-Solana infrastructure, send a message or check an incoming claim-message. Also how correctly and accurately the terms from the debridge glossary are used in our documentation.

It is implied that this repo must be sent to the integrator and, together with the debridge documentation, be sufficient for full on-chain integration.

For any questions, ideas, edits, reviewers can contact me directly or create an issue

@JosepBove
Copy link

JosepBove commented Apr 7, 2023

(I will update this comment with thigs that I see / doubts that I might have)

  1. Why does sendWithMessage doesn't accept a parameter of adding extra flags?

    pub fn with_message(

  2. What does bump: _ do and how is it related to service information about pubkey of current account in SubmissionAccount

  3. Why's the naming reserved_flags instead of having the normal deBridge naming as flags under all the scope.

@cyphersnake
Copy link
Contributor Author

  1. We have a definition of a "message" (i.e. a transfer without liquidity) which is not explicitly documented in any way. There are flags for it which are expected on the other side. It is for example used in the dln protocol when execution fee == 0. However, without specification and validation that any other flag is not needed in such a case, this method looks ambiguous. Let's add an Add a description of the "message" concept #24 to describe this concept.

  2. https://www.anchor-lang.com/docs/pdas

  3. This is the original name of this field, in evm it was renamed later and in various projects there are still reserved flags (as an example https://github.com/debridge-finance/debridge-protobuf/blob/main/debridge_common.proto#L46). Need a task from @artyukh to unitedly cut the old name out of all projects, if renaming in evm is conventional.

@JosepBove If these are all your questions, we can close this task and re-open when #23 is closed and item 3. on this list is clarified

@cyphersnake cyphersnake added the documentation Improvements or additions to documentation label Apr 10, 2023
@JosepBove
Copy link

Yeah, let's close it, ping me once #24 is closed and the third item is discussed.

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

No branches or pull requests

3 participants