Skip to content

Commit

Permalink
remove outdated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Pana committed Nov 28, 2023
1 parent a5d6326 commit dfff4a3
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ async function main() {

Besides `url` and `logger` you can pass [other options](https://github.com/Conflux-Chain/js-conflux-sdk/tree/faec50e6c2dd16158b114d0d4de228d7b2ca7535/api.md) to initialize a Conflux object

## Add account
### Add account

Private keys are required to approve any transaction made on your behalf, `conflux.wallet` provide utility help you manage your accounts

Expand All @@ -47,7 +47,7 @@ conflux.wallet.addPrivateKey('0x0123456789abcdef0123456789abcdef0123456789abcdef

**Only after you add your account to wallet, then you can use them send transactions.**

## Send JSON-RPC request
### Send JSON-RPC request

There are a lot methods on cfx object which are one-to-one with [Conflux node RPC methods](https://developer.confluxnetwork.org/conflux-doc/docs/json_rpc). All conflux methods will return a promise, so you can use it with `async/await` syntax.

Expand All @@ -67,16 +67,6 @@ Besides balance you can get a lot blockchain information through it, for example

**Note: from Conflux-rust v1.1.1 we have import a new base32 encoded address, the hex address can not be used then.**

In Conflux network there are three kind address:

* Normal address `0x1` prefix: `0x1386B4185A223EF49592233b69291bbe5a80C527`
* Contract address `0x8` prefix: `0x80a17fd515c1fc819e87e606c058490ac1f14ca7`
* Internal contract address `0x0888` prefix: `0x0888000000000000000000000000000000000000`

So normally a ethereum's address cann't used as conflux address, otherwise it starts with `0x1`

Notice: one address can have two form `checksumed` and `not checksumed`, these two actually are same account. For example `0x1386B4185A223EF49592233b69291bbe5a80C527` and `0x1386b4185a223ef49592233b69291bbe5a80c527` which point to same account.

### Conflux base32 checksum address

From `conflux-rust 1.1.1` Conflux has switch to base32Checksum address for example `cfxtest:aak2rra2njvd77ezwjvx04kkds9fzagfe6d5r8e957`. It was introduced by [CIP37](https://github.com/Conflux-Chain/CIPs/blob/master/CIPs/cip-37.md). `js-conflux-sdk` add support for it from version `1.5.10`, check [here](conflux_checksum_address.md) for details.
Expand Down

0 comments on commit dfff4a3

Please sign in to comment.