Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-12-23 12:09:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add authenticated calls to Ethereum

Browse source 
Also uses numbered lists for function descriptions.
This commit is contained in:
Luke Parker 2022-07-21 04:06:29 -04:00
parent 004086b85b
commit 9cc35a06ab
2 changed files with 30 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/integrations/Ethereum.md
View file

@ -14,3 +14,25 @@ is the caller. `data` is limited to 255 bytes.
### Out Instructions ### Out Instructions
`data` is limited to 255 bytes. `data` is limited to 255 bytes.
If `data` is provided, the Ethereum Router will call a contract-calling child
contract in order to sandbox it. The first byte of `data` designates which child
child contract to call. After this byte is read, `data` is solely considered as
`data`, post its first byte. The child contract is sent the funds before this
call is performed.
##### Child Contract 0
This contract is intended to enable connecting with other protocols, and should
be used to convert withdrawn assets to other assets on Ethereum.
1) Transfers the asset to `destination`.
2) Calls `destination` with `data`.
##### Child Contract 1
This contract is intended to enable authenticated calls from Serai.
1) Transfers the asset to `destination`.
2) Calls `destination` with `data[.. 4], serai_address, data[4 ..]`, where
`serai_address` is the address which triggered this Out Instruction.

16
docs/integrations/Instructions.md
View file

@ -78,10 +78,10 @@ In Instruction {
where `swap` is a function which: where `swap` is a function which:
- Swaps the incoming funds for SRI. 1) Swaps the incoming funds for SRI.
- Swaps the SRI for `coin`. 2) Swaps the SRI for `coin`.
- Checks the amount of `coin` received is greater than `minimum`. 3) Checks the amount of `coin` received is greater than `minimum`.
- Executes `out` with the amount of `coin` received. 4) Executes `out` with the amount of `coin` received.
For a Bitcoin to Monero swap, Swap Shorthand is expected to generally take: For a Bitcoin to Monero swap, Swap Shorthand is expected to generally take:
@ -115,11 +115,11 @@ In Instruction {
where `swap_and_add_liquidity` is a function which: where `swap_and_add_liquidity` is a function which:
- Swaps half of the incoming funds for SRI. 1) Swaps half of the incoming funds for SRI.
- Checks the amount of SRI received is greater than `minimum`. 2) Checks the amount of SRI received is greater than `minimum`.
- Calls `swap_and_add_liquidity` with the amount of SRI received - `gas`, and 3) Calls `swap_and_add_liquidity` with the amount of SRI received - `gas`, and
a matching amount of the incoming asset. a matching amount of the incoming asset.
- Transfers any leftover funds to `address`. 4) Transfers any leftover funds to `address`.
For adding liquidity from Bitcoin, Add Liquidity Shorthand is expected to For adding liquidity from Bitcoin, Add Liquidity Shorthand is expected to
generally take: generally take: