darwinia-network / darwinia.js-1.0-deprecated

Javascript API and Types
Apache License 2.0
5 stars 4 forks source link

Improve key packages description #50

Closed hackfisher closed 2 years ago

hackfisher commented 2 years ago
cinlk commented 2 years ago
  • @polkaodt/api : API framework package for substrate chains.
  • Packages for darwinia's chains:

    • @darwinia/types : Definition of customize types for Darwinia's chains(Darwinia, Crab, Crab parachain, Pangolin/Pangoro etc), for blocks before Substrate Metadata V14. Probably not used by @polkaodt/api for blocks>= Substrate Metadata V14. @polkaodt/api is supposed to handle for different Metadata automaticlly.
    • @darwinia/api-derive: TBD. Derived api for darwinia.
    • @darwinia/rpc: TBD. RPC definition for darwinia customized rpcs.
  • @darwinia/api-options: Sample and easy options with @darwinia/types, @darwinia/api-derive, @darwinia/rpc as default settings.

done in #55