Data NFT Publishing Code Example import errors

Question

Data NFT Publishing Code Example import errors

smejak opened this issue 2 years ago · 13 comments

Describe the bug
I am trying to run the ocean.js Code Examples but am running into issues with the imports and the typescript syntax.

Initially, I had linting errors due to the javascript file having typescript syntax, which I solved by removing the types, but then when trying to run the marketplace.js script (created from the code examples), I got the following errors on the imports:

The imports were initially from the ocean.js repo, not the ocean npm library, so I replaced those.

import { SHA256 } from 'crypto-js'                                                                                                                                                                                                            
         ^^^^^^                                                                                                                                                                                                                               
SyntaxError: Named export 'SHA256' not found. The requested module 'crypto-js' is a CommonJS module, which may not support all module.exports as named exports.

This one I solved by removing the curly brackets.

file:///Users/jakub/Development/marketplace-quickstart/marketplace.js:4                                                                                                                                   
  AmountsOutMaxFee,                                                                                                                                                                                                                           
  ^^^^^^^^^^^^^^^^                                                                                                                                                                                                                            
SyntaxError: Named export 'AmountsOutMaxFee' not found. The requested module '@oceanprotocol/lib' is a CommonJS module, which may not support all module.exports as named exports.

Again curly brackets, attempted solution with import * as o from '@oceanprotocol/lib', although that resulted in the last error which I wasn't able to solve.

Initially, I had

To Reproduce
Steps to reproduce the behavior:

Go to https://github.com/oceanprotocol/ocean.js/blob/main/CodeExamples.md
Go through the tutorial and put all javascript code into marketplace.js
Create package.json as described in the tutorial, start barge, run npm i
Add "type": "module" in package.json, it should look like this:

{
  "name": "marketplace-quickstart",
  "type": "module",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@oceanprotocol/contracts": "1.0.0-alpha.28",
    "@oceanprotocol/lib": "^1.0.0-next.37",
    "crypto-js": "^4.1.1",
    "web3": "^1.7.3"
  }
}

Remove explicit type declarations to avoid syntax errors
Remove the local imports (cannot work unless running in a clone of the ocean.js repo) and replace with

import SHA256 from 'crypto-js'
import * as o from '@oceanprotocol/lib'

Add o. to every oceanlib function/class that is used in the script (can be found from the orginial imports)
Run node marketplace.js in your terminal
See the error https://gist.github.com/smejak/468cc1f635b60a6526fa9ec48eab8789

Expected behavior
The marketplace publishing flow as described in Code Examples

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]
Browser [e.g. chrome, safari]
Version [e.g. 22]

Smartphone (please complete the following information):

Device: [e.g. iPhone6]
OS: [e.g. iOS8.1]
Browser [e.g. stock browser, safari]
Version [e.g. 22]

Additional context
Add any other context about the problem here.

npm version 8.12.1
Node.js v18.5.0

Answer 1 · 2022-07-14T11:54:14.000Z

@AnaLoznianu @jamiehewitt15 We also need to adapt the changes added in #1537 to the CodeExamples.md file to solve these issues.

Answer 2 · 2022-07-19T04:57:20.000Z

@miquelcabot I tried implementing the updates to CodeExamples.md from #1537 but I'm running into the same errors.

Firstly, where does the config

import { web3, getTestConfig, getAddresses } from '../config'

come from? Is it supposed to be from oceanlib as well or something else?

Also, CodeExamples.md in #1537 still says to create a marketplace.js, but then uses typescript syntax like type annotations or the ? modifier, which cause errors in the javascript linter (at least on my side).

Answer 3 · 2022-07-19T05:39:27.000Z

@smejak These files/imports come from the /test folder. And you are right referring to the .js/.ts problem.
We need to review these issues in both CodeExamples.md and C2DExamples.md files.
Thanks for your comments!

Answer 4 · 2022-07-19T05:48:19.000Z

@miquelcabot Thank you for the response! Regarding my earlier post where I modified the imports & resolved the ts/js problem, do you have an idea about what might be causing the error I linked here https://gist.github.com/smejak/468cc1f635b60a6526fa9ec48eab8789?

Answer 5 · 2022-07-19T05:54:56.000Z

@smejak They seem to be problems related to the package.json or tsconfig.json configuration files.
You can check this repository https://github.com/miquelcabot/themap-ocean.js to see a simple use of the Ocean.js library. Warning: it's WIP!

Answer 6 · 2022-07-20T17:32:50.000Z

@AnaLoznianu This issue is solved in #1537

Answer 7 · 2022-07-21T08:02:57.000Z

@miquelcabot Thanks for letting me know. We will review the C2D PR in the following days

Answer 8 · 2022-07-23T10:19:49.000Z

Hey @miquelcabot, I'm following your #1537 and am getting the following error:

Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: Package subpath './dist/test/config' is not defined by "exports" in /Users/jakub/Development/Algovera/Ocean/oceanjs_scripts/v4/node_modules/@oceanprotocol/lib/package.json

which is probably caused by this line:

import { getAddresses, getTestConfig, web3 } from '@oceanprotocol/lib/dist/test/config'

I have tried adding @oceanprotocol/lib/dist/test/config explicitly to my package.json but that didn't work. Any ideas on how I could fix this? Or are there perhaps examples on how I can specify rinkeby config for testing instead of using barge?

Answer 9 · 2022-07-23T12:04:15.000Z

@smejak Ok. I'm getting the same issue. I will fix it. Thanks for pointing out the error.

Answer 10 · 2022-07-23T16:40:44.000Z

@miquelcabot Thank you. Do you know of any examples for configuring ocean.js to rinkeby with a predefined wallet? I would like to ultimately use this flow in production but am running into an error in step 7. of the flow, specifically here:

const tx = await factory.createNftErc20WithFixedRate(
      publisherAccount,
      nftParams,
      erc20Params,
      freParams
 )

I initialized my config with rinkeby URLs, but I'm probably missing something because I'm getting the following error:

ERROR: Estimate gas failed! Error: Provided address [object Object] is invalid, the capitalization checksum test failed, or it's an indirect IBAN address which can't be converted.
/Users/jakub/Development/Algovera/Ocean/oceanjs_scripts/v4/node_modules/web3-core-helpers/lib/errors.js:28
        var err = new Error('Returned error: ' + message);
                  ^

Error: Returned error: {"context":{"id":1,"jsonrpc":"2.0","method":"eth_gasPrice","params":[]},"error":"405 Method Not Allowed: The method is not allowed for the requested URL."}

My WIP code is here https://github.com/smejak/oceanjs_scripts/blob/main/publish.js#L100 . Thanks for any suggestions!

Answer 11 · 2022-07-23T18:26:10.000Z

I think I'm looking for an alternative to getAddresses, because I think that requires all the contracts being deployed locally with barge running, although I think that's separate to the error above.

Answer 12 · 2022-07-23T19:04:05.000Z

@miquelcabot I have managed to solve the above error, but have been getting a JSON RPC error, which I traced back to my web3 provider, I changed it to the base address as shown here:
https://github.com/oceanprotocol/ocean.js/blob/efa3839d10befdbc35e16e61c8e9bf310039970b/src/utils/ConfigHelper.ts

however, the JSON RPC error was raised when I used the rinkeby nodeUri from the same ConfigHelper, so I'm not sure whether that means that rinkeby v4 is not connecting correctly or whether it's something else.

Answer 13 · 2022-11-17T14:35:38.000Z

Am I right in thinking this issue is solved now?