README.md

   1 pybtm
   2 ======
   3
   4 - [1 Installation](#1-installation)
   5 - [2 Usage](#2-usage)
   6   - [2.1 Create entropy](#21-create-entropy)
   7   - [2.2 Create mnemonics](#22-create-mnemonics)
   8   - [2.3 Create seed](#23-create-seed)
   9   - [2.4 Create root expanded private key](#24-create-root-expanded-private-key)
  10   - [2.5 Create expanded public key](#25-create-expanded-public-key)
  11   - [2.6 Create expanded private key](#26-create-expanded-private-key)
  12   - [2.7 Create public key](#27-create-public-key)
  13   - [2.8 Create child expanded private key](#28-create-child-expanded-private-key)
  14   - [2.9 Create child expanded public key](#29-create-child-expanded-public-key)
  15   - [Sign message](#sign-message)
  16   - [Verify signature](#verify-signature)
  17   - [Create new key](#create-new-key)
  18
  19 Python3 implementation of the Bytom protocol.
  20
  21 ## 1 Installation
  22
  23 ```
  24 $ pip install pybtm
  25 ```
  26
  27 ## 2 Usage
  28
  29 ### 2.1 Create entropy
  30
  31 get_entropy() create 128 bits entropy.
  32
  33 ```python
  34 >>> from pybtm import key
  35 >>> key.get_entropy()
  36 '100e2704b431f914e3262926bdba6fce'
  37 ```
  38
  39 ### 2.2 Create mnemonics
  40
  41 get_mnemonic create 12 new mnemonics.
  42
  43 ```python
  44 >>> key.get_mnemonic('089fe9bf0cac76760bc4b131d938669e')
  45 'ancient young hurt bone shuffle deposit congress normal crack six boost despair'
  46 ```
  47
  48 If no paramater is specified, it will return 12 new random mnemonics.
  49
  50 ```python
  51 >>> from pybtm import key
  52 >>> key.get_mnemonic()
  53 'nothing gate perfect glide wink lizard journey negative load quote wrong reason'
  54 ```
  55
  56 ### 2.3 Create seed
  57
  58 get_seed create 512 bits seed from 12 mnemonics.
  59
  60 ```python
  61 >>> from pybtm import key
  62 >>> key.get_seed('ancient young hurt bone shuffle deposit congress normal crack six boost despair')
  63 'afa3a86bbec2f40bb32833fc6324593824c4fc7821ed32eac1f762b5893e56745f66a6c6f2588b3d627680aa4e0e50efd25065097b3daa8c6a19d606838fe7d4'
  64 ```
  65
  66 ### 2.4 Create root expanded private key
  67
  68 get_root_xprv create root expanded private key.
  69
  70 ```python
  71 >>> from pybtm import key
  72 >>> key.get_root_xprv('afa3a86bbec2f40bb32833fc6324593824c4fc7821ed32eac1f762b5893e56745f66a6c6f2588b3d627680aa4e0e50efd25065097b3daa8c6a19d606838fe7d4')
  73 '302a25c7c0a68a83fa043f594a2db8b44bc871fced553a8a33144b31bc7fb84887c9e75915bb6ba3fd0b9f94a60b7a5897ab9db6a48f888c2559132dba9152b0'
  74 ```
  75
  76 ### 2.5 Create expanded public key
  77
  78 get_xpub create expanded public key.
  79
  80 Parameter:
  81
  82 - xprv_hexstr: 512 bits expanded private key, type is hex string.
  83
  84 Return:
  85
  86 - xpub_hexstr: 512 bits expanded public key, type is hex string.
  87
  88 ```python
  89 >>> from pybtm import key
  90 >>> xprv_hexstr = 'c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c'
  91 >>> key.get_xpub(xprv_hexstr)
  92 '1b0541a7664cee929edb54d9ef21996b90546918a920a77e1cd6015d97c56563d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c'
  93 ```
  94
  95 ### 2.6 Create expanded private key
  96
  97 get_expanded_private_key create expanded private key.
  98
  99 Parameter:
 100
 101 - xprv_hexstr: 512 bits expanded private key, type is hex string.
 102
 103 Return:
 104
 105 - expanded_private_key_hexstr: 512 bits expanded private key, type is hex string.
 106
 107 ```python
 108 >>> from pybtm import key
 109 >>> xprv_hexstr = '406c82307bf7978d17f3ecfeea7705370e9faef2027affa86c8027c6e11a8a50e231e65bd97048850ae6c39d0f46b63ae70aa24f5aac7877727c430c2201e6d6'
 110 >>> key.get_expanded_private_key(xprv_hexstr)
 111 '406c82307bf7978d17f3ecfeea7705370e9faef2027affa86c8027c6e11a8a50d828bf44b1a109c2bbb4c72685858e2f2ab8b405beef1e4ecc12d1ed8511e8eb'
 112 ```
 113
 114 ### 2.7 Create public key
 115
 116 get_public_key create 32 bytes public key.
 117
 118 Parameter:
 119
 120 - xpub_hexstr: 512 bits expanded public key, type is hex string.
 121
 122 Return:
 123
 124 - public_key_hexstr: 256 bits public key, type is hex string.
 125
 126 ```python
 127 >>> from pybtm import key
 128 >>> xpub_hexstr = 'ecc2bbb6c0492873cdbc81edf56bd896d3b644047879840e357be735b7fa7b6f4af1be7b8d71cc649ac4ca3816f9ccaf11bf49f4effb845f3c19e16eaf8bfcda'
 129 >>> key.get_public_key(xpub_hexstr)
 130 'ecc2bbb6c0492873cdbc81edf56bd896d3b644047879840e357be735b7fa7b6f'
 131 ```
 132
 133 ### 2.8 Create child expanded private key
 134
 135 get_child_xprv create child private key.
 136
 137 Parameter:
 138
 139 - xprv_hexstr: 512 bits expanded private key, type is hex string.
 140 - path_list: 010203 7906a1
 141
 142 Return:
 143
 144 - child_xprv_hexstr: 512 bits private key, type is hex string.
 145
 146 ```python
 147 >>> from pybtm import key
 148 >>> xprv_hexstr = 'c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c'
 149 >>> path_list = ['010203', '7906a1']
 150 >>> key.get_child_xprv(xprv_hexstr, path_list)
 151 '4853a0b00bdcb139e85855d9594e5f641b65218db7c50426946511397e094759bd9de7f2dcad9d7d45389bc94baecaec88aabf58f6e1d832b1f9995a93ec37ea'
 152 ```
 153
 154 ### 2.9 Create child expanded public key
 155
 156 get_child_xpub create child public key.
 157
 158 Parameter:
 159
 160 - xpub_hexstr: 512 bits expanded public key, type is hex string.
 161 - path_list: 010203 7906a1
 162
 163 Return:
 164
 165 - child_xpub_hexstr: 512 bits public key, type is hex string.
 166
 167 ```python
 168 >>> from pybtm import key
 169 >>> xpub_hexstr = '1b0541a7664cee929edb54d9ef21996b90546918a920a77e1cd6015d97c56563d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c'
 170 >>> path_list = ['010203', '7906a1']
 171 >>> key.get_child_xpub(xpub_hexstr, path_list)
 172 'e65c1a9714e2116c6e5d57dee188a53b98dc901a21def5a5ca46fcf78303f4f2bd9de7f2dcad9d7d45389bc94baecaec88aabf58f6e1d832b1f9995a93ec37ea'
 173 ```
 174
 175 ### Sign message
 176
 177 xprv_sign sign message.
 178
 179 Parameter:
 180
 181 - xprv_hexstr: 512 bits expanded private key, type is hex string.
 182 - message_hexstr: message, type is hex string.
 183
 184 Return:
 185
 186 - signature_hexstr: 512 bits signature, type is hex string.
 187
 188 ```python
 189 >>> from pybtm import key
 190 >>> xprv_hexstr = '88c0c40fb54ef9c1b90af8cce8dc4c9d54f915074dde93f79ab61cedae03444101ff37ac4a07869214c2735bba0175e001abe608db18538e083e1e44430a273b'
 191 >>> message_hexstr = '1246b84985e1ab5f83f4ec2bdf271114666fd3d9e24d12981a3c861b9ed523c6'
 192 >>> key.xprv_sign(xprv_hexstr, message_hexstr)
 193 'ab18f49b23d03295bc2a3f2a7d5bb53a2997bed733e1fc408b50ec834ae7e43f7da40fe5d9d50f6ef2d188e1d27f976aa2586cef1ba00dd098b5c9effa046306'
 194 ```
 195
 196 ### Verify signature
 197
 198 xpub_verify verify signature.
 199
 200 Parameter:
 201
 202 - xpub_hexstr: 512 bits expanded public key, type is hex string.
 203 - message_hexstr: message, type is hex string.
 204 - signature_hexstr: 512 bits signature, type is hex string.
 205
 206 Return:
 207
 208 - result: True or False.
 209
 210 ```python
 211 >>> from pybtm import key
 212 >>> xpub_hexstr = 'cb22ce197d342d6bb440b0bf13ddd674f367275d28a00f893d7f0b10817690fd01ff37ac4a07869214c2735bba0175e001abe608db18538e083e1e44430a273b'
 213 >>> message_hexstr = '1246b84985e1ab5f83f4ec2bdf271114666fd3d9e24d12981a3c861b9ed523c6'
 214 >>> signature_hexstr = 'ab18f49b23d03295bc2a3f2a7d5bb53a2997bed733e1fc408b50ec834ae7e43f7da40fe5d9d50f6ef2d188e1d27f976aa2586cef1ba00dd098b5c9effa046306'
 215 >>> key.xpub_verify(xpub_hexstr, message_hexstr, signature_hexstr)
 216 True
 217 ```
 218
 219 ### Create new key
 220
 221 get_new_key create new key.
 222
 223 Parameter:
 224
 225 - entropy_hexstr(optional): 128 bits entropy, type is hex string.
 226 - mnemonic_str(optional): 12 mnemonics.
 227
 228 Return:
 229
 230 - entropy: 128 bits entropy.
 231 - mnemonic: 12 mnemonics.
 232 - seed: 512 bits seed.
 233 - xprv: 512 bits expaneded private key.
 234 - xpub: 512 bits expaneded public key.
 235 - xprv_base64: xprv hex string qrcode base64.
 236
 237 ```python
 238 >>> from pybtm import key
 239 >>> r = key.get_new_key()
 240 >>> r['entropy']
 241 '8466b1128f92051361c9aa2de52d1bb0'
 242 >>> r['mnemonic']
 243 'love culture dwarf busy cake meadow mango crystal combine city eight genuine'
 244 >>> r['seed']
 245 '4d15bf0f72bad754987fdcd0628ea37af03ac24666019c6d362e0200c9b49bee35aa0a788ed09e3a86cd529df0a1c20ea6aa719cf1e0da4ffb15efbc38fba498'
 246 >>> r['xprv']
 247 'f09ad64c2714b45e23c75e4541ad771def99b97e6da16b0cc6bcdac045f4d34745b62093173fd8f9a67e1da4b81233bc947880b6ed4b9641cf8f5223212fa18d'
 248 >>> r['xpub']
 249 'ebcc4b14444adb207dd53fd89b2881b21e839de42a1b6687a5a9d83b82c1b5b645b62093173fd8f9a67e1da4b81233bc947880b6ed4b9641cf8f5223212fa18d'
 250 >>> r['xprv_base64']
 251 {'base64': '/9j/4AAQSkZJRgABAQAAAQABAAD...'}
 252 ```
 253
 254