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.

Sign up for GitHub

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

Jump to bottom

[Docs] Add a debugging tip: using transaction hashes #786

Merged
merged 8 commits into from
Sep 11, 2024
Merged

[Docs] Add a debugging tip: using transaction hashes #786

merged 8 commits into from
Sep 11, 2024

Conversation

adshmh
Copy link
Contributor

@adshmh adshmh commented Sep 4, 2024

Summary

Added a debugging tip to the documentation on using transaction hashes to get more details when a transaction does not seem to have taken effect, e.g. when staking a new service returns a transaction (TX) hash but the service does not appear after a few blocks.

Issue

Debugging the process of adding a new service can be simplified using the debugging tip being added in this PR.

Type of change

Select one or more:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

  • Documentation: make docusaurus_start; only needed if you make doc changes

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

@adshmh adshmh added the documentation Improvements or additions to documentation label Sep 4, 2024
@adshmh adshmh added this to the Shannon Beta TestNet Launch milestone Sep 4, 2024
@adshmh adshmh self-assigned this Sep 4, 2024
@Olshansk
Copy link
Member

Olshansk commented Sep 6, 2024

@adshmh Bump on this.

bryanchriswhite
bryanchriswhite approved these changes Sep 9, 2024
View reviewed changes
Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

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

Very nice! 😎👌

Great addition. +1 to @Olshansk's suggestions and I one of my own.

docusaurus/docs/develop/developer_guide/debug_tips.md Show resolved Hide resolved
@adshmh adshmh requested a review from Olshansk September 10, 2024 13:29
@adshmh adshmh merged commit ecf74ce into main Sep 11, 2024
13 checks passed
bryanchriswhite added a commit that referenced this pull request Sep 16, 2024
@bryanchriswhite
Merge remote-tracking branch 'pokt/main' into issues/799/refactor/mak…
5182b03 
…efiles

* pokt/main:
  [Tooling] fix and add makefile targets (#814)
  [Docs] Add a debugging tip: using transaction hashes (#786)
bryanchriswhite added a commit that referenced this pull request Sep 16, 2024
@bryanchriswhite
Merge remote-tracking branch 'pokt/main' into issues/657/feat/app-sta…
4814ffc 
…ke-transfer

* pokt/main:
  [Tooling, Code Health] refactor: split Makefile into multiple files (#816)
  [Tooling] fix and add makefile targets (#814)
  [Docs] Add a debugging tip: using transaction hashes (#786)
  [Refactor] Replace embedded Service with ServiceId (#802)
  [Session,Service] Ensure SessionHeader and Service basic validation. (#782)
  [Tokenomics] Preparation for Global Mint Reimbursement Request (#755)
  [Quick PR][LocalNet] Turn off minimum-gas-prices (#805)
  [GATEWAY POC] A couple helpers to help deploy a PATH gateway (#801)
  [Documentation] Cosmovisor  (#768)
  [CI] Add cosmovisor to container images (#796)
  Use a descriptive error if service ID is not found (#787)
  [SessionManager] Implement off-chain proof params usage (#765)
  [SDK] Update shannon sdk dependency (#800)
  [E2E Test] Remove redundant logging (#798)
bryanchriswhite added a commit that referenced this pull request Sep 16, 2024
@bryanchriswhite
Merge branch 'issues/657/feat/app-stake-transfer' into issues/657/ref…
75c5927 
…actor/transfer-msg_period-param

* issues/657/feat/app-stake-transfer:
  [Tooling, Code Health] refactor: split Makefile into multiple files (#816)
  [Tooling] fix and add makefile targets (#814)
  [Docs] Add a debugging tip: using transaction hashes (#786)
  [Refactor] Replace embedded Service with ServiceId (#802)
  [Session,Service] Ensure SessionHeader and Service basic validation. (#782)
  [Tokenomics] Preparation for Global Mint Reimbursement Request (#755)
  [Quick PR][LocalNet] Turn off minimum-gas-prices (#805)
  [GATEWAY POC] A couple helpers to help deploy a PATH gateway (#801)
  [Documentation] Cosmovisor  (#768)
  [CI] Add cosmovisor to container images (#796)
  Use a descriptive error if service ID is not found (#787)
  [SessionManager] Implement off-chain proof params usage (#765)
  [SDK] Update shannon sdk dependency (#800)
  [E2E Test] Remove redundant logging (#798)
bryanchriswhite added a commit that referenced this pull request Sep 16, 2024
@bryanchriswhite
Merge branch 'issues/657/refactor/transfer-msg_period-param' into iss…
816eaa2 
…ues/657/chore/app-transfer-period

* issues/657/refactor/transfer-msg_period-param:
  [Tooling, Code Health] refactor: split Makefile into multiple files (#816)
  [Tooling] fix and add makefile targets (#814)
  [Docs] Add a debugging tip: using transaction hashes (#786)
  [Refactor] Replace embedded Service with ServiceId (#802)
  [Session,Service] Ensure SessionHeader and Service basic validation. (#782)
  [Tokenomics] Preparation for Global Mint Reimbursement Request (#755)
  [Quick PR][LocalNet] Turn off minimum-gas-prices (#805)
  [GATEWAY POC] A couple helpers to help deploy a PATH gateway (#801)
  [Documentation] Cosmovisor  (#768)
  [CI] Add cosmovisor to container images (#796)
  Use a descriptive error if service ID is not found (#787)
  [SessionManager] Implement off-chain proof params usage (#765)
  [SDK] Update shannon sdk dependency (#800)
  [E2E Test] Remove redundant logging (#798)
bryanchriswhite added a commit that referenced this pull request Sep 19, 2024
@bryanchriswhite
Merge branch 'issues/799/e2e/idempotent-stake-supplier' into issues/7…
a2ee2c2 
…99/e2e/param-helpers

* issues/799/e2e/idempotent-stake-supplier:
  chore: add comment
  chore: sync shared module default params
  fix: failing E2E test
  [Supplier] Initial slashing implementation (#795)
  [Container image] Change base image for release (#829)
  [Proof] Prevent proof submission when not required (#822)
  chore: rename paramsAnyMap type to mitigate variable name shadowing
  [Tooling, Code Health] refactor: split Makefile into multiple files (#816)
  [Tooling] fix and add makefile targets (#814)
  [Docs] Add a debugging tip: using transaction hashes (#786)
bryanchriswhite added a commit that referenced this pull request Sep 19, 2024
@bryanchriswhite
Merge branch 'issues/799/e2e/param-helpers' into issues/799/feat/supp…
8546244 
…lier-stake-events

* issues/799/e2e/param-helpers:
  chore: review feedback improvements
  chore: add comment
  chore: sync shared module default params
  fix: failing E2E test
  [Supplier] Initial slashing implementation (#795)
  [Container image] Change base image for release (#829)
  [Proof] Prevent proof submission when not required (#822)
  chore: rename paramsAnyMap type to mitigate variable name shadowing
  [Tooling, Code Health] refactor: split Makefile into multiple files (#816)
  [Tooling] fix and add makefile targets (#814)
  [Docs] Add a debugging tip: using transaction hashes (#786)
bryanchriswhite added a commit that referenced this pull request Sep 19, 2024
@bryanchriswhite
Merge branch 'issues/799/feat/supplier-stake-events' into issues/799/…
dfb5c05 
…tests/params

* issues/799/feat/supplier-stake-events:
  chore: review feedback improvements
  chore: add comment
  chore: sync shared module default params
  fix: failing E2E test
  [Supplier] Initial slashing implementation (#795)
  [Container image] Change base image for release (#829)
  [Proof] Prevent proof submission when not required (#822)
  chore: rename paramsAnyMap type to mitigate variable name shadowing
  [Tooling, Code Health] refactor: split Makefile into multiple files (#816)
  [Tooling] fix and add makefile targets (#814)
  [Docs] Add a debugging tip: using transaction hashes (#786)
okdas pushed a commit that referenced this pull request Nov 14, 2024
@adshmh @Olshansk
[Docs] Add a debugging tip: using transaction hashes (#786)
b71b0f1 
## Summary

Added a debugging tip to the documentation on using transaction hashes
to get more details when a transaction does not seem to have taken
effect, e.g. when staking a new service returns a transaction (TX) hash
but the service does not appear after a few blocks.

## Issue

Debugging the process of adding a new service can be simplified using
the debugging tip being added in this PR.

## Type of change

Select one or more:

- [ ] New feature, functionality or library
- [ ] Bug fix
- [ ] Code health or cleanup
- [x] Documentation
- [ ] Other (specify)

## Testing

- [x] **Documentation**: `make docusaurus_start`; only needed if you
make doc changes

## 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

---------

Co-authored-by: Daniel Olshansky <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bryanchriswhite bryanchriswhite bryanchriswhite approved these changes

@Olshansk Olshansk Olshansk approved these changes

Assignees

@adshmh adshmh

Labels
documentation Improvements or additions to documentation
Projects
Shannon
Status: ✅ Done
Milestone
Shannon Beta TestNet Launch
Development

Successfully merging this pull request may close these issues.
3 participants
@adshmh @Olshansk @bryanchriswhite