Cookbooks sdk-js: versioned #851

andreibancioiu · 2024-03-26T14:49:37Z

Description of the pull request (what is new / what has changed)

Separate pages / cookbooks for previous, current and next versions of SDK-JS.

Did you test the changes locally ?

yes
no

Which category (categories) does this pull request belong to?

document new feature
update documentation that is not relevant anymore
add examples or more information about a component
fix grammar issues
other

andreibancioiu · 2024-03-27T07:23:32Z

docusaurus.config.js

+          },
+          {
+            from: "/sdk-and-tools/sdk-js/sdk-js-cookbook",
+            to: "/sdk-and-tools/sdk-js/sdk-js-cookbook-v12",


When v13 is released, we will adjust this.

andreibancioiu · 2024-03-27T07:23:42Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-versions.md

+ - [Cookbook v12 **(stable, current version)**](/sdk-and-tools/sdk-js/sdk-js-cookbook-v12)
+ - [Cookbook v13 **(unstable, upcoming version)**](/sdk-and-tools/sdk-js/sdk-js-cookbook-v13)


When v13 is released, we will adjust this page.

andreibancioiu · 2024-03-27T07:28:29Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v12.md

-title: Cookbook
+id: sdk-js-cookbook-v12
+title: Cookbook (v12)
+pagination_next: sdk-and-tools/sdk-js/extending-sdk-js


When v13 is released, we will adjust this.

andreibancioiu · 2024-03-27T07:28:35Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+---
+id: sdk-js-cookbook-v13
+title: Cookbook (v13)
+pagination_next: null


When v13 is released, we will adjust this.

andreibancioiu · 2024-03-27T07:28:50Z

sidebars.js

+              {
+                label: "Cookbook",
+                type: "doc",
+                id: "sdk-and-tools/sdk-js/sdk-js-cookbook-v12",


When v13 is released, we will adjust this.

andreibancioiu · 2024-03-27T08:36:24Z

docusaurus.config.js

@@ -325,11 +325,11 @@ const config = {
          },
          {
            from: "/sdk-and-tools/erdjs/erdjs-cookbook",
-            to: "/sdk-and-tools/sdk-js/sdk-js-cookbook",
+            to: "/sdk-and-tools/sdk-js/sdk-js-cookbook-versions",


Old link (erdjs) goes to the versions page.

popenta · 2024-03-27T08:28:42Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v12.md

-title: Cookbook
+id: sdk-js-cookbook-v12
+title: Cookbook (v12)
+pagination_next: sdk-and-tools/sdk-js/extending-sdk-js
 ---

 [comment]: # (mx-abstract)

 This page will guide you through the process of handling common tasks using **sdk-js**.


I would also add something like:

This is an older version of sdk-js, please use the latest one (v13).

Indeed, but we'll write this only after releasing v13 as a stable release.

popenta · 2024-03-27T08:33:08Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+
+[comment]: # (mx-abstract)
+
+This page will guide you through the process of handling common tasks using **upcoming versions** of **sdk-js**.


[optional] Can also be:

This page will guide you through the process of handling common tasks using **the latest version** of **sdk-js**.

Indeed, but we'll write this only after releasing v13 as a stable release.

popenta · 2024-03-27T08:34:34Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+This page will guide you through the process of handling common tasks using **upcoming versions** of **sdk-js**.
+
+:::important
+This cookbook makes use of `sdk-js v13`. In order to migrate from `sdk-js v12.x` to `sdk-js v13`, please also follow [the migration guide](/sdk-and-tools/sdk-js/sdk-js-migration-guides).


Can also redirect to the github migration issue.

Indeed. Now redirecting to multiversx/mx-sdk-js-core#392.

popenta · 2024-03-27T08:42:19Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+// Recommended approach: 
+
+const tx = new Transaction({
+    data: new TextEncoder().encode("food for cats"),


perhaps use Buffer to stay consistent

popenta · 2024-03-27T08:59:00Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+// Legacy approach: 
+
+const txLegacy = new Transaction({
+    data: new TransactionPayload("helloWorld"),
+    gasLimit: 70000,
+    sender: addressOfAlice,
+    receiver: addressOfBob,
+    value: "1000000000000000000",
+    chainID: "D"
+});
+
+txLegacy.setNonce(43);


I'd suggest we drop the legacy way of doing things since we still have the cookbook for v12 and we want people to do things the new way. By doing things the new way people also skip the breaking changes when we eventually drop the support for the old way. What do you think?

Indeed, good point. Removing legacy approaches from v13 cookbook.

popenta · 2024-03-27T09:01:53Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+txLegacy.setNonce(43);
+```
+
+### Broadcast using a network provider


Perhaps also sign the transaction using js-wallet, so the user has the complete flow. Just an idea.

Fixed, added.

popenta · 2024-03-27T09:02:32Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+:::important
+Note that the transactions **must be signed before being broadcasted**. 
+On the front-end, signing can be achieved using a signing provider.
+On this purpose, **we recommend using [sdk-dapp](https://github.com/multiversx/mx-sdk-dapp)** instead of integrating the signing providers on your own.


redirect to the sdk-dapp docs page instead of the GH repo.

popenta · 2024-03-27T09:07:56Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+
+Generally speaking, in order to create transactions that transfer native tokens or ESDT tokens, one should use the `TransferTransactionsFactory` class.
+
+::note


needs one more :. Should be :::note.

popenta · 2024-03-27T09:09:51Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+// The legacy approach of creating a "TransferTransactionsFactory":
+const legacyFactory = new TransferTransactionsFactory(new GasEstimator());
+```


if you agree, same comment as above, drop the legacy.

popenta · 2024-03-27T13:50:11Z

docs/sdk-and-tools/sdk-js/sdk-js-cookbook-v13.md

+
+// The new approach of creating a "TransferTransactionsFactory": 
+const factoryConfig = new TransactionsFactoryConfig({ chainID: "D" });
+const factory = new TransferTransactionsFactory({ config: factoryConfig, tokenComputer: new TokenComputer() });


TokenComputer is no longer needed on the constructor

andreibancioiu added 2 commits March 26, 2024 15:59

Sketch new pages for JS cookbook. Next & previous.

aeeb2fb

Sketch cookbook for next version.

a598a30

andreibancioiu changed the base branch from main to development March 26, 2024 14:49

andreibancioiu self-assigned this Mar 26, 2024

andreibancioiu marked this pull request as ready for review March 26, 2024 14:49

andreibancioiu changed the title ~~Cookbooks js more~~ Cookbooks sdk-js: more versions (previous, current, next) Mar 26, 2024

andreibancioiu added 3 commits March 26, 2024 20:07

More versions of the cookbook.

11dd89e

Redirect to stable version.

1b9583d

Without v11.

4b88b18

andreibancioiu changed the title ~~Cookbooks sdk-js: more versions (previous, current, next)~~ Cookbooks sdk-js: versioned Mar 27, 2024

andreibancioiu commented Mar 27, 2024

View reviewed changes

bogdan-rosianu previously approved these changes Mar 27, 2024

View reviewed changes

andreibancioiu commented Mar 27, 2024

View reviewed changes

Fix redirects.

7beb7df

andreibancioiu dismissed bogdan-rosianu’s stale review via 7beb7df March 27, 2024 08:35

andreibancioiu commented Mar 27, 2024

View reviewed changes

popenta reviewed Mar 27, 2024

View reviewed changes

andreibancioiu added 2 commits March 27, 2024 13:54

Fix after review (part 1).

d49985f

Fix after review.

4d5c65a

bogdan-rosianu approved these changes Mar 27, 2024

View reviewed changes

popenta approved these changes Mar 27, 2024

View reviewed changes

andreibancioiu merged commit ac4d1cd into development Mar 27, 2024
2 checks passed

andreibancioiu deleted the cookbooks-js-more branch March 27, 2024 13:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cookbooks sdk-js: versioned #851

Cookbooks sdk-js: versioned #851

andreibancioiu commented Mar 26, 2024

andreibancioiu Mar 27, 2024

andreibancioiu Mar 27, 2024

andreibancioiu Mar 27, 2024

andreibancioiu Mar 27, 2024

andreibancioiu Mar 27, 2024

andreibancioiu Mar 27, 2024

popenta Mar 27, 2024

andreibancioiu Mar 27, 2024

popenta Mar 27, 2024

andreibancioiu Mar 27, 2024

popenta Mar 27, 2024

andreibancioiu Mar 27, 2024 •

edited

Loading

popenta Mar 27, 2024

andreibancioiu Mar 27, 2024

popenta Mar 27, 2024

andreibancioiu Mar 27, 2024

popenta Mar 27, 2024

andreibancioiu Mar 27, 2024

popenta Mar 27, 2024

andreibancioiu Mar 27, 2024

popenta Mar 27, 2024

andreibancioiu Mar 27, 2024

popenta Mar 27, 2024

andreibancioiu Mar 27, 2024

popenta Mar 27, 2024

		- [Cookbook v12 (stable, current version)](/sdk-and-tools/sdk-js/sdk-js-cookbook-v12)
		- [Cookbook v13 (unstable, upcoming version)](/sdk-and-tools/sdk-js/sdk-js-cookbook-v13)


		[comment]: # (mx-abstract)

		This page will guide you through the process of handling common tasks using upcoming versions of sdk-js.


		Generally speaking, in order to create transactions that transfer native tokens or ESDT tokens, one should use the `TransferTransactionsFactory` class.

		::note

Cookbooks sdk-js: versioned #851

Cookbooks sdk-js: versioned #851

Conversation

andreibancioiu commented Mar 26, 2024

Description of the pull request (what is new / what has changed)

Did you test the changes locally ?

Which category (categories) does this pull request belong to?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andreibancioiu Mar 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andreibancioiu Mar 27, 2024 •

edited

Loading