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

Multisig documentation #2033

Merged
merged 11 commits into from
Oct 27, 2022
Merged

Multisig documentation #2033

merged 11 commits into from
Oct 27, 2022

Conversation

claudebarde
Copy link
Contributor

Added documentation for multisig contract interaction and reordered the doc chapters in the sidebar

@netlify
Copy link

netlify bot commented Oct 17, 2022

Deploy Preview for taquito-test-dapp canceled.

Name Link
🔨 Latest commit a1d198b
🔍 Latest deploy log https://app.netlify.com/sites/taquito-test-dapp/deploys/635aab0f29569400082c2ca2

@github-actions
Copy link

github-actions bot commented Oct 17, 2022

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/

@codecov-commenter
Copy link

Codecov Report

Base: 81.62% // Head: 81.62% // No change to project coverage 👍

Coverage data is based on head (8b636d7) compared to base (11c55d4).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2033   +/-   ##
=======================================
  Coverage   81.62%   81.62%           
=======================================
  Files         222      222           
  Lines       12371    12371           
  Branches     2936     2936           
=======================================
  Hits        10098    10098           
  Misses       2272     2272           
  Partials        1        1           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@github-actions
Copy link

github-actions bot commented Oct 17, 2022

A new deploy preview is available on Netlify at https://c12236b--tezostaquito.netlify.app

}`;
```

First, we write the Michelson lambda that will be executed to transfer the tez, where `RECIPIENT_ADDRESS` is the public key of the recipient of the tez and `AMOUNT` is the amount of tez to be sent.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does RECIPIENT_ADDRESS the public key or public key hash?
Should amount of tez to be sent be amount of mutez to be sent ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

RECIPIENT_ADDRESS is for the public key (as in the text), however AMOUNT is for mutez, not tez, I corrected it, thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

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

It is key_hash in the lambda, so I thought it needed a public key hash rather than public key

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My bad, I got a little mixed up, correcting it right now, thank you!

Let's see how that translates into JavaScript:

```typescript
const lambda = `{
Copy link
Collaborator

Choose a reason for hiding this comment

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

This lambda can be imported by users and used a follow:

import { MANAGER_LAMBDA } from "@taquito/taquito";
MANAGER_LAMBDA.transferImplicit("tz1eY5Aqa1kXDFoiebL28emyXFoneAoVg1zh", 500)

See https://github.com/ecadlabs/taquito/blob/master/packages/taquito/src/contract/manager-lambda.ts#L15

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 know, that's where I got it from 😅 I thought it would be more interesting to expose the lambda here to show how it is constructed with the different values, what do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes I think it is perfect to expose the lambda, but I was thinking that we can add a note about the MANAGER_LAMBDA.transferImplicit telling the users that they don't have to write the lambda themself and can only import it instead. What do you think? :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, I only need the lambda here, I don't need to forge the operation, is it possible to import the lambda alone? I tried to look into the folders in the Taquito repo and there are too many of them, I couldn't guess where it is 😅

Copy link
Collaborator

@roxaneletourneau roxaneletourneau Oct 19, 2022

Choose a reason for hiding this comment

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

This MANAGER_LAMBDA.transferImplicit("tz1eY5Aqa1kXDFoiebL28emyXFoneAoVg1zh", 500) returns the lambda actually. It is not forging anything.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perfect, I updated the doc to mention the MANAGER_LAMBDA

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's been added!

yarn.lock Outdated
@@ -2037,7 +2037,7 @@
dependencies:
"axios" "^0.26.0"

"@taquito/ledger-signer@file:/Users/zainensuzuki/code/taquito/packages/taquito-ledger-signer":
@taquito/ledger-signer@file:/Users/zainensuzuki/code/taquito/packages/taquito-ledger-signer":
Copy link
Collaborator

Choose a reason for hiding this comment

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

👀

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry 😬 It's fixed now, thanks!

@@ -18,3 +18,5 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*
yarn.lock
package-lock.json
Copy link
Collaborator

Choose a reason for hiding this comment

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

package-lock.json should not be added to the website/.gitignore because when we add or update a new dependency, we have to commit it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No problem, it's been updated!

@roxaneletourneau roxaneletourneau merged commit 584debf into master Oct 27, 2022
@roxaneletourneau roxaneletourneau deleted the multisig-doc branch October 27, 2022 17:41
egarson pushed a commit that referenced this pull request Nov 16, 2022
* Added documentation for multisig and reordered the doc chapters in the sidebar

* Pushing uncommitted changes

* Added mention of MANAGER_LAMBDA

* Corrected error in text

* Corrected error in doc

* Corrected typo in yarn.lock file

* Updated boilerplate section of the doc

* Removed conflicting yarn.lock files

* Updated .gitignore in /website
egarson added a commit that referenced this pull request Nov 16, 2022
* Re-work leading section

* Compress SemVer discussion and break into sections

* Incorporate feedback as solicited on hackmd.io/aYu2xvrFRbyiYtvgMpeBtw

* Mk 1988 add more beacon wallet tests  (#1991)

* edits

* more tests

* added tests

* test(beacon wallet): add unit tests for bacon wallet

* test: fix PR

* test(fix the pr): fix the PR

* test(fix package problem): fix package problem

* test: fix merge conflict

* changes per review

* add package locks

* Multisig documentation (#2033)

* Added documentation for multisig and reordered the doc chapters in the sidebar

* Pushing uncommitted changes

* Added mention of MANAGER_LAMBDA

* Corrected error in text

* Corrected error in doc

* Corrected typo in yarn.lock file

* Updated boilerplate section of the doc

* Removed conflicting yarn.lock files

* Updated .gitignore in /website

* fix: upgrade @svgr/webpack from 6.3.1 to 6.4.0

Snyk has created this PR to upgrade @svgr/webpack from 6.3.1 to 6.4.0.

See this package in npm:
https://www.npmjs.com/package/@svgr/webpack

See this project in Snyk:
https://app.snyk.io/org/roxane/project/ad4c74dc-f97a-4a6b-8c68-4c305b03e490?utm_source=github&utm_medium=referral&page=upgrade-pr

* removed tests with references to timelock feature (#2083)

* 1630 ballot operation support in contract API (#2050)

* added estimate and contract ballot operation support

* added rpc contract provider for ballot op

* updated implementation and added docs

* added property in OperationContentsAndResultBallot and added unit test

* remove metadata property from ballot

* addressed PR comments

* updated yarn and package-lock

* cleaned up comments and switched out async for promise in op emitter

* removed unnecessary line break

* 660 support customize parser options (#2061)

* feat: exposed setParserProvider configuration through TezosToolkit

re #660

* test: added integration tests using setParserProvider with TezosToolkit

re #660

* docs: updated starting production server commands with taquito-test-dapp readme.md

* test: removed unnecessory console.log

re #660

* chore: update vite to latest version

* docs: fixed some typos in doc to address comments

re #660

* contract-security-non-existent-KT-address: use rpc (#2091)

* revert changes from ballot operation

* Bump @airgap/beacon-dapp to v 3.3.0

* build(deps): bump loader-utils from 1.4.0 to 1.4.1 in /packages/taquito

Bumps [loader-utils](https://github.com/webpack/loader-utils) from 1.4.0 to 1.4.1.
- [Release notes](https://github.com/webpack/loader-utils/releases)
- [Changelog](https://github.com/webpack/loader-utils/blob/v1.4.1/CHANGELOG.md)
- [Commits](webpack/loader-utils@v1.4.0...v1.4.1)

---
updated-dependencies:
- dependency-name: loader-utils
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

* build(deps): bump loader-utils from 1.4.0 to 1.4.1 in /website

Bumps [loader-utils](https://github.com/webpack/loader-utils) from 1.4.0 to 1.4.1.
- [Release notes](https://github.com/webpack/loader-utils/releases)
- [Changelog](https://github.com/webpack/loader-utils/blob/v1.4.1/CHANGELOG.md)
- [Commits](webpack/loader-utils@v1.4.0...v1.4.1)

---
updated-dependencies:
- dependency-name: loader-utils
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore(releng) bump version to 14.1.0-beta-RC.0

* Commit package-lock file for taquito-test-dapp

* Fix unit test related to version in ContractsLibrary

* Fix unit test related to version in ContractsLibrary

* Update taquito-test-dapp with taquito version 14.1.0-beta-RC.0

* chore(releng) bump version to 14.1.0

* Created version 14.1.0 on the Taquito Website

* 1630 ballot (#2107)

* added estimate and contract ballot operation support

* added rpc contract provider for ballot op

* updated implementation and added docs

* added property in OperationContentsAndResultBallot and added unit test

* remove metadata property from ballot

* addressed PR comments

* updated yarn and package-lock

* cleaned up comments and switched out async for promise in op emitter

* removed unnecessary line break

* renamed ballotenum to BallotVote

* update BallotEnum to BallotVote

* Add proposals operation support (#2112)

* add proposals operation

* added tests for proposals operation

* updated documentation to combine ballot and proposals op

* remove yarn lock files

* addressed PR comments and updated docs

* Fix typo (repeat of "breaking changes") in Release Timing section

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Michael Kernaghan <[email protected]>
Co-authored-by: Claude Barde <[email protected]>
Co-authored-by: snyk-bot <[email protected]>
Co-authored-by: Davis Sawali <[email protected]>
Co-authored-by: hui-an-yang <[email protected]>
Co-authored-by: Arvid Jakobsson <[email protected]>
Co-authored-by: roxaneletourneau <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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.

4 participants