Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Add operations documentation about proof submission fee #806

Merged
merged 8 commits into from
Sep 23, 2024

Conversation

red-0ne
Copy link
Contributor

@red-0ne red-0ne commented Sep 9, 2024

Summary

Add documentation about payable proof submissions to the relayminer_config doc.

Issue

Now that proof submission is a payable message. The Supplier operators need to be aware that they have to have enough funds to cover for proof submission.

Type of change

Select one or more from the following:

Testing

  • Documentation: make docusaurus_start; only needed if you make doc changes
  • Unit Tests: make go_develop_and_test
  • LocalNet E2E Tests: make test_e2e
  • DevNet E2E Tests: Add the devnet-test-e2e label to the PR.

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have commented my code
  • I have performed a self-review of my own code; both comments & source code
  • I create and reference any new tickets, if applicable
  • I have left TODOs throughout the codebase, if applicable

@red-0ne red-0ne added documentation Improvements or additions to documentation proof Claim & Proof life cycle labels Sep 9, 2024
@red-0ne red-0ne added this to the Shannon Beta TestNet Launch milestone Sep 9, 2024
@red-0ne red-0ne self-assigned this Sep 9, 2024
Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple minor edits but otherwise approving!

docusaurus/docs/operate/configs/relayminer_config.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/configs/relayminer_config.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/configs/relayminer_config.md Outdated Show resolved Hide resolved
@red-0ne red-0ne merged commit c1e5167 into main Sep 23, 2024
13 checks passed
bryanchriswhite added a commit that referenced this pull request Sep 23, 2024
…lpers

* pokt/main:
  [Code Health] refactor: rename `ApplicationTransfer` msgs (#788)
  [Docs] Add operations documentation about proof submission fee (#806)
bryanchriswhite added a commit that referenced this pull request Sep 23, 2024
…lier-stake-events

* issues/799/e2e/param-helpers:
  fix: add missing steps and update module name for moved param
  [Code Health] refactor: rename `ApplicationTransfer` msgs (#788)
  [Docs] Add operations documentation about proof submission fee (#806)
  [Testing] Fix non-idempotency in (and speed up) supplier staking tests (#815)
  [Application] feat: app stake transfer (#743)
  Empty commit
  [Tokenomics] Preparation for proportional relay mining rewards based on difficulty (#771)
  [Documentation] Change container names in the quickstart (#830)
bryanchriswhite added a commit that referenced this pull request Sep 23, 2024
…merge/integration-app_x_sup-stake-evts

* issues/799/feat/supplier-stake-events:
  fix: add missing steps and update module name for moved param
  [Code Health] refactor: rename `ApplicationTransfer` msgs (#788)
  [Docs] Add operations documentation about proof submission fee (#806)
  [Testing] Fix non-idempotency in (and speed up) supplier staking tests (#815)
  [Application] feat: app stake transfer (#743)
  Empty commit
  chore: review feedback improvements
bryanchriswhite added a commit that referenced this pull request Sep 23, 2024
… issues/799/tests/params

* issues/799/merge/integration-app_x_sup-stake-evts:
  fix: add missing steps and update module name for moved param
  [Code Health] refactor: rename `ApplicationTransfer` msgs (#788)
  [Docs] Add operations documentation about proof submission fee (#806)
  [Testing] Fix non-idempotency in (and speed up) supplier staking tests (#815)
  [Application] feat: app stake transfer (#743)
  Empty commit
  chore: review feedback improvements
bryanchriswhite added a commit that referenced this pull request Sep 24, 2024
…rge/integration-app_x_transfer-period-base

* issues/799/refactor/integration-app:
  fixup! HEAD^
  fix: linter errors
  chore: review feedback improvements
  [SMST] feat: Use compact SMST proofs (#823)
  [SessionManager] Skip claims creation if supplier operator balance is too low (#817)
  chore: self-review improvements
  [Code Health] refactor: rename `ApplicationTransfer` msgs (#788)
  [Docs] Add operations documentation about proof submission fee (#806)
  [Testing] Fix non-idempotency in (and speed up) supplier staking tests (#815)
bryanchriswhite added a commit that referenced this pull request Sep 24, 2024
…' into issues/657/chore/app-transfer-period

* issues/657/merge/integration-app_x_transfer-period-base:
  fixup! HEAD^
  fix: linter errors
  chore: review feedback improvements
  [SMST] feat: Use compact SMST proofs (#823)
  [SessionManager] Skip claims creation if supplier operator balance is too low (#817)
  chore: self-review improvements
  [Code Health] refactor: rename `ApplicationTransfer` msgs (#788)
  [Docs] Add operations documentation about proof submission fee (#806)
  [Testing] Fix non-idempotency in (and speed up) supplier staking tests (#815)
okdas pushed a commit that referenced this pull request Nov 14, 2024
## Summary

Add documentation about payable proof submissions to the
`relayminer_config` doc.

## Issue

Now that proof submission is a payable message. The `Supplier` operators
need to be aware that they have to have enough funds to cover for proof
submission.

- #758 

## Type of change

Select one or more from the following:

- [ ] New feature, functionality or library
- [ ] Consensus breaking; add the `consensus-breaking` label if so. See
#791 for details
- [ ] Bug fix
- [ ] Code health or cleanup
- [x] Documentation
- [ ] Other (specify)

## Testing

- [x] **Documentation**: `make docusaurus_start`; only needed if you
make doc changes
- [ ] **Unit Tests**: `make go_develop_and_test`
- [ ] **LocalNet E2E Tests**: `make test_e2e`
- [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR.

## Sanity Checklist

- [x] I have tested my changes using the available tooling
- [ ] I have commented my code
- [x] I have performed a self-review of my own code; both comments &
source code
- [ ] I create and reference any new tickets, if applicable
- [ ] I have left TODOs throughout the codebase, if applicable
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation proof Claim & Proof life cycle
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants