Skip to content

feat(sdk): documentation and tests for Magic Eden Wallet#145

Open
danadi7 wants to merge 7 commits into
mainfrom
danadi7/me-tests
Open

feat(sdk): documentation and tests for Magic Eden Wallet#145
danadi7 wants to merge 7 commits into
mainfrom
danadi7/me-tests

Conversation

@danadi7
Copy link
Copy Markdown
Contributor

@danadi7 danadi7 commented Mar 4, 2024

What this PR does / why we need it:

  • Add documentation for Magic Eden Wallet
  • Add test cases for Magic Eden Wallet

Which issue(s) does this PR fixes?:

Fixes #

Additional comments?:

@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
ordit-sdk ✅ Ready (Inspect) Visit Preview Mar 8, 2024 10:20am

Comment thread apps/docs/docs/api/browser-wallets.mdx Outdated
@@ -185,8 +205,8 @@ Signs a message and returns a signature.
**Parameters**:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the function signature above

Comment thread apps/docs/docs/api/browser-wallets.mdx Outdated
- `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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread apps/docs/docs/api/browser-wallets.mdx Outdated
Comment thread apps/docs/docs/api/browser-wallets.mdx Outdated
Comment thread apps/docs/docs/api/browser-wallets.mdx Outdated
export { getAddresses, isInstalled, signMessage, signPsbt };
export {
getAddresses,
getMagicEdenWalletProvider,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not expose getMagicEdenWalletProvider to consumers, can we move it to magiceden/utils.ts instead?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/feature New feature request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants