UE improvement #4
Merged
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
1. print usage when invalid configuration is addressed. 2. refine the naming of configuration. 3. introduce logging level.
Jason-Zhangxin-Chen
requested review from
lorenzo-dev1,
raj-shekhar1,
yazzaoui and
cmjc
Closed
lorenzo-dev1
approved these changes
Nov 27, 2023
There was a problem hiding this comment.
LGTM with remaining minor non-blocking comment #4 (comment)
|
Changes to be added to |
cmjc
added a commit
to autonity/docs.autonity.org
that referenced
this pull request
Nov 28, 2023
cmjc
added a commit
to autonity/docs.autonity.org
that referenced
this pull request
Dec 1, 2023
#100) * Glossary, add terms voting period, vote period * Reference, Command-line, refactor and add oracle cli * Reference, Command-line, refactor and add oracle cli, formatting * Validators, shell for install and run oracle * Vallidators, page weighting * Validators, Install AOS. Node operators, Install AGC - typo fixes * Add install AOS, run AOS, updated REgister Validator to include AOS * Edits to Reference pages, Concepts: client, add Oracle, Architecture * Edits to Concepts * Edit concepts for oracle, update op-prot reference to remove epochReward, update register validator guide * Edit Oracle network section - plugins, data providers and consumers, economics * Fix links * Edit Reference CLI, AOS - editorial, add cli flag for oracle_pluugin_conf * Add Running an Oracle Server section, moving in cinstall and run ontent from Running a Validator * Correct Oracle Contract address * Edits to Concept Oracle network, Running an oracle server, Reference CLI and Genesis * Update content/docs/concepts/architecture/_index.md Co-authored-by: Aiman Baharna <3908897+aiman@users.noreply.github.com> * Concepts, relocate content from Oracle network -> Oracle Server; edit TODO placeholders * Edit Concept Oracle server, page heading levels * Concepts for AOS, edit for PR feedback to clarify networking and typoss * Concept Oracle network, fix block number example error in commit and reveal section * Concept Oracle network, fix formatting in section Currency pair management * Update content/docs/concepts/oracle-network/_index.md Co-authored-by: Aiman Baharna <3908897+aiman@users.noreply.github.com> * Update content/docs/reference/api/oracle/_index.md Co-authored-by: Aiman Baharna <3908897+aiman@users.noreply.github.com> * Edits to Reference, Autonity Contract Interface and Governande and Protocol Only Reference * Edits to Glossary for terms around stake delegation, edits to Concepts using revised terms, edits to Autonity contract Interface bond and unbond * Editorial and accoutnability interface edits initial draft * Glossary, add terms ASM,ACU,CDP * Reference, Genesis. Add ASM config. * Add Auton UoM, update glossary entries for UoMs, edit links throughout to UoMs * Reference, ASM Contract Interfaces iteration 1 * Reference, Genesis - update to add accountability config object * Reference, Genesis - realign sub-heading indents * Reference, ASM Contract Interfaces iteration 3 * Reference, ASM Contract Interfaces iteration 4, remove internal functions. * Concept, Architecture, Application Layer: protocol contracts. Add entries for ASM contracts * Reference, API, op-prot. Move SupplyControl mint and burn to protocol ony section * Reference, edit Protocol Parameters, Genesis, Operator only API for ASM * Concepts, revise concept page ordering sequence * Overview, edit throughout to add oracle network, accountability, ASM * Reference, Autonity Contract Interfaces, update op prot, add getter functions for protocol config * Concepts, ASM first iteration * Concepts, ASM first iteration, edit economics * Concept, ASM, revise following review comment * Guide Validator edit and ASM Contract Interfaces Usage and Example Edits * ASM Contract Interface, add Usage and Examples * ASM Contract Interface, edit usage and examples * Edits to Concepts * Update autonity command line usage * Update Reference Genesis to add oracle * Reference Autonity Contract Interface: update registerValidator * Glossary, add terms for: currency pair, data oracle, autonity oracle server * Edit codebase, operator only, shell out oracle interface * Edit API Reference for Oracle Contract setSymbols * Glossary, add terms voting period, vote period * Reference, Protocol Parameters - add oracle * Reference, Command-line, refactor and add oracle cli * Reference, Command-line, refactor and add oracle cli, formatting * Add install AOS, run AOS, updated REgister Validator to include AOS * Edits to Reference pages, Concepts: client, add Oracle, Architecture * Edits to Concepts * Edit concepts for oracle, update op-prot reference to remove epochReward, update register validator guide * Edit Oracle network section - plugins, data providers and consumers, economics * Editorial to Concept Validator, Reference Autonity Contract Interface * Edit Reference CLI, AOS - editorial, add cli flag for oracle_pluugin_conf * Edit hyperlinks to point to revised AOS section * Add Running an Oracle Server section, moving in cinstall and run ontent from Running a Validator * Correct Oracle Contract address * Edits to Concept Oracle network, Running an oracle server, Reference CLI and Genesis * Run AOS, remove placeholder TO DO's * Concepts, relocate content from Oracle network -> Oracle Server; edit TODO placeholders * Edit Concept Oracle server, page heading levels * concept Oracle network, edit server key * Guide, Running an AOS, Run OAS, edit to clarify WS address * Concept Oracle network, fix formatting in section Currency pair management * Update content/docs/concepts/oracle-network/_index.md Co-authored-by: Aiman Baharna <3908897+aiman@users.noreply.github.com> * Edits to Reference, Autonity Contract Interface and Governande and Protocol Only Reference * Edits to Glossary for terms around stake delegation, edits to Concepts using revised terms, edits to Autonity contract Interface bond and unbond * Editorial and accoutnability interface edits initial draft * REference, Autonity Contract, add getter methods * Reference and Concepts, edits for staking transitions * Concept Staking, edit Staking transitions to clarify state * Concept Staking, edit Staking transitions to remove redundancy with text in Concept, Protocol assets * Reference, API, op-prot. Move SupplyControl mint and burn to protocol ony section * Overview, edit throughout to add oracle network, accountability, ASM * Reference, Autonity Contract Interfaces, update op prot, add getter functions for protocol config * Reference, Autonity Contract Interface, get and register Validator edits * Reference, Autonity Contract Interface, remove deprecated Bonding and Unbonding Req and head and tail ID methods * Concepts, Guides - remove references to deprecated Bonding and Unbonding Req and head and tail ID methods * Fix broken link * Edits for unbonding pools, examples, formatting, editorial * Correct ABI path in interface examples * Liquid Newton Contract Interface, add Usage and Examples * Concept staking, editorial on US spelling and locking * Reference, Liquid Newton Interface, Usage and Example edits * Update content/docs/concepts/staking/_index.md Co-authored-by: lorenzo <31852651+lorenzo-dev1@users.noreply.github.com> * Update content/docs/reference/api/liquid-newton/_index.md Co-authored-by: lorenzo <31852651+lorenzo-dev1@users.noreply.github.com> * Concept Staking, edits to staking transitions section * Concept Staking, Staking transitions. Clarify Info note * Concept Staking, Staking transitions. Correct unbonding sequence description error * Autonity Contract Interface, unbond. Correct unbonding sequence description error * Edit unbonding examples and descriptions in Concept Staking and Autonity Contract Interface entry for unbond function * Edits to Concepts * Update autonity command line usage * Update Reference Genesis to add oracle * Edit API Reference for Oracle Contract setSymbols * Reference, Command-line, refactor and add oracle cli * Reference, Command-line, refactor and add oracle cli, formatting * Add install AOS, run AOS, updated REgister Validator to include AOS * Edits to Concepts * Edit concepts for oracle, update op-prot reference to remove epochReward, update register validator guide * Edit Oracle network section - plugins, data providers and consumers, economics * Editorial to Concept Validator, Reference Autonity Contract Interface * Add Running an Oracle Server section, moving in cinstall and run ontent from Running a Validator * Correct Oracle Contract address * Edits to Concept Oracle network, Running an oracle server, Reference CLI and Genesis * Run AOS, remove placeholder TO DO's * Concepts, relocate content from Oracle network -> Oracle Server; edit TODO placeholders * Edit Concept Oracle server, page heading levels * Concept Oracle network, fix formatting in section Currency pair management * Edits to Reference, Autonity Contract Interface and Governande and Protocol Only Reference * Edits to Glossary for terms around stake delegation, edits to Concepts using revised terms, edits to Autonity contract Interface bond and unbond * Editorial and accoutnability interface edits initial draft * REference, Autonity Contract, add getter methods * Reference and Concepts, edits for staking transitions * Reference, API, op-prot. Move SupplyControl mint and burn to protocol ony section * Overview, edit throughout to add oracle network, accountability, ASM * Reference, Autonity Contract Interfaces, update op prot, add getter functions for protocol config * Reference, Autonity Contract Interface, remove deprecated Bonding and Unbonding Req and head and tail ID methods * Concepts, Guides - remove references to deprecated Bonding and Unbonding Req and head and tail ID methods * Edits for unbonding pools, examples, formatting, editorial * Liquid Newton Contract Interface, add Usage and Examples * Concept staking, editorial on US spelling and locking * Reference, Liquid Newton Interface, Usage and Example edits * Concept Staking, edits to staking transitions section * Concept Staking, Staking transitions. Clarify Info note * Concept Staking, Staking transitions. Correct unbonding sequence description error * Autonity Contract Interface, unbond. Correct unbonding sequence description error * Edit unbonding examples and descriptions in Concept Staking and Autonity Contract Interface entry for unbond function * Autonity Contract Interface, editorial following rebase * Reference Autonity Contract Interface, edit Usage and Examples * Open CDP, clarify collateral price value is returned in ton * Update autonity command line usage * Reference Autonity Contract Interface: update registerValidator * Glossary, add terms for: currency pair, data oracle, autonity oracle server * Edit codebase, operator only, shell out oracle interface * Edit API Reference for Oracle Contract setSymbols * Glossary, add terms voting period, vote period * Reference, Command-line, refactor and add oracle cli * Reference, Command-line, refactor and add oracle cli, formatting * Add install AOS, run AOS, updated REgister Validator to include AOS * Edits to Reference pages, Concepts: client, add Oracle, Architecture * Edits to Concepts * Edit concepts for oracle, update op-prot reference to remove epochReward, update register validator guide * Edit Oracle network section - plugins, data providers and consumers, economics * Editorial on Home page and CLI Reference * Add Running an Oracle Server section, moving in cinstall and run ontent from Running a Validator * Correct Oracle Contract address * Edit Concepts AOS, AGC oracle contract and networking entries * Run AOS, remove placeholder TO DO's * Concepts, relocate content from Oracle network -> Oracle Server; edit TODO placeholders * Edit Concept Oracle server, page heading levels * Update content/docs/reference/api/oracle/_index.md Co-authored-by: Aiman Baharna <3908897+aiman@users.noreply.github.com> * Update content/docs/reference/codebase/_index.md Co-authored-by: Aiman Baharna <3908897+aiman@users.noreply.github.com> * Edits to Reference, Autonity Contract Interface and Governande and Protocol Only Reference * Edits to Glossary for terms around stake delegation, edits to Concepts using revised terms, edits to Autonity contract Interface bond and unbond * Editorial and accoutnability interface edits initial draft * Edit API Reference and Concept for AFD * Edits to Glossary, API Reference, Concept AFD * Edit Concept Accountability, associated edits to Glossary and API Reference entries * Draft Concept Accountability, minor editorial Reference API, Protocol only section * Edit Concept, Architecture * Edit for PR feedback to Rule PN * Edits to Concepts for accountability: Accountability, Staking, Architecture * Edit Concept Architecture for accountability feature * Edit Concept System model for accountability feature * Edits to Concept Validator for accountability * Edits to Architecture, edit heading levels, add protocol contract address section * Edits to Concept Staking for accountability * Edits to Glossary for accountability * Edits and simplification to Concepts Architecture, Accountability for PR review * Concept AFD, remove detail from Overview * Update content/docs/concepts/accountability/_index.md Co-authored-by: lorenzo <31852651+lorenzo-dev1@users.noreply.github.com> * Concept, ARchitecture, State finalization - edit sequence, US spelling * Edits for PR review comment to Concepts Accountability, Staking and Protocol-only Interface * Accountability Contract Interface, add reference to issue for missingn usage and examples * Edit API Reference for Oracle Contract setSymbols * Reference, Command-line, refactor and add oracle cli * Reference, Command-line, refactor and add oracle cli, formatting * Add install AOS, run AOS, updated REgister Validator to include AOS * Edits to Reference pages, Concepts: client, add Oracle, Architecture * Edits to Concepts * Edit concepts for oracle, update op-prot reference to remove epochReward, update register validator guide * Edit Oracle network section - plugins, data providers and consumers, economics * Add Running an Oracle Server section, moving in cinstall and run ontent from Running a Validator * Concepts, relocate content from Oracle network -> Oracle Server; edit TODO placeholders * Edit Concept Oracle server, page heading levels * Concepts for AOS, edit for PR feedback to clarify networking and typoss * Guide, Running an AOS, Run OAS, edit to clarify WS address * Edits to Reference, Autonity Contract Interface and Governande and Protocol Only Reference * Edits to Glossary for terms around stake delegation, edits to Concepts using revised terms, edits to Autonity contract Interface bond and unbond * Editorial and accoutnability interface edits initial draft * Glossary, add terms ASM,ACU,CDP * Reference, Genesis. Add ASM config. * Reference, ASM Contract Interfaces iteration 1 * Reference, Genesis - update to add accountability config object * Reference, ASM Contract Interfaces iteration 3 * Reference, ASM Contract Interfaces iteration 4, remove internal functions. * Concept, Architecture, Application Layer: protocol contracts. Add entries for ASM contracts * Reference, API, op-prot. Move SupplyControl mint and burn to protocol ony section * Reference, edit Protocol Parameters, Genesis, Operator only API for ASM * Overview, edit throughout to add oracle network, accountability, ASM * Reference, Autonity Contract Interfaces, update op prot, add getter functions for protocol config * Reference, API, Supply Control and Oracle function edits * Guide Validator edit and ASM Contract Interfaces Usage and Example Edits * ASM Contract Interface, add Usage and Examples * Edits to Concepts * Edit API Reference for Oracle Contract setSymbols * Reference, Command-line, refactor and add oracle cli * Reference, Command-line, refactor and add oracle cli, formatting * Edits to Reference pages, Concepts: client, add Oracle, Architecture * Edits to Concepts * Edit concepts for oracle, update op-prot reference to remove epochReward, update register validator guide * Edit Oracle network section - plugins, data providers and consumers, economics * Correct Oracle Contract address * Concepts, relocate content from Oracle network -> Oracle Server; edit TODO placeholders * Edits to Reference, Autonity Contract Interface and Governande and Protocol Only Reference * Edits to Glossary for terms around stake delegation, edits to Concepts using revised terms, edits to Autonity contract Interface bond and unbond * Editorial and accoutnability interface edits initial draft * REference, Autonity Contract, add getter methods * Reference and Concepts, edits for staking transitions * Reference, Autonity Contract Interfaces, update op prot, add getter functions for protocol config * Reference, Autonity Contract Interface, remove deprecated Bonding and Unbonding Req and head and tail ID methods * Edits for unbonding pools, examples, formatting, editorial * Edit unbonding examples and descriptions in Concept Staking and Autonity Contract Interface entry for unbond function * Oracle, edits to add Docker run and install * Guide Run AOS, Run as Docker * Running an AOS Guide, Edit Install and Run to add Docker and editorial * Edit guide for running AOS as Docker, add link to docker docs for Networking * Guide AOS, Run oracle, run as docker editorial * Reference Oracle Contract Interface and AOS Concept, edits * Reference Op Prot, remove merge cnflict * Run AOS, clarify edit and configure plugin conf file step, add link to sample conf file in AOS GitHub * Concept, Oracle network, fix broken links * AOS, edit command-line flags and usage for autonity-oracle PR autonity/autonity-oracle#4 * Edit Concepts for Oracle Server and Network, AGC CLI Reference options for oraclekey * Concets, System model, redirect protocol contract link from Glossary to Concept Architecture * Reference, API, Oracle and Accountability interface formatting fixes * Guide Run Oracle, add missing slash for line break to run example --------- Co-authored-by: Aiman Baharna <3908897+aiman@users.noreply.github.com> Co-authored-by: lorenzo <31852651+lorenzo-dev1@users.noreply.github.com>
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.
To close #3 , this PR contains some user experience improvements collected from the round4 game feedbacks:
@cmjc @raj-shekhar1 Please also keep the document and the deployment scripts updated with this PR since we have configuration renaming and a new log.level flag introduced.