mirror of
https://github.com/serai-dex/serai.git
synced 2025-01-03 09:29:46 +00:00
Slight documentation tweaks
This commit is contained in:
parent
d1474e9188
commit
d57fef8999
4 changed files with 10 additions and 5 deletions
|
@ -100,6 +100,7 @@ impl Deployer {
|
|||
let to_block = BlockNumberOrTag::Latest;
|
||||
|
||||
// Find the first log using this init code (where the init code is binding to the key)
|
||||
// TODO: Make an abstraction for event filtering (de-duplicating common code)
|
||||
let filter =
|
||||
Filter::new().from_block(0).to_block(to_block).address(Address::from(Self::address()));
|
||||
let filter = filter.event_signature(abi::Deployment::SIGNATURE_HASH);
|
||||
|
|
|
@ -29,6 +29,7 @@ pub enum ScannerEvent<N: Network> {
|
|||
outputs: Vec<N::Output>,
|
||||
},
|
||||
// Eventuality completion found on-chain
|
||||
// TODO: Move this from a tuple
|
||||
Completed(
|
||||
Vec<u8>,
|
||||
usize,
|
||||
|
|
|
@ -53,6 +53,7 @@ pub trait Scheduler<N: Network>: Sized + Clone + PartialEq + Debug {
|
|||
txn: &mut D::Transaction<'_>,
|
||||
utxos: Vec<N::Output>,
|
||||
payments: Vec<Payment<N>>,
|
||||
// TODO: Tighten this to multisig_for_any_change
|
||||
key_for_any_change: <N::Curve as Ciphersuite>::G,
|
||||
force_spend: bool,
|
||||
) -> Vec<Plan<N>>;
|
||||
|
|
|
@ -2,14 +2,16 @@
|
|||
|
||||
### Addresses
|
||||
|
||||
Ethereum addresses are 20-byte hashes.
|
||||
Ethereum addresses are 20-byte hashes, identical to Ethereum proper.
|
||||
|
||||
### In Instructions
|
||||
|
||||
Ethereum In Instructions are present via being appended to the calldata
|
||||
transferring funds to Serai. `origin` is automatically set to the party from
|
||||
which funds are being transferred. For an ERC20, this is `from`. For ETH, this
|
||||
is the caller.
|
||||
In Instructions may be created in one of two ways.
|
||||
|
||||
1) Have an EOA call `transfer` or `transferFrom` on an ERC20, appending the
|
||||
encoded InInstruction directly after the calldata. `origin` defaults to the
|
||||
party transferred from.
|
||||
2) Call `inInstruction` on the Router. `origin` defaults to `msg.sender`.
|
||||
|
||||
### Out Instructions
|
||||
|
||||
|
|
Loading…
Reference in a new issue