Literal pubkeys in agent config, v2.0.0 #77
Merged
Conversation
This file contains hidden or 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
This **breaking** change improves on the legacy file-based keystore appoach to program/mapping public keys. With it, the user can name the public keys in-line, e.g.: 'key_store.program_key_path = "program_key.json"' is now expressed as: 'key_store.program_key = "FsJ3A3u2vn5cTVofAjvy6y5kwABJAqYWpe4975bi2epH"' This change is accompanied with a small tool to inline the public keys from an older file-based config, named "agent-migrate-config". The sample configs are rewritten to use the new format and name the appropriate pubkeys out-of-the-box. Tests include a sanity-check for the migration tool.
This is necessary to provide the agent with an altered migrated config.
jayantk
approved these changes
Jul 17, 2023
src/agent/solana.rs
Outdated
| } | ||
| } | ||
|
|
||
| // Helper methods for strinigified SOL addresses |
We don't like our SOL addresses strinigified.
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.
Motivation
The legacy pythd config scheme, using individual files for storing program/mapping/accumulator public keys, is inconvenient and its defaults are misleading. This change replaces the key store root path and individual files with inlined base-58 pubkeys and a single path to reach the publishing keypair. Additionally, the inlined string keys make it much more convenient to distribute complete sample configs to publishers.
Summary of changes
v2.0.0- this is a breaking change that will prevent users from running the service without updating their config for the new schema.KeyStoreoptions to use base58 strings instead of file pathssrc/bin/agent_migrate_config.rs- Implemented a small migration tool that will find and inline the file-based pubkeys in an existing config, making it work with the breaking change.agent-migrate-configand updating by hand.agent-migrate-configworksReview Highlights
README.md. It is important that the description is easy to follow.Testing
agent-migrate-configis tested by converting a legacy config and using it to perform the simple test case