OSDN Git Service

add readme
[bytom/bytom-kit.git] / README.md
1 Bytom Kit
2 ==========
3
4 - [1 Motivation](#1-motivation)
5 - [2 Usage](#2-usage)
6   - [2.1 Key](#21-key)
7   - [2.2 Address](#22-address)
8   - [2.3 Sign](#23-sign)
9   - [2.4 Verify](#24-verify)
10   - [2.5 Submit Transaction](#25-submit-transaction)
11   - [2.6 Decode Raw Transaction](#26-decode-raw-transaction)
12   - [2.7 Testnet Faucet](#27-testnet-faucet)
13
14 ## 1 Motivation
15
16 Bytom Kit is a simple tool which can help developer to understand Bytom easily. It contains 36 api for now:
17
18 - sign
19 - verify
20 - create_entropy
21 - entropy_to_mnemonic
22 - mnemonic_to_seed
23 - seed_to_root_xprv
24 - xprv_to_expanded_private_key
25 - xpub_to_public_key
26 - xpub_verify
27 - xprv_sign
28 - xprv_to_xpub
29 - xprv_to_child_xprv
30 - xpub_to_child_xpub
31 - create_P2WPKH_program
32 - create_address
33 - get_path_from_index
34 - submit_transaction
35 - create_qrcode_base64
36 - create_new_key
37 - create_new_address
38 - decode_raw_transaction
39 - get_gm_root_xprv
40 - get_gm_xpub
41 - get_gm_xprv
42 - get_gm_public_key
43 - get_gm_child_xprv
44 - get_gm_child_xpub
45 - gm_xpub_verify
46 - gm_xprv_sign
47 - get_gm_P2WPKH_program
48 - get_gm_address
49 - get_gm_new_key
50 - get_gm_new_address
51 - decode_raw_tx
52 - get_testnet_coins
53 - get_gm_testnet_coins
54
55 ## 2 Usage
56
57 ### 2.1 Key
58
59 Link: <https://blockmeta.com/tools/key>
60
61 ![](./images/key.png)
62
63 ### 2.2 Address
64
65 Link: <https://blockmeta.com/tools/address>
66
67 ![](./images/address.png)
68
69 ### 2.3 Sign
70
71 Link: <https://blockmeta.com/tools/sign>
72
73 ![](./images/sign.png)
74
75 ### 2.4 Verify
76
77 Link: <https://blockmeta.com/tools/verify>
78
79 ![](./images/verify.png)
80
81 ### 2.5 Submit Transaction
82
83 Link: <https://blockmeta.com/tools/txs>
84
85 ![](./images/submit-tx.png)
86
87 ### 2.6 Decode Raw Transaction
88
89 Link: <https://blockmeta.com/tools/decode>
90
91 ![](./images/decode-raw-tx.png)
92
93 ### 2.7 Testnet Faucet
94
95 Link: <https://blockmeta.com/tools/faucet>
96
97 ![](./images/testnet-faucet.png)