Support Node.js

[ferrell-code]

Support node

todo: Add documentation for using manta.js in node

Simple docs added to README

[Kevingislason]

Nice work, I tried to figure this stuff out and it was a nightmare.

After thinking it over, I think we may want to publish both the browser and node.js versions of the code together as a single npm package, assuming that doesn't break things. Users of node.js would simply import from manta.js/node, and users of manta.js would import from manta.js/browser. Running yarn build would run scripts to build for both targets. Since this would break current import paths, we would want to bump the major version of this package as well.

I think this change would help avoid human error while publishing these packages to npm, which could be potentially very serious. It's not strictly correct to have one package.json file for two different packages, because a package can only have one name, and that's what npm looks at when publishing. Although I would prefer to publish these packages in CI, we currently publish packages manually, for better or worse. Whenever I publish manta.js given the configuration in this PR, I would have to manually update the name in the package.json, and be very careful not to confuse the two different build targets. If the process for publishing packages isn't really straightforward there's room for human error, and I've definitely made mistakes in the past.

[ghzlatarev]

Nice work, I tried to figure this stuff out and it was a nightmare.

After thinking it over, I think we may want to publish both the browser and node.js versions of the code together as a single npm package, assuming that doesn't break things. Users of node.js would simply import from manta.js/node, and users of manta.js would import from manta.js/browser. Running yarn build would run scripts to build for both targets. Since this would break current import paths, we would want to bump the major version of this package as well.

I think this change would help avoid human error while publishing these packages to npm, which could be potentially very serious. It's not strictly correct to have one package.json file for two different packages, because a package can only have one name, and that's what npm looks at when publishing. Although I would prefer to publish these packages in CI, we currently publish packages manually, for better or worse. Whenever I publish manta.js given the configuration in this PR, I would have to manually update the name in the package.json, and be very careful not to confuse the two different build targets. If the process for publishing packages isn't really straightforward there's room for human error, and I've definitely made mistakes in the past.

@ferrell-code

[ferrell-code]

Yeah I'm looking into the best way to do that

[ferrell-code]

Ok this should make it so manta.js defaults to browser build. Please double check this doesn't break anything. It works in both node and browser environment for me.

No changes to browser... I could make it more explicit exporting browser build to ./browser instead of ./, but this way it isn't a breaking change

[ghzlatarev]

Ok this should make it so manta.js defaults to browser build. Please double check this doesn't break anything. It works in both node and browser environment for me.

No changes to browser... I could make it more explicit exporting browser build to ./browser instead of ./, but this way it isn't a breaking change

So still build it with yarn build-node right ?

[ferrell-code]

Yeah or there is now a build-all to build both and what ultimately should be run when publishing npm package.

Also you will need to delete your dist directory just once to not corrupt the path scheme

Updated so script is extra paranoid to clean dist directory

[ferrell-code]

Also needed to add a few more specs to node specific README. Not sure how easy to follow along it is

[ghzlatarev]

Yeah or there is now a build-all to build both and what ultimately should be run when publishing npm package.
Also you will need to delete your dist directory just once to not corrupt the path scheme
Updated so script is extra paranoid to clean dist directory

Getting this again after building with yarn build-all and package.json line: "manta.js": "file:../../Manta-Network/sdk/manta-js/package",

TSError: ⨯ Unable to compile TypeScript:
rpc_full_sync_test.ts:2:58 - error TS2307: Cannot find module 'manta.js/node' or its corresponding type declarations.

2 import { MantaPrivateWallet, Environment, Network } from 'manta.js/node';
                                                           ~~~~~~~~~~~~~~~

EDIT: nvm I see what I did wrong. It does work.

[ghzlatarev]

Also needed to add a few more specs to node specific README. Not sure how easy to follow along it is

Also needed to add a few more specs to node specific README. Not sure how easy to follow along it is

Yeah we need to mention it here https://github.com/Manta-Network/sdk/blob/main/manta-js/README.md?plain=1#L13-L18

[Kevingislason]

tested on front end, looks good

[Kevingislason]

err sorry, one more thing, still need to bump the version. I think 0.1.0 makes sense since there is significant new functionality but changes are not breaking

[Kevingislason]

Just lmk and I can publish the package

[ghzlatarev]

Just lmk and I can publish the package

Merge and publish

[ferrell-code]

good on my end, we can bundle #71 in this new release too, or have it bump another version

[Kevingislason]

I'm gonna bump the version to 1.0.0, I think there was a previously published version 0.1.0, and npm won't let me publish over it