diff --git a/docs/frequently-asked-questions.rst b/docs/frequently-asked-questions.rst index 23af916..17215d4 100644 --- a/docs/frequently-asked-questions.rst +++ b/docs/frequently-asked-questions.rst @@ -2,29 +2,33 @@ Frequently Asked Questions ########################### -What's the purpose of BTC Relay? +What's the simplest explanation of BTC Relay? ============================= -To allow users to pay with Bitcoin to use Ethereum. - - -Who is BTC Relay for? -============================= - -Developers who want to allow their users to pay with Bitcoin to use their Ethereum -application. +It allows users to pay with Bitcoin to use Ethereum. How to use BTC Relay? ============================= -If you're a user, you should not need to use BTC Relay directly since it Workshop +If you're a user, you should not need to use BTC Relay directly since it works behind the scenes. If you're a developer, did you see `How to use BTC Relay? `_ +Who is BTC Relay for? +============================= + +Developers who want a secure, fully decentralized and trustless method of +verifying Bitcoin transactions for their Ethereum and smart contract applications. + +BTC Relay is a building block for developers that want interoperability between +Ethereum and Bitcoin. For example, developers who want to allow their users to +pay with Bitcoin to use their Ethereum application. + + Why isn't verifyTx / relayTx working? ============================= @@ -32,21 +36,21 @@ Why isn't verifyTx / relayTx working? * Did you pass the correct parameters to `construct the Merkle proof `_ correctly? - Viewing the page source of the `examples `_ + Viewing the page source of some `examples `_ might help. -* Did you send at least the fee as indicated by `getFeeAmount `_? +* Did you send at least the fee as indicated by `getFeeAmount() `_? What prevents fees from being too high? ============================= If a fee for any block header is too high, anyone may -`changeFeeRecipient `_ +`changeFeeRecipient() `_ to themselves. -They can compare the current fee against `getChangeRecipientFee `_ -to see if the fee is excessive. Callers of ``changeFeeRecipient`` +They can compare the current fee against `getChangeRecipientFee() `_ +to see if the fee is excessive. Callers of ``changeFeeRecipient()`` must make sure to satisfy all `requirements `_ for successful completion. diff --git a/docs/status.rst b/docs/status.rst index 94ef187..ca29824 100644 --- a/docs/status.rst +++ b/docs/status.rst @@ -29,13 +29,13 @@ account that was first to successfully submit the block header to BTC Relay. What is the fee for previous blocks? ============================= -Use `getFeeAmount. `_ +Use `getFeeAmount(). `_ What can I do if the fee is too high? ============================= -An option is to `changeFeeRecipient `_ +An option is to `changeFeeRecipient() `_ to yourself. Make sure you satisfy all requirements for successful completion.