Skip to content

Commit 9dfd398

Browse files
authoredJan 30, 2018
Merge pull request omni#110 from GriffGreen/patch-1
Fixed some typos and made a section more coherent
2 parents fba0679 + 5d61af2 commit 9dfd398

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed
 

‎README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ users can always call `ForeignBridge.transferHomeViaRelay(homeRecipientAddress,
5252
`foreign` is assumed to use PoA (proof of authority) consensus.
5353
relays between the chains happen in a byzantine fault tolerant way using the authorities of `foreign`.
5454

55-
### highlevel explanation of home ether -> foreign ERC20 relay
55+
### high level explanation of home ether -> foreign ERC20 relay
5656

5757
`sender` deposits `value` into `HomeBridge`.
5858
the `HomeBridge` fallback function emits `Deposit(sender, value)`.
@@ -64,16 +64,16 @@ once there are `ForeignBridge.requiredSignatures` such transactions
6464
with identical arguments and from distinct authorities then
6565
`ForeignBridge.balanceOf(sender)` is increased by `value`.
6666

67-
### highlevel explanation of foreign ERC20 -> home ether relay
67+
### high level explanation of foreign ERC20 -> home ether relay
6868

6969
`sender` executes `ForeignBridge.transferHomeViaRelay(recipient, value)`
7070
which checks and reduces `ForeignBridge.balances(sender)` by `value` and emits `ForeignBridge.Withdraw(recipient, value)`.
7171

72-
for each `ForeignBridge.Withdraw` every bridge authority creates a message containg
73-
`value`, `recipient` and the `transactionHash` of the transaction containing the `ForeignBridge.Withdraw` event,
74-
signs the message and executes `ForeignBridge.submitSignature(signature, message)`.
75-
this collection of signatures on `foreign` is necessary because transactions are free
76-
for authorities on `foreign`, since they are the authorities of `foreign`, but not free on `home`.
72+
for every `ForeignBridge.Withdraw`, every bridge authority creates a message containing
73+
`value`, `recipient` and the `transactionHash` of the transaction referenced by the `ForeignBridge.Withdraw` event;
74+
signs that message and executes `ForeignBridge.submitSignature(signature, message)`.
75+
this collection of signatures is on `foreign` because transactions are free for the authorities on `foreign`,
76+
but not free on `home`.
7777

7878
once `ForeignBridge.requiredSignatures` signatures by distinct authorities are collected
7979
a `ForeignBridge.CollectedSignatures(authorityThatSubmittedLastSignature, messageHash)` event is emitted.
@@ -146,9 +146,9 @@ bin = "contracts/KovanBridge.bin"
146146

147147
[authorities]
148148
accounts = [
149-
"0x006e27b6a72e1f34c626762f3c4761547aff1421",
150-
"0x006e27b6a72e1f34c626762f3c4761547aff1421",
151-
"0x006e27b6a72e1f34c626762f3c4761547aff1421"
149+
"0x006e27b6a72e1f34c626762f3c4761547aff1421",
150+
"0x006e27b6a72e1f34c626762f3c4761547aff1421",
151+
"0x006e27b6a72e1f34c626762f3c4761547aff1421"
152152
]
153153
required_signatures = 2
154154

@@ -221,7 +221,7 @@ checked_withdraw_confirm = 121
221221
- `foreign_deploy` - block number at which foreign contract has been deployed
222222
- `checked_deposit_relay` - number of the last block for which an authority has relayed deposits to the foreign
223223
- `checked_withdraw_relay` - number of the last block for which an authority has relayed withdraws to the home
224-
- `checked_withdraw_confirm` - number of the last block for which an authirty has confirmed withdraw
224+
- `checked_withdraw_confirm` - number of the last block for which an authority has confirmed withdraw
225225

226226
### example run
227227

@@ -255,8 +255,8 @@ that shuts down an attack that enabled exhaustion of authorities funds on `home`
255255
read on for a more thorough explanation.
256256

257257
parity-bridge connects a value-bearing ethereum blockchain `home`
258-
(initally the ethereum foundation chain)
259-
to a non-value-bearing PoA ethereum blockchain `foreign` (initally the kovan testnet).
258+
(initially the ethereum foundation chain)
259+
to a non-value-bearing PoA ethereum blockchain `foreign` (initially the kovan testnet).
260260

261261
value-bearing means that the ether on that chain has usable value in the sense that
262262
in order to obtain it one has to either mine it (trade in electricity)

0 commit comments

Comments
 (0)
Please sign in to comment.