docs: new Q&A questions and answers section #543
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
dzikowski
reviewed
Apr 18, 2025
| - Reduced world state database load | ||
| - Automatic cache management | ||
|
|
||
| Note: The stub cache is specifically designed for transaction-level caching. For cross-transaction data access patterns, consider implementing appropriate data structures and query patterns in your chaincode. No newline at end of file |
Collaborator
There was a problem hiding this comment.
also it's worth emphasizing that this is the different behavior that is supported by Fabric by default.
also we don't support cache for range reads (yet)
Co-authored-by: Jakub Dzikowski <jakub.t.dzikowski@gmail.com>
Co-authored-by: Jakub Dzikowski <jakub.t.dzikowski@gmail.com>
Co-authored-by: Jakub Dzikowski <jakub.t.dzikowski@gmail.com>
…ain-sdk into docs/new-questions
dzikowski
reviewed
Jun 2, 2025
Comment on lines
+82
to
+83
| - Track burn history | ||
| - Emit burn events |
Collaborator
There was a problem hiding this comment.
yeah - bumping this - we don't emit any events, and I'm not sure what does is mean in this context
|
|
||
| Note: The stub cache is specifically designed for transaction-level caching. This is different from Fabric's default behavior and is not supported by default in the Hyperledger Fabric framework. This support covers the most common use case of partial composite keys and queries, but does not yet support range reads (`RangedChainObject` / `getStateByRange`). | ||
|
|
||
| For cross-transaction data access patterns, consider implementing appropriate data structures and query patterns in your chaincode. |
Collaborator
There was a problem hiding this comment.
this is some extended description of how it works for cross chaincode calls, feel free to adapt it and improve language
Suggested change
| For cross-transaction data access patterns, consider implementing appropriate data structures and query patterns in your chaincode. | |
| For cross-transaction data access patterns (`stub.invokeChaincode()`), the SDK ensures the state consistency by limiting calls to other chaincodes. You may call multiple `DryRun` calls at the beginning of the transaction (SDK ensures this is the call with no writes), and then only a single other call. If you need to call multiple write transactions on another chaincode, you may use `BatchSubmit` method. |
| - Implement helper methods for relationship navigation | ||
| - Consider query performance when designing relationships | ||
| - Validate references before saving | ||
| - Document relationship patterns |
Collaborator
There was a problem hiding this comment.
I'd add something to explain that under the hood there is a KV store, and if you want to change the key, you need to remember about deleting the old object
| ### Question | ||
|
|
||
|
|
||
| What's the best way to emit and handle events in chaincode? |
Collaborator
There was a problem hiding this comment.
maybe we don't need this file at all?
| ### Question | ||
|
|
||
|
|
||
| What are the best practices for error recovery in chaincode? |
Collaborator
There was a problem hiding this comment.
I have a feeling both files: docs/questions/error-recovery-best-practices.md and docs/questions/errors-and-exceptions-in-chaincode.md are mostly irrelevant and misleading. What do we need is:
- The explanation of our error classes in general (the hierarchy, what is error key, what is error code, common methods). I'm not sure if Q&A is a good place, maybe it would be better for concepts. https://github.com/GalaChain/sdk/blob/main/chain-api/src/utils/error.ts
- The explanation how errors handling should look like in the transaction - uncaught throw => transaction fails, nothing is saved, and it it guaranteed here: https://github.com/GalaChain/sdk/blob/main/chaincode/src/contracts/GalaTransaction.ts#L232
- Edge cases, when partial success is allowed, like in
BatchSubmit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.