docs(bindings): add usage example to attestation-registry README - #292
Merged
ink-mami merged 1 commit intoSep 3, 2026
Merged
Conversation
Downstream consumers had no starting point for calling attest or get_attestation beyond reading the generated source. Add an illustrative TypeScript snippet showing the full flow: constructing the Contract, submitting an attestation, then reading it back. 🤖 Generated with Codebuff Co-Authored-By: Codebuff <noreply@codebuff.com>
|
@lekescrew22 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Closes #224
Closes #225
Closes #226
Closes #227
Summary
Adds a Usage section to
bindings/attestation-registry/README.mdwith a short, clearly-illustrative TypeScript example. Downstream consumers wanting to callattestorget_attestationfrom TypeScript previously had no starting point beyond reading the generated source directly.Changes
# Usagesection tobindings/attestation-registry/README.mdContractfrom the exportednetworksconstantattest()with{ attester, record_hash }and submitting viasignAndSend()get_attestation()Why
The generated binding README walked through editor-based discovery (
contract.|) but gave no concrete callable example. This mirrors the API surface insrc/index.ts—attester: string,record_hash: Buffer, and results surfaced on the returnedAssembledTransaction— so consumers can copy a working starting point.Testing
bindings/attestation-registry/src/index.ts.