chore: siwx bitcoin jsdocs comments #3476
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
🦋 Changeset detectedLatest commit: ca40f8f The changes in this PR will be included in the next version bump. This PR includes changesets to release 18 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| /** | ||
| * The address to send the transfer to | ||
| */ |
There was a problem hiding this comment.
is this restricted to any specific type of addresS?
There was a problem hiding this comment.
no, i dont think it should
| /** | ||
| * The version of the SIWXMessage class | ||
| */ |
There was a problem hiding this comment.
what's the current / defualt version?
There was a problem hiding this comment.
there is no default version, this is an abstract class, the one extending it must provide a version
| /** | ||
| * This method generates the expiration time based on the `notBefore` value and the `expiration` value. | ||
| * You may override this method to provide a custom expiration time. | ||
| * | ||
| * @param Pick<SIWXMessage.Input, 'notBefore'> | ||
| * @returns string | undefined - The expiration time in `stringifyDate` format or undefined if not available | ||
| */ |
There was a problem hiding this comment.
is this a utility? or is this core to the package?
There was a problem hiding this comment.
this is an abstract class that must be extended to provide the functionality, this is only predefined logic
Description
Add jsdocs comments explaining params and functions from SIWX and Bitcoin packages.
Type of change
Associated Issues
For Linear issues: Closes APKT-xxx
For GH issues: closes #...
Showcase (Optional)
If there is a UI change include the screenshots with before and after state.
If new feature is being introduced, include the link to demo recording.
Checklist