Node Public Interfaces Team Weekly Update - 2021-10-08

[frol]

The previous update is #4876. See more engineering updates posted on gov.near.org

Brief Summary

• Node Interfaces team updated and finalized OKRs for 2021Q4 and we start using those in our weekly updates. Our hope is that objectives and key-results will bring more context on the team efforts to NEAR community! (See the final version of OKRs at the end of this post)
• near-jsonrpc-client-rs approaches it first release on crates.io! (Kudos to @miraclx)

Blockers

• Someone published Rust crates from nearcore ahead of us and blocks us from publishing the new version of near-jsonrpc-client-rs. We reached out to them through github: Invitation to try out the new client + publishing to Crates.io bicarus-labs/near-api-rs#1

Result

(Acronyms: O - Objective, KR - Key Result)

• O1: Support success of DevConsole

  • KR1: Provide knowledge, experience and hands-on help with DevConsole bootstrap
    • Scheduled and start preparing the talk about Analytics tool https://github.com/near/near-analytics (@telezhnaya)
      Feel free to join on Monday, October 11⋅14:00 UTC: https://meet.google.com/dxk-qksy-oxp

• O3: Remove friction from building dApps

  • KR1: FT / NFT information is easily available for the developers
    • Created the DB interface for storing NFT events (@telezhnaya)
      feat: add NFT events support near-indexer-for-explorer#169
  • KR3: Release near-jsonrpc-client-rs
    • chore: mark all but a few crates private (unpublishable) #4909 from last week just recently got merged, we're back on track with publishing, pending finalization. (@miraclx)
    • Moved adversarial features from near-jsonrpc-primitives to a dedicated crate and hence, freed up the dependency on near-network, make it publishable refactor(jsonrpc-primitives): move adversarial to own specialized crate #4912 (@miraclx)
    • Added a means for constructing generic requests with the new methods::any() function. feat: impl smarter Any result descriptors near-jsonrpc-client-rs#15 (@miraclx)
      • Implemented to be smart(-er) on response/error deserialization side through proper typing (optionally including raw json if you so desire).
    • Shrunk the JsonRpcClient::call() size by extracting error parsing. near/near-jsonrpc-client-rs@4468482 (@miraclx)
      • Implemented From<near_jsonrpc_primitives::RpcError> for near_jsonrpc_client::JsonRpcError to reuse that sweet error parsing functionality.
  • KR5: Maintain 99.99% uptime for Indexer for Explorer
    • Refactor retry logic on indexer-for-explorer side (@khorolets)
      refactor: Retry or panic macros to replace code duplication and add panic after N attempts near-indexer-for-explorer#168
    • Finalizing the handbook about indexer-for-explorer (@khorolets)
  • KR6: Stabilize automation of Analytics for Explorer
    • Manually handled timeouts in https://github.com/near/near-analytics (@telezhnaya)

• O4: Give users better insights about the current and historical status of the network

  • KR2: Explorer enables efficient exploration of NEAR history
    • Moved telemetry information about validators from sqlite to postgres database (@shelegdmitriy)
      refactor(frontend): Move telemetry to database near-explorer#753
    • Added a possibility to search by receipt_id (@shelegdmitriy)
      feat(frontend): Add search by receipt_id near-explorer#755

• O5 (might be moved to SRE updates): Make RPC service reliable for the customers while keeping nodes infrastructure sustainable

  • Started working on a prototype for API key Authorization (new RPC nodes run an NGINX with an auth_request plugin) (@chefsale)

Action Items

• O3: Remove friction from building dApps
  • KR3: Release near-jsonrpc-client-rs
    • Now that we have all the dominoes in place, we can finalize on the strategy for publishing. (@miraclx + @chefsale)
    • Dropping the old near-jsonrpc-client from nearcore. (@miraclx)
      • Incremental developments here, but still inconclusive. Working with the new near-jsonrpc-client-rs in the context of which the old client was used is slightly tricky due to being properly typed but it's coming along good, I would say. Let's expect finalization in the coming week.
    • Document the new methods::any() generic constructor (hopefully before cutting the release). It's has capabilities that might not be immediately clear on first glance. (@miraclx)
      • Primarily the custom deserialization types (beyond those defined within the crate) and the ability to return raw json from the method handler's response / error if you so desire.

Objectives and Key-Results for Node Interfaces Team in 2021Q4

Node Interfaces Team (@khorolets @telezhnaya @miraclx @shelegdmitriy @chefsale @mhalambek) lead by @frol and in collaboration with DevPlatform leader @jberrytech defined the following objectives and key-results for the upcoming quarter:

O1: Support success of DevConsole
KR1: Provide knowledge, experience and hands-on help with DevConsole bootstrap | @khorolets and @telezhnaya
KR2: Developer tools should support RPC-as-a-Service authorization mechanism | @miraclx

O2: Support success of custodial wallets (shared with NodeExperience team)
KR1: Provide expertise and quick fixes to RosettaRPC on demand | @frol + NodeExperience team

O3: Remove friction from building dApps
KR1: FT / NFT information is easily available for the developers | @telezhnaya
KR2: Indexer-as-a-Service MVP is available for the early-adopters | @khorolets
KR3: Release near-jsonrpc-client-rs | @miraclx
KR4: Indexer Framework projects fully support nearcore sharding | @khorolets
KR5: Maintain 99.99% uptime for Indexer for Explorer | @khorolets
KR6: Stabilize automation of Analytics for Explorer | @telezhnaya
KR7: Indexer for Explorer storage is performant under the estimated load [aspirational] | @telezhnaya

O4: Give users better insights about the current and historical status of the network
KR1: Explorer features the status of NEAR network clearly and without downtimes | @frol + @reefoh + @shelegdmitriy
KR2: Explorer enables efficient exploration of NEAR history (navigation through history & search improvements) | @frol + @reefoh + @shelegdmitriy

O5: Make RPC service reliable for the customers while keeping nodes infrastructure sustainable
KR: To be announced by SRE team