Staking wallet api refine #2950

hui-an-yang · 2024-05-03T17:30:42Z

@taquito/taquito updated walletAPI typedoc
integration-tests updated assertion to be robusst

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.

… be accurate

github-actions · 2024-05-03T17:33:59Z

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/

cloudflare-workers-and-pages · 2024-05-03T17:36:17Z

Deploying taquito with Cloudflare Pages

Latest commit:	`359e531`
Status:	✅ Deploy successful!
Preview URL:	https://18b097cf.taquito.pages.dev
Branch Preview URL:	https://staking-walletapi-refine.taquito.pages.dev

View logs

dsawali · 2024-05-03T20:33:24Z

packages/taquito/src/wallet/wallet.ts

   * @description Transfer all the finalizable unstaked funds of the source to their liquid balance
-   * @returns An operation handle with the result from the rpc node
-   *
+   * @returns A wallet command from which we can send the operation to the wallet


I would keep the previous description. This is technically correct, but doesn't tell our users much because a wallet command is just a helper method.

for contractAPI it will return and make sense to haveAn operation handle with the result from the rpc node but walletAPI does return a send command only, it's after the send command is called that will return a WalletOperaion, i think something like @returns A wallet command "send" to send the operation to the wallet that will return the WalletOperation might be more appropriate. Do you still think it's best to keep An operation handle with the result from the rpc node and update all operations supported in walletApi accordinly

@returns a wallet command... is not correct. The returns will bubble up. A stake method returns a Promise<TransactionWalletOperation> object. The description should not have to mention the 'wallet command' part of the execution. That should just stay internal.

The previous description is correct, but not explicit. If you want to make it a bit more clear. It should say something like @returns TransactionWalletOperation promise object, which contains the operation hash and the block response observable.

* feat: configured paris branch (#2911) * feat: configured paris branch * test: updated estimation assertion * 2884 remove get endorsing rights (#2916) * feat: removed rpc.getEndorsingRights * docs: update getBlock desc with default version 1 * test: updated estimation assertion * test: updated estimation assertion * test: updated estimation assertion * updated protocol constants test (#2918) * updated protocol constants test * updated constants response for proto20 * updated missing properties and estimation values * removed duplicate property * 2678 rpc ai launch cycle (#2919) * feat: support new rpc getAdaptiveIssuanceLaunchCycle and unit tests re #2678 * test: add integration test and updated response type and description * test: update test descript for clarity * test: update estimation consumedMilligas assertion * docs: updated docs/rpc_nodes_integration_test.md with getAdaptiveIssuanceLaunchCycle * 2887 update ai rpc (#2923) * feat: update getDelegates rpc type with adaptive issuance changes * test: updated estimation assertion * 2676 new ai rpc (#2926) * added staking support in contract API, with unit and integration tests (#2930) * added staking support in contract API, with unit and integration tests * updated ux to not require destination (for stake/unstake) and not require a param for finalize unstake * updated error message * addressed PR comments * remove wrong check * removed undefined check for a more general falsy check * feat: walletAPI supports stake, unstake, finalizeUnstake with integration-tests (#2935) * docs: adapting getPendingOperations version change in description (#2936) * feat: update rpc for dal (#2937) * chore(releng) bump version to 20.0.0-beta.0 * test: added pseudo-entrypoints-forgin.spec.ts (#2938) * updated baker account for staking tests (#2951) * updated baker account for staking tests * updated paris tests to not run on oxfordnet * Staking wallet api refine (#2950) * test: updated wallet/staking tests to be robust and walletAPI desc to be accurate * docs: address comments for typedoc * docs: added rounding explanation * Documentation for Staking (#2928) * docs: draft of documentation for staking * docs: modifications in response to An's comments * docs: fix spelling errors * docs: added code samples * docs: fixed mermaid error * docs: add a note to doc that staking will be disabled for about two weeks after protocol activation * docs: add wallet api code * 2880 forger attestation with dal (#2949) * feat: added rpc type of attestation_with_dal & endorsement_with_dal * feat: added local-forger support of attestation_with_dal * test: added unit tests * test: removed logging * New Paris protocol ticket literal (#2940) * ticket literal * legacy ticket typeckeck fix * feat: adding local-forger opMapping with Ticket --------- Co-authored-by: huianyang <[email protected]> * 2881 dal publish commitment (#2948) * feat: added rpc type of dal_publish_commitment * feat: added forger support of dal_publish_commitment * test: added dal_publish_commitment unit test * test: remove debug logging * docs: add comments for commitment_proof bytes length * Update Paris branch with newest Beacon version (v4.2.2-beta.4) (#2956) * update beacon version to v4.2.2-beta.4 * removed space * updated algoliasearch and fortawesome deps (#2954) * 2912 paris cleanup (#2957) * test: replaced all oxford ref with paris * test: updated test mentioning protocol * test: removed unneeded test case * test: refine failing_noop test * updated beacon wallet with new event sub (#2961) * added comment and trigger ci * chore(releng) bump version to 20.0.0-beta.1 * 2953 dapp staking (#2959) * feat: implement test-dapp set-delegate * feat: implement test-dapp stake/unstake/finalize-unstake * ci: removed pr test-dapp preview restirction * feat: support parisnet on test-dapp * feat: modified testnet specific test names * Dependencies 20240521 (#2965) * build: snyk suggested website dependencies upgrade * build: dependabot suggested dependencies upgrade * docs: udpate website rpc_nodes page (#2966) * chore(releng) bump version to 20.0.0-RC.0 * feat: adding new protocol hash (#2974) * feat: adding new protocol hash PtParisBxoLz5gzMmn3d9WBQNoPSZakgnkMC2VNuQ3KXfUtUQeZ * addressed review comment * feat: supporting getAllDelegates in rpc (#2975) * feat: supporting getAllDelegates in rpc * test: remove unneeded logging * chore(releng) bump version to 20.0.0-RC.1 * chore: satisfy lerna * chore(releng) bump version to 20.0.0 * test: adjusted tests for paris2 protocol (#2980) * updated estimate test values and mainnet constants for paris (#2982) * updated estimate test values and mainnet constants for paris * updated assertion to check for a 403 instead of 401 (old node response) --------- Co-authored-by: huianyang <[email protected]> Co-authored-by: hui-an-yang <[email protected]> Co-authored-by: ac10n <[email protected]> Co-authored-by: Eugene Zagidullin <[email protected]>

hui-an-yang added 8 commits April 12, 2024 16:32

Merge branch 'paris' of https://github.com/ecadlabs/taquito into paris

e52f40a

Merge branch 'paris' of https://github.com/ecadlabs/taquito into paris

4aaff0f

Merge branch 'paris' of https://github.com/ecadlabs/taquito into paris

8e0a88e

Merge branch 'paris' of https://github.com/ecadlabs/taquito into paris

de6f509

Merge branch 'paris' of https://github.com/ecadlabs/taquito into paris

e92898b

Merge branch 'paris' of https://github.com/ecadlabs/taquito into paris

31738db

Merge branch 'paris' of https://github.com/ecadlabs/taquito into paris

ff4e343

test: updated wallet/staking tests to be robust and walletAPI desc to…

af3d5b6

… be accurate

hui-an-yang requested a review from dsawali May 3, 2024 17:55

hui-an-yang marked this pull request as ready for review May 3, 2024 17:55

dsawali suggested changes May 3, 2024

View reviewed changes

docs: address comments for typedoc

196aa66

dsawali approved these changes May 6, 2024

View reviewed changes

docs: added rounding explanation

359e531

dsawali approved these changes May 6, 2024

View reviewed changes

hui-an-yang merged commit cce27ff into paris May 6, 2024
6 of 8 checks passed

hui-an-yang deleted the staking-walletAPI-refine branch May 6, 2024 18:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Staking wallet api refine #2950

Staking wallet api refine #2950

hui-an-yang commented May 3, 2024 •

edited

Loading

github-actions bot commented May 3, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented May 3, 2024 •

edited

Loading

dsawali May 3, 2024

hui-an-yang May 3, 2024

dsawali May 3, 2024

Staking wallet api refine #2950

Staking wallet api refine #2950

Conversation

hui-an-yang commented May 3, 2024 • edited Loading

Release Note Draft Snippet

github-actions bot commented May 3, 2024 • edited Loading

Published packages:

cloudflare-workers-and-pages bot commented May 3, 2024 • edited Loading

Deploying taquito with Cloudflare Pages

dsawali May 3, 2024

Choose a reason for hiding this comment

hui-an-yang May 3, 2024

Choose a reason for hiding this comment

dsawali May 3, 2024

Choose a reason for hiding this comment

hui-an-yang commented May 3, 2024 •

edited

Loading

github-actions bot commented May 3, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented May 3, 2024 •

edited

Loading