chore: introduce Submodule interface
#855
Conversation
bryanchriswhite
added
core
bryanchriswhite
changed the title
Submodule interface
reviewpad
bot
added
large
bryanchriswhite
added
the
do not merge
* feat/integrate-bg-router: docs: clarify broadcast table docs: improve legend definitions chore: add TODO README docs: update TOC chore: add issue # to TECHDEBT comment chore: review feedback improvements chore: background router comment and var name cleanup docs: add architecture design language section docs: README improvements (review feedback)
There was a problem hiding this comment.
@bryanchriswhite I pulled the branch and edited some formatting while reading through it.
I think there is still opportunity to simplify this in the future, but I've unfortunately reached the exhaustion level of reading about modules and submodules for now 😓
Co-authored-by: Daniel Olshansky <[email protected]>
* pokt/main: [Utility] Update E2E feature path template doc (#870) [IBC] Add nil check on proof for membership and non-membership proof creation (#877) Added git diff state to devlog10 Devlog 10 (#872) [Documentation] Add IBC Module introduction as an example (#853) [Persistence][Bug] Fix Actor Schema Assignment for ValidatorActor in GetActor (#857) QOL: add bash completion for p1 to localnet client (#865)
* feat/integrate-bg-router: fix: goimports fix: unstaked actor bootstrapping FSM transition chore: add error log test: improve background router validation test docs: fix mistake in peer discovery section [Utility] Update E2E feature path template doc (#870) [IBC] Add nil check on proof for membership and non-membership proof creation (#877) Added git diff state to devlog10 Devlog 10 (#872) [Documentation] Add IBC Module introduction as an example (#853) [Persistence][Bug] Fix Actor Schema Assignment for ValidatorActor in GetActor (#857) QOL: add bash completion for p1 to localnet client (#865)
shared/modules/doc/README.md
Outdated
| @@ -33,6 +33,10 @@ This document outlines how we structured the code by splitting it into modules, | |||
| - [Get the module `bus`](#get-the-module-bus) | |||
| - [Stop the module](#stop-the-module) | |||
|
|
|||
| ## tl;dr Just show me an example | |||
|
|
|||
| If you're just interested in an example PR that introduced a new module to the codebase, see [#842](https://github.com/pokt-network/pocket/pull/842) which added the first iteration of the IBC module | |||
There was a problem hiding this comment.
LGTM 👍 Replacing providers with submodules seems worth an ADR, if you want help writing that up let's take a look at it @bryanchriswhite
bryanchriswhite
removed
the
do not merge
|
| GitGuardian id | Secret | Commit | Filename | |
|---|---|---|---|---|
| 5841025 | Generic High Entropy Secret | 4b19d8f | charts/pocket/templates/configmap-genesis.yaml | View secret |
| 5841025 | Generic High Entropy Secret | cf886a7 | charts/pocket/templates/configmap-genesis.yaml | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secrets safely. Learn here the best practices.
- Revoke and rotate these secrets.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
Our GitHub checks need improvements? Share your feedbacks!
@dylanlott it's more like the providers need to become submodules. |
|
🚨 Please don't delete this branch! I will do so when all downstream branches have been rebased, thank you! 🚨 |
* pokt/main: chore: introduce `Submodule` interface (#855)
Description
Introduces the
Submoduleinterface and applies it to the P2P module's peerstore provider.Issue
Deliverables 1, 2, 3, & 5:
Type of change
Please mark the relevant option(s):
List of changes
IntegratableModuletoIntegrableModuleInitializableModuletoInjectableModuleInjectableModule#Create()asMoudlealso embedsModuleFactoryWithConfigSubmoduleinterface typeTesting
make develop_test; if any code changes were mademake test_e2eon k8s LocalNet; if any code changes were madee2e-devnet-testpasses tests on DevNet; if any code was changedRequired Checklist
godocformat comments on touched members (see: tip.golang.org/doc/comment)If Applicable Checklist
shared/docs/*if I updatedshared/*README(s)