Finished draft sdk documentation! update README

Renewwen commented 4 years ago

Finished draft js-sdk documentation! put Document document creation process to the README.

Renewwen commented 4 years ago

fixed some description issues...

Renewwen commented 4 years ago

three things:

beautify index page
simplify the navigation bar
Add @annotation to each page, prepare for next step work

Renewwen commented 4 years ago

Start to revamp and create examples for our js-SDK.

Test the APIs one by one to understand how each one work,
Identify/list the missing feature.

Specifically, I am starting from the Blockchain class in the harmony-core package.

Renewwen commented 4 years ago

Position:

harmony-core/Blockchain

New Issues:

The param "returnObject" is not work in functions: getBlockbyHash and getBlockbyNumber

Has revamped:

hmy.blockchain.getBalance()
hmy.blockchain.getBlockNumber()
hmy.blockchain.getBlockByHash()
hmy.blockchain.getBlockByNumber()
hmy.blockchain.getBlockTransactionCountByHash()
hmy.blockchain.getBlockTransactionCountByNumber()
hmy.blockchain.getTransactionByBlockHashAndIndex()
hmy.blockchain.getTransactionByBlockNumberAndIndex()
hmy.blockchain.getTransactionByHash()
hmy.blockchain.getTransactionReceipt()
hmy.blockchain.getCxReceiptByHash()
hmy.blockchain.getCode()
hmy.blockchain.net_peerCount()
hmy.blockchain.net_version()
hmy.blockchain.getProtocolVersion()

Has hidden:

hmy.blockchain.constructor()
hmy.blockchain.setMessage()
hmy.blockchain.getRpcResult()

Renewwen commented 4 years ago

=== 2/7 ===

1. Index pages and hierarchy rebuild

2. APIs revamped

LeoHChen commented 4 years ago

Resolved the merge conflict in another PR. https://github.com/harmony-one/sdk/pull/20

harmony-one / sdk