docs: Add Filecoin Solidity Library FAQ #67
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.
PR: Add Filecoin Solidity Library FAQ
Overview
This PR introduces a comprehensive FAQ (
FAQ.md
) to the repository, addressing common questions and clarifications about the Filecoin Solidity Library. The goal is to provide developers with clear guidance on integrating the library, reducing confusion, and improving usability.Key Topics Covered
✅ Serialization and Address Handling – Differences between
serializeAddress
implementations and best practices for buffer allocation.✅ BigInt Handling – Explanation of zero representations, serialization optimizations, and consistent handling.
✅ Allowance and Token Transfers – How
transferFrom
,withdrawBalance
, andaddBalance
behave in different scenarios.✅ Filecoin Actor Calls – Expected return behaviors for missing data, handling of
publishStorageDeals
, and large data responses.✅ Miner API – Clarification on slashed/terminated miners and ownership rules for
CreateMiner
.✅ Power API – Explanation of
minerCount
and its inclusion/exclusion of terminated miners.✅ Security and Error Handling – Best practices for using
require
vs.assert
, and guidance on Filecoin precompiles.Why This Is Needed
Implementation Details
FAQ.md
in the root of the repository.