web3data / web3data-js Goto Github PK

Use Case:

Users want to know if they are bounds issues when using a method that get's a specific index of a piece of data. Like transaction index.

Requirements:

• Go through methods getTransactionFromBlock & getUncle (any others that require index) throw 'Index out of bounds error'

I was surprised to find that the command npm i --save-dev @types/web3data-js resulted in error message '@types/web3data-js@latest' is not in the npm registry.

Please support typescript - publish @types/web3data-js

Bug:

Some of the subscriptions return double array as data.

Steps to replicate:

w3d.on({eventName: 'market:orders', filters: {"pair":"eth_btc", "exchange":"gdax"}, (data) => {
  console.log(data) // <-- this is a double array!!
})

Use Case:

Be consistent, be be consistent! 👏

Requirements:

• Change all occurrences of conditional error throwing to using throwIf()

Acceptance Criteria:

• All occurrences of conditional error throwing using throwIf()

Bug:

Calling .on before connect does not error elegantly (and perhaps it should not error).It might be necessary that it saves the subscription then connects after the .connect() method is called.

Steps to replicate:

const w3d = new Web3Data(API_KEY)
w3d.on({eventName: 'block'}, () => {
})
w3d.connect()

This will throw an x is undef error.

Reconnect logic doesn't execute when the websocket gets disconnected due to error 1006. It just gets stuck at Attempting to Reconnect... and it never reconnects. Attached is a screenshot.

Use Case:

• Users want to know when they successfully subscribe to an event. Let's tell them!

Requirements:

• Determine if this should be a console.log/info or if it should be a callback or if it should be a state variable?

• Once a subscription is established use console.info to indicate that the subscription was successfully established.

• Add tests

Acceptance Criteria:

• All tests pass

Use Case:

Users want an easy to use library that is in English (or their native tongue)! So let us do away with these blockchain Ids and add human readable constants for use of use and sanity.

Requirements:

• Determine best convention for naming and exposing constansts

• The blockchain Id constants are already defined so just add them to the Web3Data class for ease of use

Acceptance Criteria:

• blockchain Id constants added to the Web3Data

Ex:

Web3data.BLOCKCHAIN_ID_ETHEREUM_MAINNET
const w3d = new Web3data(API_KEY, {
   blockchainId: Web3data.BLOCKCHAIN_ID_ETHEREUM_MAINNET
})

There is an error that is caused by a missing null check at onError function

I am calling the web3Data.token.getHolders like this:

      const tokenHolders = await web3Data.token.getHolders(address, {
        page: this.#pageNumber,
        size: this.#pageSize
      });

And then I receive an error:

Stack trace: TypeError: Cannot read property 'data' of undefined
    at onError (C:\work\deep_load_data\node_modules\web3data-js\src\utils.js:72:30)
    at processTicksAndRejections (internal/process/task_queues.js:95:5)
    at async AmberdataTokenHoldersIterator.getItems (C:\work\deep_load_data\integrations\amberdata\amberdata.iterator.js:28:28)       
    at async TokenHoldersIterator.getItems (C:\work\deep_load_data\loaders\token-holders\token-holders.iterator.js:24:21)
    at async syncTokenHolders (C:\work\deep_load_data\loaders\token-holders\syncTokenHolders.js:38:27)
    at async syncSingleAddressTokenHolders (C:\work\deep_load_data\loaders\token-holders\syncTokenHolders.js:176:13)

Use Case:

Users want to use web3data event listeners like they use other javascript style listeners (standardization!!).

Requirements:

• Change the .on() method to allow a string for the event name rather than an object

Example:

w3d.on('block', {filters: {number: 7280000}}, () => {})

Use Case:

• Users want a library that prevents them from shooting themselves in the foot.

Requirements:

• Audi API to determine list of endpoints with required query params.

• Make these named parameters in the method rather than an optional filter.

Acceptance Criteria:

• ALL required query params are named method params

Websockets running ok during the last 3 months until today.

All websockets querys obtains a Js error: web3data.min.js:1 Uncaught RangeError: Maximum call stack size exceeded.

This error is also in example test index.html.

Currently there is no way to check what version is available for CDN based distribution:
https://unpkg.com/web3data-js/dist/web3data.min.js

The version of each built file should be added along the methods as a way to check package version.

Syntax Idea:
const version = Web3Data.version
console.log(version) // 0.7.3

Users want to have a drop in replacement for web3.js, so let's give it to them!

Requirements: (For developers)

Make this w3d.eth.getBalance() return a string not the whole payload

Acceptance Criteria: (For business & QA)

w3d.eth.getBalance() returns string

Use Case:

Users want a library that is up to date with our API! So they want to use a block id instead of number.

Requirements:

• Change all blocknumber params to block id for consistency

Acceptance Criteria:

• All blocknumber are now block id

• Error messages updated

• tests added

Question

How can I increase the timeout to allow slow running HTTP requests to complete?

Problem

My call to

web3Data.address.getBalance(walletAddress, { includeTokens: true, includePrice: true, currency: "usd" });

times out often but I can't find a way to increase the time.

Already Tried

I tried setting the axios default timeout to 600000 (10 minutes) but the timeout remained around 30 seconds

axios.defaults.timeout = 600000;
web3Data.address.getBalance(walletAddress, { includeTokens: true, includePrice: true, currency: "usd" });

Suggestion

It looks like axios is being used but there's no way to include override the axios configuration. Is there a way to override the axios configuration? Maybe something like

const options = { axiosRequestConfig: { timeout: 600000 } };
const web3Data = new Web3Data(apiKey, options);

Use Case:

• Users want to control the output to their console let us not hijack their stdout!

Requirements:

• Remove console.logs and use the users callback to communicate

Acceptance Criteria:

• Uses callback instead of console.logs to communicate

Use Case:

Users want a cohesive experience using web3data.js! So let's make that happen by providing param validation.

Requirements:

• validate event names and parameters for websockets

Use Case:

Users want to know when they are using websockets in correctly. If there is a required filter for an event please make that known to the user so they spend hours sitting and staring at the console waiting for data to show up.

Requirements:

• If a filter is required then error if the user does not provide this filter.

Use Case:

Users want convenience! Yay western world ideologies! In that vein, make it easy to unsubscribe but allowing the user to forgo the inclusion of the callback when calling off.

Requirements:

• Use the register with the deterministic uuid to locate the event that we want to unsubscribe from

• Then send unsubscribe to the server

Use Case:

Users want code that is compliant with JS standards! Wait who are we kidding JS has no standards! Either way we are misusing bind it should be apply to add the this context to a method.

Requirements:

• Change all occurrences of .bind to .apply

Acceptance Criteria:

-All tests passing