[FilRPC Audit] js-lotus-client

[rvagg]

• FURTHER INVESTIGATION: Identify optional parameters and default values for docs & types (ref)
  • types: Fix types for calls where head is optional (ref)
• FURTHER INVESTIGATION: client.clientDealSize() -> client.clientStartDeal({Data:{PieceSize:X}}) results in piece size is invalid - doc or logic error? JS or Lotus? (ref)
• doc: More clearly document the separate (will feel weird because it's not clear to the user why it's this way) nature of file "import" and FileRef parts of the JS API (possibly also the Lotus API) maybe "fix" the API rather than doc? (ref)

[rvagg]

Questions regarding the list below:

• What is the current state of each item?
• What action items are there for each item and what is the urgency?

Top-level components:

• [ ] @filecoin-shipyard/lotus-client-schema
• [ ] @filecoin-shipyard/lotus-client-provider-browser)
• [ ] @filecoin-shipyard/lotus-client-provider-nodejs)
• [ ] @filecoin-shipyard/lotus-client-rpc

Docs and related items (action item could be: "remove this from docs"):

• [ ] "See it working here" ... (nope) https://bafybeihohzgi5fvbysfatkjvk4b5haussxiogyrml4p2gto2dn4cpziox4.ipfs.dweb.link/
• [ ] "Official" tutorial https://docs.filecoin.io/build/examples/network-inspector/overview/ - we removed this from docs.filecoin.io because it's outdated (along with 2 other examples)
• [ ] https://github.com/alanshaw/js-lotus-client-examples
• [ ] https://gist.github.com/jimpick/0b00bcd0a618238f3fe3ff89f9ac800c
• [ ] https://observablehq.com/collection/@jimpick/lotus-js-client
• [ ] https://github.com/filecoin-shipyard/js-lotus-client-workshop
• [ ] https://filecoin-shipyard.github.io/js-lotus-client/list-of-libraries.html - links outdated (openworklabs and signing tools)

[rvagg]

Exploration so far of js-lotus-client can be found in reports by @vasco-santos:

• https://github.com/protocol/w3dt-sudo/pull/6
• https://github.com/protocol/w3dt-sudo/pull/3

I think there's more to cover as these are initial-use + deal-focused usage. There's a lot more to the API and it might be good to focus on some other parts that are likely high-value to users.