feat(sdk): documentation and tests for Magic Eden Wallet#145
Open
danadi7 wants to merge 7 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
50b37f0 to
4cb93c7
Compare
Nanosync
suggested changes
Mar 7, 2024
| @@ -185,8 +205,8 @@ Signs a message and returns a signature. | |||
| **Parameters**: | |||
Contributor
There was a problem hiding this comment.
Update the function signature above
| - `message` : `string` | ||
| - `address` (for Xverse only) : `string` - Wallet address to sign message | ||
| - `network` (for Xverse only) : `"mainnet" | "testnet"` (defaults to `mainnet`) - Network | ||
| - `address` (for Xverse and Magic Eden Wallet only) : `string` - Wallet address to sign message |
Contributor
There was a problem hiding this comment.
I think the documentation is becoming confusing for users.
We're adding different parameter cases for each wallet and there will eventually be many different combinations for N different wallets.
Can we separate parameters using TabItems for each wallet?
Also we should probably standardise this API using an object, so that additional parameters can be written here using a TS type
| export { getAddresses, isInstalled, signMessage, signPsbt }; | ||
| export { | ||
| getAddresses, | ||
| getMagicEdenWalletProvider, |
Contributor
There was a problem hiding this comment.
Let's not expose getMagicEdenWalletProvider to consumers, can we move it to magiceden/utils.ts instead?
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
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.
What this PR does / why we need it:
Which issue(s) does this PR fixes?:
Fixes #
Additional comments?: