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   - [2.10 Sign message](#210-sign-message)
  16   - [2.11 Verify signature](#211-verify-signature)
  17   - [2.12 Create new key](#212-create-new-key)
  18   - [2.13 Create HD path](#213-create-hd-path)
  19   - [2.14 Create control program](#214-create-control-program)
  20   - [Create address](#create-address)
  21
  22 Python3 implementation of the Bytom protocol.
  23
  24 ## 1 Installation
  25
  26 ```
  27 $ pip install pybtm
  28 ```
  29
  30 Requires:
  31
  32 - Python>=3.7
  33
  34 ## 2 Usage
  35
  36 ### 2.1 Create entropy
  37
  38 get_entropy() create 128 bits entropy.
  39
  40 Return:
  41
  42 - entropy_hexstr: 128 bits entropy.
  43
  44 ```python
  45 >>> from pybtm import key
  46 >>> key.get_entropy()
  47 '100e2704b431f914e3262926bdba6fce'
  48 ```
  49
  50 ### 2.2 Create mnemonics
  51
  52 get_mnemonic create 12 new mnemonics.
  53
  54 Parameter:
  55
  56 - entropy_hexstr(optional): 128 bits entropy, type is hex string.
  57
  58 Return:
  59
  60 - mnemonic_str: 12 mnemonics.
  61
  62 ```python
  63 >>> key.get_mnemonic('089fe9bf0cac76760bc4b131d938669e')
  64 'ancient young hurt bone shuffle deposit congress normal crack six boost despair'
  65 ```
  66
  67 If no paramater is specified, it will return 12 new random mnemonics.
  68
  69 ```python
  70 >>> from pybtm import key
  71 >>> key.get_mnemonic()
  72 'nothing gate perfect glide wink lizard journey negative load quote wrong reason'
  73 ```
  74
  75 ### 2.3 Create seed
  76
  77 get_seed create 512 bits seed from 12 mnemonics.
  78
  79 Parameter:
  80
  81 - mnemonic_str: 12 mnemonics.
  82
  83 Return:
  84
  85 - seed_hexstr: 512 bits seed, type is hex string.
  86
  87 ```python
  88 >>> from pybtm import key
  89 >>> key.get_seed('ancient young hurt bone shuffle deposit congress normal crack six boost despair')
  90 'afa3a86bbec2f40bb32833fc6324593824c4fc7821ed32eac1f762b5893e56745f66a6c6f2588b3d627680aa4e0e50efd25065097b3daa8c6a19d606838fe7d4'
  91 ```
  92
  93 ### 2.4 Create root expanded private key
  94
  95 get_root_xprv create root expanded private key.
  96
  97 Parameter:
  98
  99 - seed_hexstr: 512 bits seed, type is hex string.
 100
 101 Return:
 102
 103 - root_xprv_hexstring: 512 bits seed, type is hex string.
 104
 105 ```python
 106 >>> from pybtm import key
 107 >>> key.get_root_xprv('afa3a86bbec2f40bb32833fc6324593824c4fc7821ed32eac1f762b5893e56745f66a6c6f2588b3d627680aa4e0e50efd25065097b3daa8c6a19d606838fe7d4')
 108 '302a25c7c0a68a83fa043f594a2db8b44bc871fced553a8a33144b31bc7fb84887c9e75915bb6ba3fd0b9f94a60b7a5897ab9db6a48f888c2559132dba9152b0'
 109 ```
 110
 111 ### 2.5 Create expanded public key
 112
 113 get_xpub create expanded public key.
 114
 115 Parameter:
 116
 117 - xprv_hexstr: 512 bits expanded private key, type is hex string.
 118
 119 Return:
 120
 121 - xpub_hexstr: 512 bits expanded public key, type is hex string.
 122
 123 ```python
 124 >>> from pybtm import key
 125 >>> xprv_hexstr = 'c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c'
 126 >>> key.get_xpub(xprv_hexstr)
 127 '1b0541a7664cee929edb54d9ef21996b90546918a920a77e1cd6015d97c56563d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c'
 128 ```
 129
 130 ### 2.6 Create expanded private key
 131
 132 get_expanded_private_key create expanded private key.
 133
 134 Parameter:
 135
 136 - xprv_hexstr: 512 bits expanded private key, type is hex string.
 137
 138 Return:
 139
 140 - expanded_private_key_hexstr: 512 bits expanded private key, type is hex string.
 141
 142 ```python
 143 >>> from pybtm import key
 144 >>> xprv_hexstr = '406c82307bf7978d17f3ecfeea7705370e9faef2027affa86c8027c6e11a8a50e231e65bd97048850ae6c39d0f46b63ae70aa24f5aac7877727c430c2201e6d6'
 145 >>> key.get_expanded_private_key(xprv_hexstr)
 146 '406c82307bf7978d17f3ecfeea7705370e9faef2027affa86c8027c6e11a8a50d828bf44b1a109c2bbb4c72685858e2f2ab8b405beef1e4ecc12d1ed8511e8eb'
 147 ```
 148
 149 ### 2.7 Create public key
 150
 151 get_public_key create 32 bytes public key.
 152
 153 Parameter:
 154
 155 - xpub_hexstr: 512 bits expanded public key, type is hex string.
 156
 157 Return:
 158
 159 - public_key_hexstr: 256 bits public key, type is hex string.
 160
 161 ```python
 162 >>> from pybtm import key
 163 >>> xpub_hexstr = 'ecc2bbb6c0492873cdbc81edf56bd896d3b644047879840e357be735b7fa7b6f4af1be7b8d71cc649ac4ca3816f9ccaf11bf49f4effb845f3c19e16eaf8bfcda'
 164 >>> key.get_public_key(xpub_hexstr)
 165 'ecc2bbb6c0492873cdbc81edf56bd896d3b644047879840e357be735b7fa7b6f'
 166 ```
 167
 168 ### 2.8 Create child expanded private key
 169
 170 get_child_xprv create child private key.
 171
 172 Parameter:
 173
 174 - xprv_hexstr: 512 bits expanded private key, type is hex string.
 175 - path_list: 010203 7906a1
 176
 177 Return:
 178
 179 - child_xprv_hexstr: 512 bits private key, type is hex string.
 180
 181 ```python
 182 >>> from pybtm import key
 183 >>> xprv_hexstr = 'c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c'
 184 >>> path_list = ['010203', '7906a1']
 185 >>> key.get_child_xprv(xprv_hexstr, path_list)
 186 '4853a0b00bdcb139e85855d9594e5f641b65218db7c50426946511397e094759bd9de7f2dcad9d7d45389bc94baecaec88aabf58f6e1d832b1f9995a93ec37ea'
 187 ```
 188
 189 ### 2.9 Create child expanded public key
 190
 191 get_child_xpub create child public key.
 192
 193 Parameter:
 194
 195 - xpub_hexstr: 512 bits expanded public key, type is hex string.
 196 - path_list: 010203 7906a1
 197
 198 Return:
 199
 200 - child_xpub_hexstr: 512 bits public key, type is hex string.
 201
 202 ```python
 203 >>> from pybtm import key
 204 >>> xpub_hexstr = '1b0541a7664cee929edb54d9ef21996b90546918a920a77e1cd6015d97c56563d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c'
 205 >>> path_list = ['010203', '7906a1']
 206 >>> key.get_child_xpub(xpub_hexstr, path_list)
 207 'e65c1a9714e2116c6e5d57dee188a53b98dc901a21def5a5ca46fcf78303f4f2bd9de7f2dcad9d7d45389bc94baecaec88aabf58f6e1d832b1f9995a93ec37ea'
 208 ```
 209
 210 ### 2.10 Sign message
 211
 212 xprv_sign sign message.
 213
 214 Parameter:
 215
 216 - xprv_hexstr: 512 bits expanded private key, type is hex string.
 217 - message_hexstr: message, type is hex string.
 218
 219 Return:
 220
 221 - signature_hexstr: 512 bits signature, type is hex string.
 222
 223 ```python
 224 >>> from pybtm import key
 225 >>> xprv_hexstr = '88c0c40fb54ef9c1b90af8cce8dc4c9d54f915074dde93f79ab61cedae03444101ff37ac4a07869214c2735bba0175e001abe608db18538e083e1e44430a273b'
 226 >>> message_hexstr = '1246b84985e1ab5f83f4ec2bdf271114666fd3d9e24d12981a3c861b9ed523c6'
 227 >>> key.xprv_sign(xprv_hexstr, message_hexstr)
 228 'ab18f49b23d03295bc2a3f2a7d5bb53a2997bed733e1fc408b50ec834ae7e43f7da40fe5d9d50f6ef2d188e1d27f976aa2586cef1ba00dd098b5c9effa046306'
 229 ```
 230
 231 ### 2.11 Verify signature
 232
 233 xpub_verify verify signature.
 234
 235 Parameter:
 236
 237 - xpub_hexstr: 512 bits expanded public key, type is hex string.
 238 - message_hexstr: message, type is hex string.
 239 - signature_hexstr: 512 bits signature, type is hex string.
 240
 241 Return:
 242
 243 - result: True or False.
 244
 245 ```python
 246 >>> from pybtm import key
 247 >>> xpub_hexstr = 'cb22ce197d342d6bb440b0bf13ddd674f367275d28a00f893d7f0b10817690fd01ff37ac4a07869214c2735bba0175e001abe608db18538e083e1e44430a273b'
 248 >>> message_hexstr = '1246b84985e1ab5f83f4ec2bdf271114666fd3d9e24d12981a3c861b9ed523c6'
 249 >>> signature_hexstr = 'ab18f49b23d03295bc2a3f2a7d5bb53a2997bed733e1fc408b50ec834ae7e43f7da40fe5d9d50f6ef2d188e1d27f976aa2586cef1ba00dd098b5c9effa046306'
 250 >>> key.xpub_verify(xpub_hexstr, message_hexstr, signature_hexstr)
 251 True
 252 ```
 253
 254 ### 2.12 Create new key
 255
 256 get_new_key create new key.
 257
 258 Parameter:
 259
 260 - entropy_hexstr(optional): 128 bits entropy, type is hex string.
 261 - mnemonic_str(optional): 12 mnemonics.
 262
 263 Return:
 264
 265 - entropy: 128 bits entropy.
 266 - mnemonic: 12 mnemonics.
 267 - seed: 512 bits seed.
 268 - xprv: 512 bits expaneded private key.
 269 - xpub: 512 bits expaneded public key.
 270 - xprv_base64: xprv hex string qrcode base64.
 271
 272 ```python
 273 >>> from pybtm import key
 274 >>> r = key.get_new_key()
 275 >>> r['entropy']
 276 '8466b1128f92051361c9aa2de52d1bb0'
 277 >>> r['mnemonic']
 278 'love culture dwarf busy cake meadow mango crystal combine city eight genuine'
 279 >>> r['seed']
 280 '4d15bf0f72bad754987fdcd0628ea37af03ac24666019c6d362e0200c9b49bee35aa0a788ed09e3a86cd529df0a1c20ea6aa719cf1e0da4ffb15efbc38fba498'
 281 >>> r['xprv']
 282 'f09ad64c2714b45e23c75e4541ad771def99b97e6da16b0cc6bcdac045f4d34745b62093173fd8f9a67e1da4b81233bc947880b6ed4b9641cf8f5223212fa18d'
 283 >>> r['xpub']
 284 'ebcc4b14444adb207dd53fd89b2881b21e839de42a1b6687a5a9d83b82c1b5b645b62093173fd8f9a67e1da4b81233bc947880b6ed4b9641cf8f5223212fa18d'
 285 >>> r['xprv_base64']
 286 {'base64': '/9j/4AAQSkZJRgABAQAAAQABAAD...'}
 287 ```
 288
 289 ```python
 290 >>> from pybtm import key
 291 >>> r = key.get_new_key(entropy_hexstr='4d33735a9e92f634d22aecbb4044038d')
 292 >>> r['entropy']
 293 '4d33735a9e92f634d22aecbb4044038d'
 294 >>> r['mnemonic']
 295 'essay oppose stove diamond control bounce emerge frown robust acquire abstract brick'
 296 ```
 297
 298 ```python
 299 >>> from pybtm import key
 300 >>> r = key.get_new_key(mnemonic_str='ancient young hurt bone shuffle deposit congress normal crack six boost despair')
 301 >>> r['entropy']
 302 ''
 303 >>> r['mnemonic']
 304 'ancient young hurt bone shuffle deposit congress normal crack six boost despair'
 305 >>> r['seed']
 306 'afa3a86bbec2f40bb32833fc6324593824c4fc7821ed32eac1f762b5893e56745f66a6c6f2588b3d627680aa4e0e50efd25065097b3daa8c6a19d606838fe7d4'
 307 ```
 308
 309 ### 2.13 Create HD path
 310
 311 get_path_from_index create HD path.
 312
 313 Parameter:
 314
 315 - account_index_int: 1, 2, 3, ..., type is hex string.
 316 - address_index_int: 1, 2, 3, ..., type is hex string.
 317 - change_bool: If receiver is change, change_bool is True, otherwise the change_bool is False.
 318
 319 Return:
 320
 321 - path_list: path list.
 322 - path_str: path string.
 323
 324 ```python
 325 >>> from pybtm import receiver
 326 >>> account_index_int = 1
 327 >>> address_index_int = 1
 328 >>> change_bool = True
 329 >>> receiver.get_path_from_index(account_index_int, address_index_int, change_bool)
 330 {'path': ['2c000000', '99000000', '01000000', '01000000', '01000000'], 'path_str': 'm/44/153/1/1/1'}
 331 ```
 332
 333 ### 2.14 Create control program
 334
 335 get_control_program create control program.
 336
 337 Parameter:
 338
 339 - account_index_int: account index, e.g. 1, 2, 3...
 340 - address_index_int: address index, e.g. 1, 2, 3...
 341 - change_bool: If receiver is change, change_bool is True, otherwise the change_bool is False.
 342 - xpub_hexstr: 512 bits expanded public key, type is hex string.
 343
 344 Return:
 345
 346 - control_program_hexstr: type is hex string.
 347
 348 ```python
 349 >>> from pybtm import receiver
 350 >>> account_index_int = 1
 351 >>> address_index_int = 1
 352 >>> change_bool = False
 353 >>> xpub_hexstr = '3c6664244d2d57168d173c4691dbf8741a67d972b2d3e1b0067eb825e2005d20c5eebd1c26ccad4de5142d7c339bf62cc1fb79a8b3e42a708cd521368dbc9286'
 354 >>> receiver.get_control_program(account_index_int, address_index_int, change_bool, xpub_hexstr)
 355 '0014052620b86a6d5e07311d5019dffa3864ccc8a6bd'
 356 ```
 357
 358 ### Create address
 359
 360 get_address create address from control program.
 361
 362 Parameter:
 363
 364 - control_program_hexstr: control program.
 365 - network_str: 3 types of network is available: mainnet, testnet and solonet.
 366
 367 Return:
 368
 369 - address: bytom address.
 370
 371 ```python
 372
 373 ```