docs(flashtestations-sdk): prepare SDK for initial public release wit… #427
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
Melvillian
requested review from
0x00101010,
cgkol,
charlesma4,
dylanschmittle-uniswap,
kailuo-uniswap,
paranoiacblack and
trianglesphere
Graphite Automations"Request reviewers once CI passes on sdks monorepo" took an action on this PR • (11/04/25)3 reviewers were added and 1 assignee was added to this PR based on Siyu Jiang (See-You John)'s automation. |
Melvillian
force-pushed
the
flashtestations-sdk/prepare-for-publishing
branch
2 times, most recently
from
0ce1972 to
08515e4
Compare
paranoiacblack
approved these changes
Nov 6, 2025
sdks/flashtestations-sdk/README.md
Outdated
| ``` | ||
|
|
||
| Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly. | ||
| Returns an array of supported chain IDs: `[130, 1301, 22444422, 33611633]` |
There was a problem hiding this comment.
We have plans to reset/redeploy Unichain Experimental next week and it's unclear if it will be a new chain ID or not (probably will). I note that to say maybe this documentation shouldn't mention the other chain IDs beyond the stable ones like Unichain Sepolia and Unichain Mainnet.
Collaborator
Author
There was a problem hiding this comment.
good point, I've removed these from the README.
Melvillian
force-pushed
the
flashtestations-sdk/prepare-for-publishing
branch
from
08515e4 to
3c3906e
Compare
…h comprehensive documentation This commit prepares the flashtestations-sdk for its initial public release by: 1. Overhauling documentation and cleaning up the public API surface. 2. Transforming the README from a generic TSDX template into comprehensive SDK documentation including installation instructions, API reference, error handling guide, advanced usage patterns, and practical examples. 3. Unused example files (getBlock.ts and getTransactionReceipt.ts) have been removed In a future commit we will update the version number to 1.0.0 and publish the SDK to npm improving VerificationResult handling rename getFlashtestationTx -> getFlashtestationEvent this name better matches the data that is returned by the function
Melvillian
force-pushed
the
flashtestations-sdk/prepare-for-publishing
branch
from
3c3906e to
a5c0690
Compare
charlesma4
approved these changes
Nov 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…h comprehensive documentation
This commit prepares the flashtestations-sdk for its initial public release by:
In a future commit we will update the version number to 1.0.0 and publish the SDK to npm
How Has This Been Tested?
Manually
Are there any breaking changes?
Yes, but not in use yet so it's fine
(Optional) Feedback Focus
run
yarn testto ensure tests still pass, and runnpx tsx examples/verifyBlock.tsas well asnpx tsx examples/getFlashtestationTx.tsto make sure those work given the newsrc/index.tsimports work as expected for those examples.