docs/module-TransactionsApi.html

   1 <!DOCTYPE html>
   2
   3 <html lang="en">
   4 <head>
   5         <meta charset="utf-8">
   6         <meta name="viewport" content="width=device-width">
   7         <title>Bytom Node.js SDK Module: TransactionsApi</title>
   8
   9         <!--[if lt IE 9]>
  10         <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  11         <![endif]-->
  12         <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
  13
  14         <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
  15
  16 </head>
  17
  18 <body>
  19
  20 <div class="navbar navbar-default navbar-fixed-top ">
  21 <div class="container">
  22         <div class="navbar-header">
  23                 <a class="navbar-brand" href="index.html">Bytom Node.js SDK</a>
  24                 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  25                         <span class="icon-bar"></span>
  26                         <span class="icon-bar"></span>
  27                         <span class="icon-bar"></span>
  28         </button>
  29         </div>
  30         <div class="navbar-collapse collapse" id="topNavigation">
  31                 <ul class="nav navbar-nav">
  32
  33                         <li class="dropdown">
  34                                 <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
  35                                 <ul class="dropdown-menu ">
  36                                         <li><a href="module-AccessTokensApi.html">AccessTokensApi</a></li><li><a href="module-AccountsApi.html">AccountsApi</a></li><li><a href="module-AssetsApi.html">AssetsApi</a></li><li><a href="module-BalancesApi.html">BalancesApi</a></li><li><a href="module-BlockAPI.html">BlockAPI</a></li><li><a href="module-ConfigApi.html">ConfigApi</a></li><li><a href="module-KeysApi.html">KeysApi</a></li><li><a href="module-TransactionsApi.html">TransactionsApi</a></li><li><a href="module-UnspentOutputsApi.html">UnspentOutputsApi</a></li>
  37                                 </ul>
  38                         </li>
  39
  40                         <li class="dropdown">
  41                                 <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  42                                 <ul class="dropdown-menu ">
  43                                         <li><a href="TransactionBuilder.html">TransactionBuilder</a></li>
  44                                 </ul>
  45                         </li>
  46
  47                         <li class="dropdown">
  48                                 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
  49                                 <ul class="dropdown-menu ">
  50                                         <li><a href="global.html">Global</a></li>
  51                                 </ul>
  52                         </li>
  53
  54                 </ul>
  55
  56             <div class="col-sm-3 col-md-3">
  57                 <form class="navbar-form" role="search">
  58                     <div class="input-group">
  59                         <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
  60                         <div class="input-group-btn">
  61                             <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
  62                         </div>
  63                     </div>
  64                 </form>
  65             </div>
  66
  67         </div>
  68
  69 </div>
  70 </div>
  71
  72
  73 <div class="container" id="toc-content">
  74 <div class="row">
  75
  76
  77         <div class="col-md-8">
  78
  79                 <div id="main">
  80
  81
  82         <h1 class="page-title">Module: TransactionsApi</h1>
  83 <section>
  84
  85 <header>
  86
  87 </header>
  88
  89
  90 <article>
  91     <div class="container-overview">
  92
  93
  94             <div class="description"><p>API for interacting with <a href="global.html#Transaction">transactions</a>.</p></div>
  95
  96
  97
  98 <dl class="details">
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134 </dl>
 135
 136
 137
 138
 139     </div>
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154         <h3 class="subsection-title">Methods</h3>
 155
 156         <dl>
 157
 158 <hr>
 159 <dt>
 160     <h4 class="name" id="~build"><span class="type-signature">&lt;inner> </span>build(builderBlock)</h4>
 161
 162
 163 </dt>
 164 <dd>
 165
 166
 167     <div class="description">
 168         <p>Build an unsigned transaction from a set of actions.</p>
 169     </div>
 170
 171
 172
 173
 174
 175
 176
 177
 178         <h5>Parameters:</h5>
 179
 180
 181 <table class="params table table-striped">
 182     <thead>
 183     <tr>
 184
 185         <th>Name</th>
 186
 187
 188         <th>Type</th>
 189
 190
 191
 192
 193
 194         <th class="last">Description</th>
 195     </tr>
 196     </thead>
 197
 198     <tbody>
 199
 200
 201         <tr>
 202
 203                 <td class="name"><code>builderBlock</code></td>
 204
 205
 206             <td class="type">
 207
 208
 209 <span class="param-type"><a href="module-TransactionsApi.html#~builderCallback">module:TransactionsApi~builderCallback</a></span>
 210
 211
 212
 213
 214             </td>
 215
 216
 217
 218
 219
 220             <td class="description last"><p>Function that adds desired actions
 221                                         to a given builder object.</p></td>
 222         </tr>
 223
 224
 225     </tbody>
 226 </table>
 227
 228
 229
 230
 231 <dl class="details">
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267 </dl>
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281     <h5>Returns:</h5>
 282
 283
 284 <div class="param-desc">
 285     <p>Unsigned transaction template, or error.</p>
 286 </div>
 287
 288
 289
 290 <dl>
 291     <dt>
 292         Type
 293     </dt>
 294     <dd>
 295
 296 <span class="param-type">Promise.&lt;Object></span>
 297
 298
 299
 300     </dd>
 301 </dl>
 302
 303
 304
 305
 306
 307 </dd>
 308
 309
 310
 311 <hr>
 312 <dt>
 313     <h4 class="name" id="~estimateGas"><span class="type-signature">&lt;inner> </span>estimateGas(transaction)</h4>
 314
 315
 316 </dt>
 317 <dd>
 318
 319
 320     <div class="description">
 321         <p>Estimate how much gas one trasaction may use.</p>
 322     </div>
 323
 324
 325
 326
 327
 328
 329
 330
 331         <h5>Parameters:</h5>
 332
 333
 334 <table class="params table table-striped">
 335     <thead>
 336     <tr>
 337
 338         <th>Name</th>
 339
 340
 341         <th>Type</th>
 342
 343
 344
 345
 346
 347         <th class="last">Description</th>
 348     </tr>
 349     </thead>
 350
 351     <tbody>
 352
 353
 354         <tr>
 355
 356                 <td class="name"><code>transaction</code></td>
 357
 358
 359             <td class="type">
 360
 361
 362 <span class="param-type">Object</span>
 363
 364
 365
 366
 367             </td>
 368
 369
 370
 371
 372
 373             <td class="description last"><p>The transaction template to estimate.</p></td>
 374         </tr>
 375
 376
 377     </tbody>
 378 </table>
 379
 380
 381
 382
 383 <dl class="details">
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419 </dl>
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433     <h5>Returns:</h5>
 434
 435
 436 <div class="param-desc">
 437     <p>Estimation result.</p>
 438 </div>
 439
 440
 441
 442 <dl>
 443     <dt>
 444         Type
 445     </dt>
 446     <dd>
 447
 448 <span class="param-type">Object</span>
 449
 450
 451
 452     </dd>
 453 </dl>
 454
 455
 456
 457
 458
 459 </dd>
 460
 461
 462
 463 <hr>
 464 <dt>
 465     <h4 class="name" id="~list"><span class="type-signature">&lt;inner> </span>list(params)</h4>
 466
 467
 468 </dt>
 469 <dd>
 470
 471
 472     <div class="description">
 473         <p>List local transactions by id or filter condition.</p>
 474     </div>
 475
 476
 477
 478
 479
 480
 481
 482
 483         <h5>Parameters:</h5>
 484
 485
 486 <table class="params table table-striped">
 487     <thead>
 488     <tr>
 489
 490         <th>Name</th>
 491
 492
 493         <th>Type</th>
 494
 495
 496
 497
 498
 499         <th class="last">Description</th>
 500     </tr>
 501     </thead>
 502
 503     <tbody>
 504
 505
 506         <tr>
 507
 508                 <td class="name"><code>params</code></td>
 509
 510
 511             <td class="type">
 512
 513
 514 <span class="param-type">Object</span>
 515
 516
 517
 518
 519             </td>
 520
 521
 522
 523
 524
 525             <td class="description last"><p>Transaction filter params.</p>
 526                 <h6 class="method-params-label method-subparams-label">Properties</h6>
 527
 528
 529 <table class="params table table-striped">
 530     <thead>
 531     <tr>
 532
 533         <th>Name</th>
 534
 535
 536         <th>Type</th>
 537
 538
 539
 540
 541
 542         <th class="last">Description</th>
 543     </tr>
 544     </thead>
 545
 546     <tbody>
 547
 548
 549         <tr>
 550
 551                 <td class="name"><code>id</code></td>
 552
 553
 554             <td class="type">
 555
 556
 557 <span class="param-type">String</span>
 558
 559
 560
 561
 562             </td>
 563
 564
 565
 566
 567
 568             <td class="description last"><p>transaction id, hash of transaction.</p></td>
 569         </tr>
 570
 571
 572
 573         <tr>
 574
 575                 <td class="name"><code>account_id</code></td>
 576
 577
 578             <td class="type">
 579
 580
 581 <span class="param-type">String</span>
 582
 583
 584
 585
 586             </td>
 587
 588
 589
 590
 591
 592             <td class="description last"><p>id of account.</p></td>
 593         </tr>
 594
 595
 596
 597         <tr>
 598
 599                 <td class="name"><code>detail</code></td>
 600
 601
 602             <td class="type">
 603
 604
 605 <span class="param-type">Boolean</span>
 606
 607
 608
 609
 610             </td>
 611
 612
 613
 614
 615
 616             <td class="description last"><p>flag of detail transactions, default false (only return transaction summary).</p></td>
 617         </tr>
 618
 619
 620
 621         <tr>
 622
 623                 <td class="name"><code>unconfirmed</code></td>
 624
 625
 626             <td class="type">
 627
 628
 629 <span class="param-type">Boolean</span>
 630
 631
 632
 633
 634             </td>
 635
 636
 637
 638
 639
 640             <td class="description last"><p>flag of unconfirmed transactions(query result include all confirmed
 641                  and unconfirmed transactions), default false.</p></td>
 642         </tr>
 643
 644
 645
 646         <tr>
 647
 648                 <td class="name"><code>from</code></td>
 649
 650
 651             <td class="type">
 652
 653
 654 <span class="param-type">Integer</span>
 655
 656
 657
 658
 659             </td>
 660
 661
 662
 663
 664
 665             <td class="description last"><p>The start position of first transaction.</p></td>
 666         </tr>
 667
 668
 669
 670         <tr>
 671
 672                 <td class="name"><code>count</code></td>
 673
 674
 675             <td class="type">
 676
 677
 678 <span class="param-type">Integer</span>
 679
 680
 681
 682
 683             </td>
 684
 685
 686
 687
 688
 689             <td class="description last"><p>The number of returned.</p></td>
 690         </tr>
 691
 692
 693     </tbody>
 694 </table>
 695
 696             </td>
 697         </tr>
 698
 699
 700     </tbody>
 701 </table>
 702
 703
 704
 705
 706 <dl class="details">
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742 </dl>
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756     <h5>Returns:</h5>
 757
 758
 759 <div class="param-desc">
 760     <p>The result transactions.</p>
 761 </div>
 762
 763
 764
 765 <dl>
 766     <dt>
 767         Type
 768     </dt>
 769     <dd>
 770
 771 <span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#Transaction">Transaction</a>>></span>
 772
 773
 774
 775     </dd>
 776 </dl>
 777
 778
 779
 780
 781
 782 </dd>
 783
 784
 785
 786 <hr>
 787 <dt>
 788     <h4 class="name" id="~listAll"><span class="type-signature">&lt;inner> </span>listAll()</h4>
 789
 790
 791 </dt>
 792 <dd>
 793
 794
 795     <div class="description">
 796         <p>List all local transactions.</p>
 797     </div>
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808 <dl class="details">
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844 </dl>
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858     <h5>Returns:</h5>
 859
 860
 861 <div class="param-desc">
 862     <p>All local transactions.</p>
 863 </div>
 864
 865
 866
 867 <dl>
 868     <dt>
 869         Type
 870     </dt>
 871     <dd>
 872
 873 <span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#Transaction">Transaction</a>>></span>
 874
 875
 876
 877     </dd>
 878 </dl>
 879
 880
 881
 882
 883
 884 </dd>
 885
 886
 887
 888 <hr>
 889 <dt>
 890     <h4 class="name" id="~sign"><span class="type-signature">&lt;inner> </span>sign(params)</h4>
 891
 892
 893 </dt>
 894 <dd>
 895
 896
 897     <div class="description">
 898         <p>Sign transaction.</p>
 899     </div>
 900
 901
 902
 903
 904
 905
 906
 907
 908         <h5>Parameters:</h5>
 909
 910
 911 <table class="params table table-striped">
 912     <thead>
 913     <tr>
 914
 915         <th>Name</th>
 916
 917
 918         <th>Type</th>
 919
 920
 921
 922
 923
 924         <th class="last">Description</th>
 925     </tr>
 926     </thead>
 927
 928     <tbody>
 929
 930
 931         <tr>
 932
 933                 <td class="name"><code>params</code></td>
 934
 935
 936             <td class="type">
 937
 938
 939 <span class="param-type">Object</span>
 940
 941
 942
 943
 944             </td>
 945
 946
 947
 948
 949
 950             <td class="description last"><p>The built transaction template.</p>
 951                 <h6 class="method-params-label method-subparams-label">Properties</h6>
 952
 953
 954 <table class="params table table-striped">
 955     <thead>
 956     <tr>
 957
 958         <th>Name</th>
 959
 960
 961         <th>Type</th>
 962
 963
 964
 965
 966
 967         <th class="last">Description</th>
 968     </tr>
 969     </thead>
 970
 971     <tbody>
 972
 973
 974         <tr>
 975
 976                 <td class="name"><code>password</code></td>
 977
 978
 979             <td class="type">
 980
 981
 982 <span class="param-type">String</span>
 983
 984
 985
 986
 987             </td>
 988
 989
 990
 991
 992
 993             <td class="description last"><p>signature of the password.</p></td>
 994         </tr>
 995
 996
 997
 998         <tr>
 999
1000                 <td class="name"><code>transaction</code></td>
1001
1002
1003             <td class="type">
1004
1005
1006 <span class="param-type">Object</span>
1007
1008
1009
1010
1011             </td>
1012
1013
1014
1015
1016
1017             <td class="description last"><p>builded transaction.</p></td>
1018         </tr>
1019
1020
1021     </tbody>
1022 </table>
1023
1024             </td>
1025         </tr>
1026
1027
1028     </tbody>
1029 </table>
1030
1031
1032
1033
1034 <dl class="details">
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070 </dl>
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084     <h5>Returns:</h5>
1085
1086
1087 <div class="param-desc">
1088     <ul>
1089 <li>Sign result.</li>
1090 </ul>
1091 </div>
1092
1093
1094
1095 <dl>
1096     <dt>
1097         Type
1098     </dt>
1099     <dd>
1100
1101 <span class="param-type">Promise.&lt;<a href="module-TransactionsApi.html#~SignResult">module:TransactionsApi~SignResult</a>></span>
1102
1103
1104
1105     </dd>
1106 </dl>
1107
1108
1109
1110
1111
1112 </dd>
1113
1114
1115
1116 <hr>
1117 <dt>
1118     <h4 class="name" id="~submit"><span class="type-signature">&lt;inner> </span>submit(raw_transaction)</h4>
1119
1120
1121 </dt>
1122 <dd>
1123
1124
1125     <div class="description">
1126         <p>Submit a signed transaction to the blockchain.</p>
1127     </div>
1128
1129
1130
1131
1132
1133
1134
1135
1136         <h5>Parameters:</h5>
1137
1138
1139 <table class="params table table-striped">
1140     <thead>
1141     <tr>
1142
1143         <th>Name</th>
1144
1145
1146         <th>Type</th>
1147
1148
1149
1150
1151
1152         <th class="last">Description</th>
1153     </tr>
1154     </thead>
1155
1156     <tbody>
1157
1158
1159         <tr>
1160
1161                 <td class="name"><code>raw_transaction</code></td>
1162
1163
1164             <td class="type">
1165
1166
1167 <span class="param-type">String</span>
1168
1169
1170
1171
1172             </td>
1173
1174
1175
1176
1177
1178             <td class="description last"><p>Encoded fully signed transaction.</p></td>
1179         </tr>
1180
1181
1182     </tbody>
1183 </table>
1184
1185
1186
1187
1188 <dl class="details">
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224 </dl>
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238     <h5>Returns:</h5>
1239
1240
1241 <div class="param-desc">
1242     <p>Submit result. It will return tx_id if submit successfully else error.</p>
1243 </div>
1244
1245
1246
1247 <dl>
1248     <dt>
1249         Type
1250     </dt>
1251     <dd>
1252
1253 <span class="param-type">Promise.&lt;Object></span>
1254
1255
1256
1257     </dd>
1258 </dl>
1259
1260
1261
1262
1263
1264 </dd>
1265
1266         </dl>
1267
1268
1269
1270         <h3 class="subsection-title">Type Definitions</h3>
1271
1272         <dl>
1273
1274 <hr>
1275 <dt class="name" id="~Action">
1276     <h4 id="~Action">Action</h4>
1277
1278
1279 </dt>
1280 <dd>
1281
1282     <div class="description">
1283         <p>Basic unit to build a transaction.
1284 For spend transaction, either account_id or account_alias is required to specify account info.
1285 Asset info(either asset_id or asset_alias ) is required for all kinds of action.</p>
1286     </div>
1287
1288
1289
1290         <h5>Type:</h5>
1291         <ul>
1292             <li>
1293
1294 <span class="param-type">Object</span>
1295
1296
1297
1298             </li>
1299         </ul>
1300
1301
1302
1303 <dl class="details">
1304
1305
1306     <h5 class="subsection-title">Properties:</h5>
1307
1308     <dl>
1309
1310 <table class="props table table-striped">
1311     <thead>
1312     <tr>
1313
1314         <th>Name</th>
1315
1316
1317         <th>Type</th>
1318
1319
1320
1321
1322
1323         <th class="last">Description</th>
1324     </tr>
1325     </thead>
1326
1327     <tbody>
1328
1329
1330         <tr>
1331
1332                 <td class="name"><code>type</code></td>
1333
1334
1335             <td class="type">
1336
1337
1338 <span class="param-type">String</span>
1339
1340
1341
1342
1343             </td>
1344
1345
1346
1347
1348
1349             <td class="description last"><p>Currently 4 types of action is supported:</p>
1350 <ul>
1351 <li>spend_account: action to spend UTXO from account.</li>
1352 <li>issue: action to issue asset.</li>
1353 <li>retire: action to retire asset.</li>
1354 <li>control_address: action to receive asset with address.</li>
1355 </ul></td>
1356         </tr>
1357
1358
1359
1360         <tr>
1361
1362                 <td class="name"><code>account_alias</code></td>
1363
1364
1365             <td class="type">
1366
1367
1368 <span class="param-type">String</span>
1369
1370
1371
1372
1373             </td>
1374
1375
1376
1377
1378
1379             <td class="description last"><p>The alias of the account transferring the asset (possibly null).</p></td>
1380         </tr>
1381
1382
1383
1384         <tr>
1385
1386                 <td class="name"><code>account_id</code></td>
1387
1388
1389             <td class="type">
1390
1391
1392 <span class="param-type">String</span>
1393
1394
1395
1396
1397             </td>
1398
1399
1400
1401
1402
1403             <td class="description last"><p>The id of the account transferring the asset (possibly null).</p></td>
1404         </tr>
1405
1406
1407
1408         <tr>
1409
1410                 <td class="name"><code>asset_id</code></td>
1411
1412
1413             <td class="type">
1414
1415
1416 <span class="param-type">String</span>
1417
1418
1419
1420
1421             </td>
1422
1423
1424
1425
1426
1427             <td class="description last"><p>The id of the asset being issued or spent (possibly null).</p></td>
1428         </tr>
1429
1430
1431
1432         <tr>
1433
1434                 <td class="name"><code>asset_alias</code></td>
1435
1436
1437             <td class="type">
1438
1439
1440 <span class="param-type">String</span>
1441
1442
1443
1444
1445             </td>
1446
1447
1448
1449
1450
1451             <td class="description last"><p>The alias of the asset being issued or spent (possibly null).</p></td>
1452         </tr>
1453
1454
1455
1456         <tr>
1457
1458                 <td class="name"><code>address</code></td>
1459
1460
1461             <td class="type">
1462
1463
1464 <span class="param-type">String</span>
1465
1466
1467
1468
1469             </td>
1470
1471
1472
1473
1474
1475             <td class="description last"><p>Address to receive the transfered asset(possibly null, required for control_address action).</p></td>
1476         </tr>
1477
1478
1479     </tbody>
1480 </table>
1481 </dl>
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518 </dl>
1519
1520
1521
1522 </dd>
1523
1524
1525
1526 <hr>
1527 <dt>
1528     <h4 class="name" id="~builderCallback"><span class="type-signature"></span>builderCallback(builder)</h4>
1529
1530
1531 </dt>
1532 <dd>
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542         <h5>Parameters:</h5>
1543
1544
1545 <table class="params table table-striped">
1546     <thead>
1547     <tr>
1548
1549         <th>Name</th>
1550
1551
1552         <th>Type</th>
1553
1554
1555
1556
1557
1558         <th class="last">Description</th>
1559     </tr>
1560     </thead>
1561
1562     <tbody>
1563
1564
1565         <tr>
1566
1567                 <td class="name"><code>builder</code></td>
1568
1569
1570             <td class="type">
1571
1572
1573 <span class="param-type"><a href="TransactionBuilder.html">TransactionBuilder</a></span>
1574
1575
1576
1577
1578             </td>
1579
1580
1581
1582
1583
1584             <td class="description last"></td>
1585         </tr>
1586
1587
1588     </tbody>
1589 </table>
1590
1591
1592
1593
1594 <dl class="details">
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630 </dl>
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646 </dd>
1647
1648
1649
1650 <hr>
1651 <dt class="name" id="~SignResult">
1652     <h4 id="~SignResult">SignResult</h4>
1653
1654
1655 </dt>
1656 <dd>
1657
1658     <div class="description">
1659         <p>Data structure <code>/sign-transaction</code> api will return.</p>
1660     </div>
1661
1662
1663
1664         <h5>Type:</h5>
1665         <ul>
1666             <li>
1667
1668 <span class="param-type">Object</span>
1669
1670
1671
1672             </li>
1673         </ul>
1674
1675
1676
1677 <dl class="details">
1678
1679
1680     <h5 class="subsection-title">Properties:</h5>
1681
1682     <dl>
1683
1684 <table class="props table table-striped">
1685     <thead>
1686     <tr>
1687
1688         <th>Name</th>
1689
1690
1691         <th>Type</th>
1692
1693
1694
1695
1696
1697         <th class="last">Description</th>
1698     </tr>
1699     </thead>
1700
1701     <tbody>
1702
1703
1704         <tr>
1705
1706                 <td class="name"><code>transaction</code></td>
1707
1708
1709             <td class="type">
1710
1711
1712 <span class="param-type"><a href="global.html#Transaction">Transaction</a></span>
1713
1714
1715
1716
1717             </td>
1718
1719
1720
1721
1722
1723             <td class="description last"><p>The signed transaction if sign success.</p></td>
1724         </tr>
1725
1726
1727
1728         <tr>
1729
1730                 <td class="name"><code>sign_complete</code></td>
1731
1732
1733             <td class="type">
1734
1735
1736 <span class="param-type">Boolean</span>
1737
1738
1739
1740
1741             </td>
1742
1743
1744
1745
1746
1747             <td class="description last"><p>Whether all input actions are signed. It means this transaction can be submit if true, else not.</p></td>
1748         </tr>
1749
1750
1751     </tbody>
1752 </table>
1753 </dl>
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790 </dl>
1791
1792
1793
1794 </dd>
1795
1796             </dl>
1797
1798
1799
1800 </article>
1801
1802 </section>
1803
1804
1805
1806
1807                 </div>
1808         </div>
1809
1810         <div class="clearfix"></div>
1811
1812
1813                 <div class="col-md-3">
1814                         <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
1815                 </div>
1816
1817
1818 </div>
1819 </div>
1820
1821
1822     <div class="modal fade" id="searchResults">
1823       <div class="modal-dialog">
1824         <div class="modal-content">
1825           <div class="modal-header">
1826             <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
1827             <h4 class="modal-title">Search results</h4>
1828           </div>
1829           <div class="modal-body"></div>
1830           <div class="modal-footer">
1831             <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
1832           </div>
1833         </div><!-- /.modal-content -->
1834       </div><!-- /.modal-dialog -->
1835     </div>
1836
1837
1838 <footer>
1839
1840
1841 <span class="jsdoc-message">
1842         Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
1843
1844                 on 2018-11-26T16:28:32+08:00
1845
1846         using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1847 </span>
1848 </footer>
1849
1850 <script src="scripts/docstrap.lib.js"></script>
1851 <script src="scripts/toc.js"></script>
1852
1853     <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
1854
1855
1856 <script>
1857 $( function () {
1858         $( "[id*='$']" ).each( function () {
1859                 var $this = $( this );
1860
1861                 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
1862         } );
1863
1864         $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
1865                 var $this = $( this );
1866
1867                 var example = $this.find( "code" );
1868                 exampleText = example.html();
1869                 var lang = /{@lang (.*?)}/.exec( exampleText );
1870                 if ( lang && lang[1] ) {
1871                         exampleText = exampleText.replace( lang[0], "" );
1872                         example.html( exampleText );
1873                         lang = lang[1];
1874                 } else {
1875                         var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
1876                         lang = langClassMatch ? langClassMatch[1] : "javascript";
1877                 }
1878
1879                 if ( lang ) {
1880
1881                         $this
1882                         .addClass( "sunlight-highlight-" + lang )
1883                         .addClass( "linenums" )
1884                         .html( example.html() );
1885
1886                 }
1887         } );
1888
1889         Sunlight.highlightAll( {
1890                 lineNumbers : true,
1891                 showMenu : true,
1892                 enableDoclinks : true
1893         } );
1894
1895         $.catchAnchorLinks( {
1896         navbarOffset: 10
1897         } );
1898         $( "#toc" ).toc( {
1899                 anchorName  : function ( i, heading, prefix ) {
1900                         return $( heading ).attr( "id" ) || ( prefix + i );
1901                 },
1902                 selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
1903                 showAndHide : false,
1904                 smoothScrolling: true
1905         } );
1906
1907         $( "#main span[id^='toc']" ).addClass( "toc-shim" );
1908         $( '.dropdown-toggle' ).dropdown();
1909
1910     $( "table" ).each( function () {
1911       var $this = $( this );
1912       $this.addClass('table');
1913     } );
1914
1915 } );
1916 </script>
1917
1918
1919
1920 <!--Navigation and Symbol Display-->
1921
1922
1923 <!--Google Analytics-->
1924
1925
1926
1927     <script type="text/javascript">
1928         $(document).ready(function() {
1929             SearcherDisplay.init();
1930         });
1931     </script>
1932
1933
1934 </body>
1935 </html>