Internal Audit #1
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- price push retries - state initialisation - round details queries - different job type requests - handling of prices/results from cl node - added docs
…changes in the smart contract
Added changes after viewing all comments
dillu24
commented
Feb 27, 2023
docs/DOCUMENTATION.md
Outdated
| @@ -89,8 +91,8 @@ Smart Contract - https://github.com/Agoric/agoric-sdk/tree/8720d22ddf25a005aee25 | |||
|
|
|||
| The middleware is needed to: | |||
| 1. Create CL jobs. CL jobs are created every minute. A cron job is not used in order to be able to pass in particular inputs to the job run so that the progress of the request can be stored and monitored. | |||
| 2. Get results back from the CL node. | |||
| 3. Query smart contract for new rounds. | |||
| 2. Get price responses back from the CL node after Job requests are made from the middleware. | |||
There was a problem hiding this comment.
Suggested change
| 2. Get price responses back from the CL node after Job requests are made from the middleware. | |
| 2. Get price responses back from the CL node after job requests are made from the middleware. |
| What it does: | ||
| - Checks whether the following criteria is satisfied: | ||
| - SEND_CHECK_INTERVAL seconds passed from the last price push update to ensure that multiple price updates are not pushed simultaneously | ||
| - If it is a new round and we the oracle has not started the current on-chain round or if it is not a new round but the oracle has not submitted to the current round on-chain |
There was a problem hiding this comment.
Suggested change
| - If it is a new round and we the oracle has not started the current on-chain round or if it is not a new round but the oracle has not submitted to the current round on-chain | |
| - If it is a new round and the oracle has not started the current on-chain round, or if it is not a new round but the oracle has not submitted to the current round on-chain |
| <div id='postadapter'></div> | ||
|
|
||
| a. <u>/adapter</u>: This is the endpoint which is used to accept job results from CL job requests. This endpoint does the following: | ||
| - Read the result, request ID, request Type and job name from the received body |
There was a problem hiding this comment.
Suggested change
| - Read the result, request ID, request Type and job name from the received body | |
| - Read the result, request ID, request type and job name from the received body |
| | SUBMIT_RETRIES | The number of retries to try when submitting a price<br>on-chain and it fails | 3 | | ||
| | BLOCK_INTERVAL | The block time of the chain in seconds. This is used<br>to query the price and round at every interval. | 6 | | ||
| | SEND_CHECK_INTERVAL | The interval in seconds which is waited between each send. | 45 | | ||
| | AGORIC_RPC | The Agoric's node RPC endpoint | http://0.0.0.0:26657 | |
There was a problem hiding this comment.
Suggested change
| | AGORIC_RPC | The Agoric's node RPC endpoint | http://0.0.0.0:26657 | | |
| | AGORIC_RPC | The Agoric node's RPC endpoint | http://0.0.0.0:26657 | |
…lue and enhanced comments
Added changes from final round of reviews
Switched to template strings
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is meant to be a place where we can leave comments and suggestions