spectrum-finance / ergo-sdk-js Goto Github PK

If we try to use this package as an ESM module in Node (without any build tool), we get errors like this:

SyntaxError: Named export 'Explorer' not found. The requested module '@ergolabs/ergo-sdk' is a CommonJS module, which may not support all module.exports as named exports.

This happens because the type or exports field is missing in package.json. Currently used module field in package.json is neither supported, nor the support is planned in Node. It was a proposal which was introduced by some bundlers like esbuild, but Node introduced a more powerful exports field.

Note that if this package is meant to be used only as an ESM module, adding a "type": "module" will suffice.

It seems that Registers type is not narrow enough:

The user may provide any string value as key, which is not correct.

It can be fixed easily with a mapped type:

- export type Registers = {[key: string]: HexString} 
+ export type Registers = {[Key in RegisterId]: HexString} 

It seems that Registers type is not narrow enough:

The user may provide any string value as key, which is not correct.

It can be fixed easily with a mapped type:

- export type Registers = {[key: string]: HexString} 
+ export type Registers = {[Key in RegisterId]: HexString} 

I initially gave his a try by throwing together a quick create-react-app and adding the ergo-sdk-js dependency, without realising there is a workaround required for using web assembly with create-react-app.

It took me a while to work out why, I found the answer by looking at the readme of the ergo-lib-wasm-browser readme.

It would be good to add the same comment about the required workaround to this repositories readme. What do you think?