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.

Sign up for GitHub

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

Jump to bottom

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 •
edited
Loading

[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.

@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
81f82f7
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
eab82bb
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
0259cdd
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
b1a2679
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
45223bd
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
a82b5cd
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
3b08821
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
bfd1f49
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
5d0a7cc
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
7b9d4c1
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
37e14e4
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
dc68be9
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
f259810
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
6fdda51
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
298b413
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
06af53b
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
e4853cf
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
fc2e2b0
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
a64564e
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
ae561ab
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
0a2974b
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
708d150
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
e018e9e
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
4523ffb
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
3c386ad
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
dffb59c
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
b58a460
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
8fa69af
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
a896a23
@hui-an-yang
Merge branch 'master' of https://github.com/ecadlabs/taquito
fd47258
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 17, 2024 •
edited
Loading

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 17, 2024 •
edited
Loading

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

Published packages:

npm i @taquito/tzip12@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/beacon-wallet@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/taquito@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/rpc@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/http-utils@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/core@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/remote-signer@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/signer@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/michel-codec@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/ledger-signer@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/sapling@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/utils@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/timelock@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/michelson-encoder@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/tzip16@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/local-forging@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/contracts-library@20.0.1-d20dff3-- --registry https://npm.preview.tezostaquito.io/

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link

cloudflare-workers-and-pages bot commented Jun 17, 2024 •
edited
Loading

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

dsawali
dsawali reviewed Jun 18, 2024
View reviewed changes
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
Review: TZIP "Off-Chain Message Signing" #2879
Closed
@hui-an-yang hui-an-yang mentioned this pull request Jun 18, 2024
Closed
@hui-an-yang hui-an-yang marked this pull request as ready for review June 18, 2024 18:17
dsawali
dsawali approved these changes Jun 18, 2024
View reviewed changes
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
Reviewers

@dsawali dsawali dsawali approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Review: TZIP "Off-Chain Message Signing"
2 participants
@hui-an-yang @dsawali