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

2879 tzip32 doc #2994

Merged
merged 44 commits into from
Jul 16, 2024
Merged

2879 tzip32 doc #2994

merged 44 commits into from
Jul 16, 2024

Conversation

hui-an-yang
Copy link
Collaborator

@hui-an-yang hui-an-yang commented Jun 17, 2024

[website] Adding documentation to sign tzip32 off-chain message

Thank you for your contribution to Taquito.

Before submitting this PR, please make sure:

  • Your code builds cleanly without any errors or warnings
  • You have run the linter against the changes
  • You have added unit tests (if relevant/appropriate)
  • You have added integration tests (if relevant/appropriate)
  • All public methods or types have TypeDoc coverage with a complete description, and ideally an @example
  • You have added or updated corresponding documentation
  • If relevant, you have written a first draft summary describing the change for inclusion in Release Notes.

In this PR, please also make sure:

  • You have linked this PR to the issue by putting closes #TICKETNUMBER in the description box (when applicable)
  • You have added a concise description on your changes

Release Note Draft Snippet

If relevant, please write a summary of your change that will be suitable for
inclusion in the Release Notes for the next Taquito release.

Copy link

github-actions bot commented Jun 17, 2024

A new deploy preview is available on Cloudflare Pages at https://7c32cccf.taquito-test-dapp.pages.dev

Copy link

github-actions bot commented Jun 17, 2024

New packages have been deployed to the preview repository at https://npm.preview.tezostaquito.io/.

Published packages:

npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/

Copy link

cloudflare-workers-and-pages bot commented Jun 17, 2024

Deploying taquito with  Cloudflare Pages  Cloudflare Pages

Latest commit: 42b1ef7
Status: ✅  Deploy successful!
Preview URL: https://08bed531.taquito.pages.dev
Branch Preview URL: https://2879-tzip32-doc.taquito.pages.dev

View logs

docs/signing.md Outdated
@@ -141,6 +141,87 @@ const isVerified = verifySignature(
);
```

## Generating a tzip-32 message signature
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it is a good idea to capitalize to Tzip-32 here and everywhere else

docs/signing.md Outdated
@@ -141,6 +141,87 @@ const isVerified = verifySignature(
);
```

## Generating a tzip-32 message signature

The community have proposed [tzip-32](https://gitlab.com/tezos/tzip/-/blob/71be45d3ae2e15cec5c7a2f84feb88aac58fbe5e/drafts/current/draft-message-signing/tzip-32.md)(draft), Off-Chain Message Signing, which aims to define a formal message signing standard that is simple, secure, extendable and compatible with hardware wallets. Tzip-32 can be further used in [tzip-33](https://gitlab.com/tezos/tzip/-/blob/6483efc9e591960effe76f4ae996ec187bf13bf4/drafts/current/draft-sign-in-with-tezos.md)(draft) which is a [caip-122](https://chainagnostic.org/CAIPs/caip-122) compliant sign-in with Tezos standard.
Copy link
Contributor

Choose a reason for hiding this comment

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

also let's capitalize CAIP-122

@hui-an-yang hui-an-yang linked an issue Jun 18, 2024 that may be closed by this pull request
@hui-an-yang hui-an-yang marked this pull request as ready for review June 18, 2024 18:17
Copy link
Contributor

@dsawali dsawali left a comment

Choose a reason for hiding this comment

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

good work

@hui-an-yang hui-an-yang merged commit bb06ee6 into master Jul 16, 2024
8 of 9 checks passed
@hui-an-yang hui-an-yang deleted the 2879-tzip32-doc branch July 16, 2024 23:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review: TZIP "Off-Chain Message Signing"
2 participants