Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the Snaps README to include RPC documentation #2561

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

LindaOrtega
Copy link
Contributor

@LindaOrtega LindaOrtega commented Oct 7, 2024

… snaps repo

Add RPC documentation to Snaps README

Short description:
Restructure the README of the snaps library to provide more information on what RPC methods are available with MetaMask Snap and how to use them.

Besides some minor re-structuring and re-wording, this content was copied over from another repository and was originally created by @nillo.

Test scenarios

  • Tested that the links worked correctly

Copy link

changeset-bot bot commented Oct 7, 2024

⚠️ No Changeset found

Latest commit: 156fc16

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Oct 7, 2024

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

7 Skipped Deployments
Name Status Preview Comments Updated (UTC)
alpha-docs ⬜️ Ignored (Inspect) Visit Preview 💬 Add feedback Oct 7, 2024 8:25pm
dev-wallet ⬜️ Skipped (Inspect) Oct 7, 2024 8:25pm
explorer ⬜️ Skipped (Inspect) Oct 7, 2024 8:25pm
kode-ui ⬜️ Skipped (Inspect) Oct 7, 2024 8:25pm
marmalade-marketplace ⬜️ Skipped (Inspect) Oct 7, 2024 8:25pm
proof-of-us ⬜️ Skipped (Inspect) Oct 7, 2024 8:25pm
tools ⬜️ Skipped (Inspect) Oct 7, 2024 8:25pm

@vercel vercel bot temporarily deployed to Preview – explorer October 7, 2024 20:24 Inactive
@vercel vercel bot temporarily deployed to Preview – marmalade-marketplace October 7, 2024 20:24 Inactive
@vercel vercel bot temporarily deployed to Preview – kode-ui October 7, 2024 20:24 Inactive
@vercel vercel bot temporarily deployed to Preview – proof-of-us October 7, 2024 20:25 Inactive
@vercel vercel bot temporarily deployed to Preview – tools October 7, 2024 20:25 Inactive
@vercel vercel bot temporarily deployed to Preview – dev-wallet October 7, 2024 20:25 Inactive

### kda_signTransaction

**Description**: Signs a transaction using the Kadena Snap. The transaction is expected to be a stringified JSON of the type [`ICommandPayload`](https://github.com/kadena-community/kadena.js/blob/f88301538ee41b77b957edf58a8a5edb4fba44cb/packages/libs/types/src/PactCommand.ts#L176).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wasn't sure where to fine a more permanent documentation link for ICommandPayload.

I derived that the expected request type was this from the following areas of the code:

But would appreciate it if someone else could verify as well.

Copy link
Collaborator

Choose a reason for hiding this comment

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

as we discussed, IPactCommand is more current

@Randynamic
Copy link
Contributor

@LindaOrtega can we update the linting and get this merged?

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

Successfully merging this pull request may close these issues.

4 participants