diff --git a/docs/src/content/extensions/accounting.md b/docs/src/content/extensions/accounting.md index cd79cddc..bcd1ba87 100644 --- a/docs/src/content/extensions/accounting.md +++ b/docs/src/content/extensions/accounting.md @@ -22,7 +22,7 @@ The Accounting Extension is a contract that allows users to deposit and bond fun - **Withdrawals**: Users can withdraw their deposited tokens at any time, provided they have sufficient balance. The withdrawal operation reduces the user's balance in the Accounting Extension and transfers the tokens back to the user's address. Locked tokens can't be withdrawn until they're released by a module. -- **Bonding**: Users can lock their tokens up for to be allowed to participate in a request. Tokens stay in the accounting extension but they cannot be withdrawn until the request is finalized or the tokens are released. +- **Bonding**: Users can lock their tokens up to be allowed to participate in a request. Tokens stay in the accounting extension but they cannot be withdrawn until the request is finalized or the tokens are released. - **Payments**: The Accounting Extension allows for payments to be made from one user to another. This usually means rewards for correct proposers and disputers and slashing malicious actors. It's done by unlocking and transferring the bonded tokens from the payer to the receiver's balance. Payments can only be initiated by modules. diff --git a/docs/src/content/intro/framework.md b/docs/src/content/intro/framework.md index 78d6460f..8943d894 100644 --- a/docs/src/content/intro/framework.md +++ b/docs/src/content/intro/framework.md @@ -58,7 +58,7 @@ Modules are the lego blocks for requests. They're responsible for the logic of t Since building a module is permissionless, the users should pay extra attention to the contracts they choose to interact with, verify their safety and compatibility with other modules. -Module-specific logic should be implemented in hooks such as `createRequest` and `finalizeRequest`, that are called by the oracle contract when They can be used to implement custom logic, such as storing the data in a custom format or sending a notification to a user. +Module-specific logic should be implemented in hooks such as `createRequest` and `finalizeRequest`, that are called by the oracle contract when setting up or finalizing a request. They can be used to implement custom logic, such as storing the data in a custom format or sending a notification to a user. ### Extensions diff --git a/docs/src/content/modules/dispute/bond_escalation_module.md b/docs/src/content/modules/dispute/bond_escalation_module.md index 3d45ced9..d2bccb86 100644 --- a/docs/src/content/modules/dispute/bond_escalation_module.md +++ b/docs/src/content/modules/dispute/bond_escalation_module.md @@ -30,7 +30,7 @@ The Bond Escalation Module is a contract that allows users to have the first dis ## 3. Key Mechanisms & Concepts -- **Bond Escalation**: The process of rasing stakes and pledging for one of the sides of a dispute. The sides take turns bonding funds until the bond escalation deadline. If the number of pledges in favor of the dispute is not equal to the number of pledges against the dispute at the end of the bond escalation deadline plus the tying buffer, the bond escalation accountancy can settled. In case of a tie, the dispute must be escalated to the resolution module. +- **Bond Escalation**: The process of raising stakes and pledging for one of the sides of a dispute. The sides take turns bonding funds until the bond escalation deadline is met. If the number of pledges in favor of the dispute is not equal to the number of pledges against the dispute at the end of the bond escalation deadline plus the tying buffer, the bond escalation accountancy can be settled. In case of a tie, the dispute must be escalated to the resolution module. - **Pledge**: Bonded funds that are used to support or oppose a dispute. ## 4. Gotchas diff --git a/docs/src/content/modules/request/contract_call_request_module.md b/docs/src/content/modules/request/contract_call_request_module.md index 3bc593c9..0eeb579a 100644 --- a/docs/src/content/modules/request/contract_call_request_module.md +++ b/docs/src/content/modules/request/contract_call_request_module.md @@ -11,8 +11,8 @@ The `ContractCallRequestModule` is a module for requesting on-chain information. ### Key Methods - `decodeRequestData`: Decodes request parameters. It returns the target contract address, the function selector, the encoded arguments of the function to call, the accounting extension to bond and release funds, the payment token, and the payment amount. -- `createRequest`: Can be used to bond the requester's funds and validating the request parameters. -- `finalizeRequest`: Finalizes a request by paying the proposer if there is a valid response, or releases the requester bond if no valid response was provided. +- `createRequest`: Can be used to bond the requester's funds and validate the request parameters. +- `finalizeRequest`: Finalizes a request by paying the proposer if there is a valid response, or releasing the requester's bond if no valid response was provided. ### Request Parameters diff --git a/docs/src/content/modules/request/http_request_module.md b/docs/src/content/modules/request/http_request_module.md index 8fa73c18..09ceeea1 100644 --- a/docs/src/content/modules/request/http_request_module.md +++ b/docs/src/content/modules/request/http_request_module.md @@ -12,7 +12,7 @@ The `HttpRequestModule` is a contract that allows users to request HTTP calls. - `decodeRequestData`: Decodes request parameters. It returns the URL, HTTP method, body, accounting extension, payment token, and payment amount from the given data. - `createRequest`: Can be used to bond the requester's funds and validating the request parameters. -- `finalizeRequest`: Finalizes a request by paying the proposer if there is a valid response, or releases the requester bond if no valid response was provided. +- `finalizeRequest`: Finalizes a request by paying the proposer if there is a valid response, or releasing the requester's bond if no valid response was provided. ### Request Parameters diff --git a/docs/src/content/modules/request/sparse_merkle_tree_request_module.md b/docs/src/content/modules/request/sparse_merkle_tree_request_module.md index a6c6b37a..4f87fd26 100644 --- a/docs/src/content/modules/request/sparse_merkle_tree_request_module.md +++ b/docs/src/content/modules/request/sparse_merkle_tree_request_module.md @@ -12,7 +12,7 @@ The `SparseMerkleTreeRequestModule` is a contract that allows a user to request - `decodeRequestData`: Decodes request parameters. It returns a RequestParameters struct that contains the parameters for the request. - `createRequest`: Can be used to bond the requester's funds and validating the request parameters. -- `finalizeRequest`: Finalizes a request by paying the proposer if there is a valid response, or releases the requester bond if no valid response was provided. +- `finalizeRequest`: Finalizes a request by paying the proposer if there is a valid response, or releasing the requester's bond if no valid response was provided. ### Request Parameters