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

Docs/integration #240

Merged
merged 13 commits into from
May 19, 2021
Merged

Docs/integration #240

merged 13 commits into from
May 19, 2021

Conversation

radtonev
Copy link
Contributor

@radtonev radtonev commented May 17, 2021

Detailed description:
Added documentation on how to integrate with the bridge

Special notes for your reviewer:

Checklist

  • Documentation added
  • Tests updated

failfmi and others added 6 commits April 22, 2021 11:38
# Conflicts:
#	app/services/transfers/service.go
#	e2e/e2e_test.go
#	e2e/setup/config.go
Signed-off-by: radtonev <[email protected]>
@radtonev radtonev assigned radtonev and failfmi and unassigned failfmi May 17, 2021
# Integration with Hedera <-> EVM-chain bridge
The Bridge provides users with functionality to transfer HBAR or HTS tokens from Hedera to EVM-based chain or Wrapped HBAR and Wrapped Tokens from EVM-based chain to Hedera. The Bridge is operated by registered validators that provide signatures for every requested transfer. The transfer is processed when the majority of validators verify the transfer (supermajority).

## 1. Hedera -> EVM-chain
Copy link
Member

Choose a reason for hiding this comment

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

I think that this document should be focused on what exactly should be done by the integrator step-by-step.
So it will be better if we do not have 1.1 How it works, but rather ->

  • Step 1. Initiate transfer of HBAR/HTS
  • Step 2. Wait for confirmation
  • Step 3. Claim Asset on EVM chain

The goal would be for someone to read the document and know what he has to do in order to integrate

docs/integration.md Outdated Show resolved Hide resolved
docs/integration.md Outdated Show resolved Hide resolved
docs/integration.md Outdated Show resolved Hide resolved
docs/integration.md Outdated Show resolved Hide resolved
docs/integration.md Outdated Show resolved Hide resolved
docs/integration.md Outdated Show resolved Hide resolved
@Daniel-K-Ivanov Daniel-K-Ivanov marked this pull request as ready for review May 18, 2021 06:24
radtonev and others added 7 commits May 18, 2021 16:20
Signed-off-by: radtonev <[email protected]>
Signed-off-by: radtonev <[email protected]>
Signed-off-by: radtonev <[email protected]>
Signed-off-by: Daniel Ivanov <[email protected]>
Signed-off-by: Daniel Ivanov <[email protected]>
@Daniel-K-Ivanov Daniel-K-Ivanov merged commit 4ad87d5 into main May 19, 2021
@Daniel-K-Ivanov Daniel-K-Ivanov deleted the docs/integration branch May 19, 2021 08:58
svetlio8 pushed a commit that referenced this pull request Nov 18, 2021
* feat: sign and store router address

Signed-off-by: failfmi <[email protected]>

* fix: transfer data check

Signed-off-by: failfmi <[email protected]>

* fix: check if fee exists

Signed-off-by: failfmi <[email protected]>

* e2e: add router address to expected transfer

Signed-off-by: failfmi <[email protected]>

* Draft documentation

Signed-off-by: radtonev <[email protected]>

* Draft documentation

Signed-off-by: radtonev <[email protected]>

* Draft documentation

Signed-off-by: radtonev <[email protected]>

* Draft documentation

Signed-off-by: radtonev <[email protected]>

* Update integration.md

* add feedback on the integration docs

Signed-off-by: Daniel Ivanov <[email protected]>

* resolve TODOs

Signed-off-by: Daniel Ivanov <[email protected]>

* add docs to read me

Signed-off-by: Daniel Ivanov <[email protected]>

Co-authored-by: failfmi <[email protected]>
Co-authored-by: Daniel Ivanov <[email protected]>
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.

3 participants