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