@solana/web3.js 0.98.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/README.md +10 -55
  2. package/lib/index.browser.esm.js +48 -24
  3. package/lib/index.browser.esm.js.map +1 -1
  4. package/lib/index.cjs.js +101 -56
  5. package/lib/index.cjs.js.map +1 -1
  6. package/lib/index.esm.js +88 -64
  7. package/lib/index.esm.js.map +1 -1
  8. package/lib/index.iife.js +42 -25
  9. package/lib/index.iife.js.map +1 -1
  10. package/lib/index.iife.min.js +2 -2
  11. package/lib/index.iife.min.js.map +1 -1
  12. package/lib/types/index.d.ts.map +1 -1
  13. package/package.json +27 -45
  14. package/src/message.ts +9 -12
  15. package/src/transaction.ts +2 -2
  16. package/src/util/guarded-array-utils.ts +37 -0
  17. package/src/validator-info.ts +5 -4
  18. package/bin/bpf-sdk-install.sh +0 -38
  19. package/bin/localnet.sh +0 -161
  20. package/bpf-sdk/LICENSE +0 -13
  21. package/bpf-sdk/c/README.md +0 -44
  22. package/bpf-sdk/c/bpf.ld +0 -20
  23. package/bpf-sdk/c/bpf.mk +0 -249
  24. package/bpf-sdk/c/inc/deserialize_deprecated.h +0 -115
  25. package/bpf-sdk/c/inc/solana_sdk.h +0 -669
  26. package/bpf-sdk/c/inc/stdio.h +0 -4
  27. package/bpf-sdk/c/inc/stdlib.h +0 -2
  28. package/bpf-sdk/c/inc/string.h +0 -7
  29. package/bpf-sdk/c/inc/sys/param.h +0 -1
  30. package/bpf-sdk/c/inc/wchar.h +0 -1
  31. package/bpf-sdk/env.sh +0 -39
  32. package/bpf-sdk/rust/bpf.ld +0 -20
  33. package/bpf-sdk/rust/build.sh +0 -21
  34. package/bpf-sdk/rust/clean.sh +0 -17
  35. package/bpf-sdk/rust/xargo-build.sh +0 -29
  36. package/bpf-sdk/scripts/dump.sh +0 -45
  37. package/bpf-sdk/scripts/install.sh +0 -178
  38. package/bpf-sdk/scripts/objcopy.sh +0 -6
  39. package/bpf-sdk/scripts/package.sh +0 -19
  40. package/bpf-sdk/scripts/strip.sh +0 -23
  41. package/bpf-sdk/version.txt +0 -2
  42. package/doc/assets/css/main.css +0 -2660
  43. package/doc/assets/images/icons.png +0 -0
  44. package/doc/assets/images/icons@2x.png +0 -0
  45. package/doc/assets/images/widgets.png +0 -0
  46. package/doc/assets/images/widgets@2x.png +0 -0
  47. package/doc/assets/js/main.js +0 -248
  48. package/doc/assets/js/search.js +0 -1
  49. package/doc/classes/account.html +0 -244
  50. package/doc/classes/authorized.html +0 -234
  51. package/doc/classes/bpfloader.html +0 -267
  52. package/doc/classes/connection.html +0 -2354
  53. package/doc/classes/loader.html +0 -275
  54. package/doc/classes/lockup.html +0 -250
  55. package/doc/classes/message.html +0 -326
  56. package/doc/classes/nonceaccount.html +0 -233
  57. package/doc/classes/publickey.html +0 -411
  58. package/doc/classes/secp256k1program.html +0 -308
  59. package/doc/classes/stakeinstruction.html +0 -403
  60. package/doc/classes/stakeprogram.html +0 -503
  61. package/doc/classes/systeminstruction.html +0 -563
  62. package/doc/classes/systemprogram.html +0 -503
  63. package/doc/classes/transaction.html +0 -688
  64. package/doc/classes/transactioninstruction.html +0 -240
  65. package/doc/classes/validatorinfo.html +0 -279
  66. package/doc/classes/voteaccount.html +0 -331
  67. package/doc/index.html +0 -640
  68. package/doc/interfaces/feecalculator.html +0 -166
  69. package/doc/modules.html +0 -4682
  70. package/examples/README.md +0 -10
  71. package/examples/account.html +0 -24
  72. package/examples/account.js +0 -10
  73. package/examples/bpf-c-noop/.gitignore +0 -1
  74. package/examples/bpf-c-noop/makefile +0 -1
  75. package/examples/bpf-c-noop/src/noop/noop.c +0 -19
  76. package/examples/bpf-rust-noop/.gitignore +0 -3
  77. package/examples/bpf-rust-noop/Cargo.toml +0 -23
  78. package/examples/bpf-rust-noop/Xargo.toml +0 -2
  79. package/examples/bpf-rust-noop/src/lib.rs +0 -70
  80. package/examples/get-balance.html +0 -37
  81. package/examples/get-balance.js +0 -18
@@ -1,688 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>Transaction | @solana/web3.js</title>
7
- <meta name="description" content="Documentation for @solana/web3.js">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">@solana/web3.js</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- <input type="checkbox" id="tsd-filter-externals" checked />
43
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
- </div>
45
- </div>
46
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
- </div>
48
- </div>
49
- </div>
50
- </div>
51
- <div class="tsd-page-title">
52
- <div class="container">
53
- <ul class="tsd-breadcrumb">
54
- <li>
55
- <a href="../modules.html">@solana/web3.js</a>
56
- </li>
57
- <li>
58
- <a href="transaction.html">Transaction</a>
59
- </li>
60
- </ul>
61
- <h1>Class Transaction</h1>
62
- </div>
63
- </div>
64
- </header>
65
- <div class="container container-main">
66
- <div class="row">
67
- <div class="col-8 col-content">
68
- <section class="tsd-panel tsd-comment">
69
- <div class="tsd-comment tsd-typography">
70
- <div class="lead">
71
- <p>Transaction class</p>
72
- </div>
73
- </div>
74
- </section>
75
- <section class="tsd-panel tsd-hierarchy">
76
- <h3>Hierarchy</h3>
77
- <ul class="tsd-hierarchy">
78
- <li>
79
- <span class="target">Transaction</span>
80
- </li>
81
- </ul>
82
- </section>
83
- <section class="tsd-panel-group tsd-index-group">
84
- <h2>Index</h2>
85
- <section class="tsd-panel tsd-index-panel">
86
- <div class="tsd-index-content">
87
- <section class="tsd-index-section ">
88
- <h3>Constructors</h3>
89
- <ul class="tsd-index-list">
90
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="transaction.html#constructor" class="tsd-kind-icon">constructor</a></li>
91
- </ul>
92
- </section>
93
- <section class="tsd-index-section ">
94
- <h3>Properties</h3>
95
- <ul class="tsd-index-list">
96
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="transaction.html#feepayer" class="tsd-kind-icon">fee<wbr>Payer</a></li>
97
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="transaction.html#instructions" class="tsd-kind-icon">instructions</a></li>
98
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="transaction.html#nonceinfo" class="tsd-kind-icon">nonce<wbr>Info</a></li>
99
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="transaction.html#recentblockhash" class="tsd-kind-icon">recent<wbr>Blockhash</a></li>
100
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="transaction.html#signatures" class="tsd-kind-icon">signatures</a></li>
101
- </ul>
102
- </section>
103
- <section class="tsd-index-section ">
104
- <h3>Accessors</h3>
105
- <ul class="tsd-index-list">
106
- <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="transaction.html#signature" class="tsd-kind-icon">signature</a></li>
107
- </ul>
108
- </section>
109
- <section class="tsd-index-section ">
110
- <h3>Methods</h3>
111
- <ul class="tsd-index-list">
112
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="transaction.html#add" class="tsd-kind-icon">add</a></li>
113
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="transaction.html#addsignature" class="tsd-kind-icon">add<wbr>Signature</a></li>
114
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="transaction.html#compilemessage" class="tsd-kind-icon">compile<wbr>Message</a></li>
115
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="transaction.html#partialsign" class="tsd-kind-icon">partial<wbr>Sign</a></li>
116
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="transaction.html#serialize" class="tsd-kind-icon">serialize</a></li>
117
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="transaction.html#serializemessage" class="tsd-kind-icon">serialize<wbr>Message</a></li>
118
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="transaction.html#setsigners" class="tsd-kind-icon">set<wbr>Signers</a></li>
119
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="transaction.html#sign" class="tsd-kind-icon">sign</a></li>
120
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="transaction.html#verifysignatures" class="tsd-kind-icon">verify<wbr>Signatures</a></li>
121
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="transaction.html#from" class="tsd-kind-icon">from</a></li>
122
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="transaction.html#populate" class="tsd-kind-icon">populate</a></li>
123
- </ul>
124
- </section>
125
- </div>
126
- </section>
127
- </section>
128
- <section class="tsd-panel-group tsd-member-group ">
129
- <h2>Constructors</h2>
130
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
131
- <a name="constructor" class="tsd-anchor"></a>
132
- <h3>constructor</h3>
133
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
134
- <li class="tsd-signature tsd-kind-icon">new <wbr>Transaction<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TransactionCtorFields</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></li>
135
- </ul>
136
- <ul class="tsd-descriptions">
137
- <li class="tsd-description">
138
- <aside class="tsd-sources">
139
- <ul>
140
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L181">transaction.ts:181</a></li>
141
- </ul>
142
- </aside>
143
- <div class="tsd-comment tsd-typography">
144
- <div class="lead">
145
- <p>Construct an empty Transaction</p>
146
- </div>
147
- </div>
148
- <h4 class="tsd-parameters-title">Parameters</h4>
149
- <ul class="tsd-parameters">
150
- <li>
151
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> opts: <span class="tsd-signature-type">TransactionCtorFields</span></h5>
152
- </li>
153
- </ul>
154
- <h4 class="tsd-returns-title">Returns <a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h4>
155
- </li>
156
- </ul>
157
- </section>
158
- </section>
159
- <section class="tsd-panel-group tsd-member-group ">
160
- <h2>Properties</h2>
161
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
162
- <a name="feepayer" class="tsd-anchor"></a>
163
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> fee<wbr>Payer</h3>
164
- <div class="tsd-signature tsd-kind-icon">fee<wbr>Payer<span class="tsd-signature-symbol">:</span> <a href="publickey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></div>
165
- <aside class="tsd-sources">
166
- <ul>
167
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L165">transaction.ts:165</a></li>
168
- </ul>
169
- </aside>
170
- <div class="tsd-comment tsd-typography">
171
- <div class="lead">
172
- <p>The transaction fee payer</p>
173
- </div>
174
- </div>
175
- </section>
176
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
177
- <a name="instructions" class="tsd-anchor"></a>
178
- <h3>instructions</h3>
179
- <div class="tsd-signature tsd-kind-icon">instructions<span class="tsd-signature-symbol">:</span> <a href="transactioninstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div>
180
- <aside class="tsd-sources">
181
- <ul>
182
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L170">transaction.ts:170</a></li>
183
- </ul>
184
- </aside>
185
- <div class="tsd-comment tsd-typography">
186
- <div class="lead">
187
- <p>The instructions to atomically execute</p>
188
- </div>
189
- </div>
190
- </section>
191
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
192
- <a name="nonceinfo" class="tsd-anchor"></a>
193
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> nonce<wbr>Info</h3>
194
- <div class="tsd-signature tsd-kind-icon">nonce<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NonceInformation</span></div>
195
- <aside class="tsd-sources">
196
- <ul>
197
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L181">transaction.ts:181</a></li>
198
- </ul>
199
- </aside>
200
- <div class="tsd-comment tsd-typography">
201
- <div class="lead">
202
- <p>Optional Nonce information. If populated, transaction will use a durable
203
- Nonce hash instead of a recentBlockhash. Must be populated by the caller</p>
204
- </div>
205
- </div>
206
- </section>
207
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
208
- <a name="recentblockhash" class="tsd-anchor"></a>
209
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> recent<wbr>Blockhash</h3>
210
- <div class="tsd-signature tsd-kind-icon">recent<wbr>Blockhash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
211
- <aside class="tsd-sources">
212
- <ul>
213
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L175">transaction.ts:175</a></li>
214
- </ul>
215
- </aside>
216
- <div class="tsd-comment tsd-typography">
217
- <div class="lead">
218
- <p>A recent transaction id. Must be populated by the caller</p>
219
- </div>
220
- </div>
221
- </section>
222
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
223
- <a name="signatures" class="tsd-anchor"></a>
224
- <h3>signatures</h3>
225
- <div class="tsd-signature tsd-kind-icon">signatures<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SignaturePubkeyPair</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div>
226
- <aside class="tsd-sources">
227
- <ul>
228
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L150">transaction.ts:150</a></li>
229
- </ul>
230
- </aside>
231
- <div class="tsd-comment tsd-typography">
232
- <div class="lead">
233
- <p>Signatures for the transaction. Typically created by invoking the
234
- <code>sign()</code> method</p>
235
- </div>
236
- </div>
237
- </section>
238
- </section>
239
- <section class="tsd-panel-group tsd-member-group ">
240
- <h2>Accessors</h2>
241
- <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
242
- <a name="signature" class="tsd-anchor"></a>
243
- <h3>signature</h3>
244
- <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
245
- <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> signature<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></li>
246
- </ul>
247
- <ul class="tsd-descriptions">
248
- <li class="tsd-description">
249
- <aside class="tsd-sources">
250
- <ul>
251
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L155">transaction.ts:155</a></li>
252
- </ul>
253
- </aside>
254
- <div class="tsd-comment tsd-typography">
255
- <div class="lead">
256
- <p>The first (payer) Transaction signature</p>
257
- </div>
258
- </div>
259
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h4>
260
- </li>
261
- </ul>
262
- </section>
263
- </section>
264
- <section class="tsd-panel-group tsd-member-group ">
265
- <h2>Methods</h2>
266
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
267
- <a name="add" class="tsd-anchor"></a>
268
- <h3>add</h3>
269
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
270
- <li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a><span class="tsd-signature-symbol"> | </span><a href="transactioninstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#transactioninstructionctorfields" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionInstructionCtorFields</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></li>
271
- </ul>
272
- <ul class="tsd-descriptions">
273
- <li class="tsd-description">
274
- <aside class="tsd-sources">
275
- <ul>
276
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L193">transaction.ts:193</a></li>
277
- </ul>
278
- </aside>
279
- <div class="tsd-comment tsd-typography">
280
- <div class="lead">
281
- <p>Add one or more instructions to this Transaction</p>
282
- </div>
283
- </div>
284
- <h4 class="tsd-parameters-title">Parameters</h4>
285
- <ul class="tsd-parameters">
286
- <li>
287
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-symbol">(</span><a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a><span class="tsd-signature-symbol"> | </span><a href="transactioninstruction.html" class="tsd-signature-type" data-tsd-kind="Class">TransactionInstruction</a><span class="tsd-signature-symbol"> | </span><a href="../modules.html#transactioninstructionctorfields" class="tsd-signature-type" data-tsd-kind="Type alias">TransactionInstructionCtorFields</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
288
- </li>
289
- </ul>
290
- <h4 class="tsd-returns-title">Returns <a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h4>
291
- </li>
292
- </ul>
293
- </section>
294
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
295
- <a name="addsignature" class="tsd-anchor"></a>
296
- <h3>add<wbr>Signature</h3>
297
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
298
- <li class="tsd-signature tsd-kind-icon">add<wbr>Signature<span class="tsd-signature-symbol">(</span>pubkey<span class="tsd-signature-symbol">: </span><a href="publickey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a>, signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
299
- </ul>
300
- <ul class="tsd-descriptions">
301
- <li class="tsd-description">
302
- <aside class="tsd-sources">
303
- <ul>
304
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L533">transaction.ts:533</a></li>
305
- </ul>
306
- </aside>
307
- <div class="tsd-comment tsd-typography">
308
- <div class="lead">
309
- <p>Add an externally created signature to a transaction. The public key
310
- must correspond to either the fee payer or a signer account in the transaction
311
- instructions.</p>
312
- </div>
313
- </div>
314
- <h4 class="tsd-parameters-title">Parameters</h4>
315
- <ul class="tsd-parameters">
316
- <li>
317
- <h5>pubkey: <a href="publickey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a></h5>
318
- </li>
319
- <li>
320
- <h5>signature: <span class="tsd-signature-type">Buffer</span></h5>
321
- </li>
322
- </ul>
323
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
324
- </li>
325
- </ul>
326
- </section>
327
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
328
- <a name="compilemessage" class="tsd-anchor"></a>
329
- <h3>compile<wbr>Message</h3>
330
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
331
- <li class="tsd-signature tsd-kind-icon">compile<wbr>Message<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a></li>
332
- </ul>
333
- <ul class="tsd-descriptions">
334
- <li class="tsd-description">
335
- <aside class="tsd-sources">
336
- <ul>
337
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L217">transaction.ts:217</a></li>
338
- </ul>
339
- </aside>
340
- <div class="tsd-comment tsd-typography">
341
- <div class="lead">
342
- <p>Compile transaction data</p>
343
- </div>
344
- </div>
345
- <h4 class="tsd-returns-title">Returns <a href="message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a></h4>
346
- </li>
347
- </ul>
348
- </section>
349
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
350
- <a name="partialsign" class="tsd-anchor"></a>
351
- <h3>partial<wbr>Sign</h3>
352
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
353
- <li class="tsd-signature tsd-kind-icon">partial<wbr>Sign<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>signers<span class="tsd-signature-symbol">: </span><a href="account.html" class="tsd-signature-type" data-tsd-kind="Class">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
354
- </ul>
355
- <ul class="tsd-descriptions">
356
- <li class="tsd-description">
357
- <aside class="tsd-sources">
358
- <ul>
359
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L495">transaction.ts:495</a></li>
360
- </ul>
361
- </aside>
362
- <div class="tsd-comment tsd-typography">
363
- <div class="lead">
364
- <p>Partially sign a transaction with the specified accounts. All accounts must
365
- correspond to either the fee payer or a signer account in the transaction
366
- instructions.</p>
367
- </div>
368
- <p>All the caveats from the <code>sign</code> method apply to <code>partialSign</code></p>
369
- </div>
370
- <h4 class="tsd-parameters-title">Parameters</h4>
371
- <ul class="tsd-parameters">
372
- <li>
373
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>signers: <a href="account.html" class="tsd-signature-type" data-tsd-kind="Class">Account</a><span class="tsd-signature-symbol">[]</span></h5>
374
- </li>
375
- </ul>
376
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
377
- </li>
378
- </ul>
379
- </section>
380
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
381
- <a name="serialize" class="tsd-anchor"></a>
382
- <h3>serialize</h3>
383
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
384
- <li class="tsd-signature tsd-kind-icon">serialize<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><a href="../modules.html#serializeconfig" class="tsd-signature-type" data-tsd-kind="Type alias">SerializeConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
385
- </ul>
386
- <ul class="tsd-descriptions">
387
- <li class="tsd-description">
388
- <aside class="tsd-sources">
389
- <ul>
390
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L584">transaction.ts:584</a></li>
391
- </ul>
392
- </aside>
393
- <div class="tsd-comment tsd-typography">
394
- <div class="lead">
395
- <p>Serialize the Transaction in the wire format.</p>
396
- </div>
397
- </div>
398
- <h4 class="tsd-parameters-title">Parameters</h4>
399
- <ul class="tsd-parameters">
400
- <li>
401
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <a href="../modules.html#serializeconfig" class="tsd-signature-type" data-tsd-kind="Type alias">SerializeConfig</a></h5>
402
- </li>
403
- </ul>
404
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
405
- </li>
406
- </ul>
407
- </section>
408
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
409
- <a name="serializemessage" class="tsd-anchor"></a>
410
- <h3>serialize<wbr>Message</h3>
411
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
412
- <li class="tsd-signature tsd-kind-icon">serialize<wbr>Message<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
413
- </ul>
414
- <ul class="tsd-descriptions">
415
- <li class="tsd-description">
416
- <aside class="tsd-sources">
417
- <ul>
418
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L413">transaction.ts:413</a></li>
419
- </ul>
420
- </aside>
421
- <div class="tsd-comment tsd-typography">
422
- <div class="lead">
423
- <p>Get a buffer of the Transaction data that need to be covered by signatures</p>
424
- </div>
425
- </div>
426
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
427
- </li>
428
- </ul>
429
- </section>
430
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
431
- <a name="setsigners" class="tsd-anchor"></a>
432
- <h3>set<wbr>Signers</h3>
433
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
434
- <li class="tsd-signature tsd-kind-icon">set<wbr>Signers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>signers<span class="tsd-signature-symbol">: </span><a href="publickey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
435
- </ul>
436
- <ul class="tsd-descriptions">
437
- <li class="tsd-description">
438
- <aside class="tsd-sources">
439
- <ul>
440
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L427">transaction.ts:427</a></li>
441
- </ul>
442
- </aside>
443
- <div class="tsd-comment tsd-typography">
444
- <div class="lead">
445
- <p>Specify the public keys which will be used to sign the Transaction.
446
- The first signer will be used as the transaction fee payer account.</p>
447
- </div>
448
- <p>Signatures can be added with either <code>partialSign</code> or <code>addSignature</code></p>
449
- <dl class="tsd-comment-tags">
450
- <dt>deprecated</dt>
451
- <dd><p>Deprecated since v0.84.0. Only the fee payer needs to be
452
- specified and it can be set in the Transaction constructor or with the
453
- <code>feePayer</code> property.</p>
454
- </dd>
455
- </dl>
456
- </div>
457
- <h4 class="tsd-parameters-title">Parameters</h4>
458
- <ul class="tsd-parameters">
459
- <li>
460
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>signers: <a href="publickey.html" class="tsd-signature-type" data-tsd-kind="Class">PublicKey</a><span class="tsd-signature-symbol">[]</span></h5>
461
- </li>
462
- </ul>
463
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
464
- </li>
465
- </ul>
466
- </section>
467
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
468
- <a name="sign" class="tsd-anchor"></a>
469
- <h3>sign</h3>
470
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
471
- <li class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>signers<span class="tsd-signature-symbol">: </span><a href="account.html" class="tsd-signature-type" data-tsd-kind="Class">Account</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
472
- </ul>
473
- <ul class="tsd-descriptions">
474
- <li class="tsd-description">
475
- <aside class="tsd-sources">
476
- <ul>
477
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L460">transaction.ts:460</a></li>
478
- </ul>
479
- </aside>
480
- <div class="tsd-comment tsd-typography">
481
- <div class="lead">
482
- <p>Sign the Transaction with the specified accounts. Multiple signatures may
483
- be applied to a Transaction. The first signature is considered &quot;primary&quot;
484
- and is used identify and confirm transactions.</p>
485
- </div>
486
- <p>If the Transaction <code>feePayer</code> is not set, the first signer will be used
487
- as the transaction fee payer account.</p>
488
- <p>Transaction fields should not be modified after the first call to <code>sign</code>,
489
- as doing so may invalidate the signature and cause the Transaction to be
490
- rejected.</p>
491
- <p>The Transaction must be assigned a valid <code>recentBlockhash</code> before invoking this method</p>
492
- </div>
493
- <h4 class="tsd-parameters-title">Parameters</h4>
494
- <ul class="tsd-parameters">
495
- <li>
496
- <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>signers: <a href="account.html" class="tsd-signature-type" data-tsd-kind="Class">Account</a><span class="tsd-signature-symbol">[]</span></h5>
497
- </li>
498
- </ul>
499
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
500
- </li>
501
- </ul>
502
- </section>
503
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
504
- <a name="verifysignatures" class="tsd-anchor"></a>
505
- <h3>verify<wbr>Signatures</h3>
506
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
507
- <li class="tsd-signature tsd-kind-icon">verify<wbr>Signatures<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
508
- </ul>
509
- <ul class="tsd-descriptions">
510
- <li class="tsd-description">
511
- <aside class="tsd-sources">
512
- <ul>
513
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L557">transaction.ts:557</a></li>
514
- </ul>
515
- </aside>
516
- <div class="tsd-comment tsd-typography">
517
- <div class="lead">
518
- <p>Verify signatures of a complete, signed Transaction</p>
519
- </div>
520
- </div>
521
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
522
- </li>
523
- </ul>
524
- </section>
525
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
526
- <a name="from" class="tsd-anchor"></a>
527
- <h3><span class="tsd-flag ts-flagStatic">Static</span> from</h3>
528
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
529
- <li class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></li>
530
- </ul>
531
- <ul class="tsd-descriptions">
532
- <li class="tsd-description">
533
- <aside class="tsd-sources">
534
- <ul>
535
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L663">transaction.ts:663</a></li>
536
- </ul>
537
- </aside>
538
- <div class="tsd-comment tsd-typography">
539
- <div class="lead">
540
- <p>Parse a wire transaction into a Transaction object.</p>
541
- </div>
542
- </div>
543
- <h4 class="tsd-parameters-title">Parameters</h4>
544
- <ul class="tsd-parameters">
545
- <li>
546
- <h5>buffer: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
547
- </li>
548
- </ul>
549
- <h4 class="tsd-returns-title">Returns <a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h4>
550
- </li>
551
- </ul>
552
- </section>
553
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
554
- <a name="populate" class="tsd-anchor"></a>
555
- <h3><span class="tsd-flag ts-flagStatic">Static</span> populate</h3>
556
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
557
- <li class="tsd-signature tsd-kind-icon">populate<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><a href="message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a>, signatures<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></li>
558
- </ul>
559
- <ul class="tsd-descriptions">
560
- <li class="tsd-description">
561
- <aside class="tsd-sources">
562
- <ul>
563
- <li>Defined in <a href="https://github.com/solana-labs/solana-web3.js/blob/d5b2a1b/src/transaction.ts#L681">transaction.ts:681</a></li>
564
- </ul>
565
- </aside>
566
- <div class="tsd-comment tsd-typography">
567
- <div class="lead">
568
- <p>Populate Transaction object from message and signatures</p>
569
- </div>
570
- </div>
571
- <h4 class="tsd-parameters-title">Parameters</h4>
572
- <ul class="tsd-parameters">
573
- <li>
574
- <h5>message: <a href="message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a></h5>
575
- </li>
576
- <li>
577
- <h5>signatures: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
578
- </li>
579
- </ul>
580
- <h4 class="tsd-returns-title">Returns <a href="transaction.html" class="tsd-signature-type" data-tsd-kind="Class">Transaction</a></h4>
581
- </li>
582
- </ul>
583
- </section>
584
- </section>
585
- </div>
586
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
587
- <nav class="tsd-navigation primary">
588
- <ul>
589
- <li class=" ">
590
- <a href="../modules.html">Exports</a>
591
- </li>
592
- </ul>
593
- </nav>
594
- <nav class="tsd-navigation secondary menu-sticky">
595
- <ul class="before-current">
596
- </ul>
597
- <ul class="current">
598
- <li class="current tsd-kind-class">
599
- <a href="transaction.html" class="tsd-kind-icon">Transaction</a>
600
- <ul>
601
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
602
- <a href="transaction.html#constructor" class="tsd-kind-icon">constructor</a>
603
- </li>
604
- <li class=" tsd-kind-property tsd-parent-kind-class">
605
- <a href="transaction.html#feepayer" class="tsd-kind-icon">fee<wbr>Payer</a>
606
- </li>
607
- <li class=" tsd-kind-property tsd-parent-kind-class">
608
- <a href="transaction.html#instructions" class="tsd-kind-icon">instructions</a>
609
- </li>
610
- <li class=" tsd-kind-property tsd-parent-kind-class">
611
- <a href="transaction.html#nonceinfo" class="tsd-kind-icon">nonce<wbr>Info</a>
612
- </li>
613
- <li class=" tsd-kind-property tsd-parent-kind-class">
614
- <a href="transaction.html#recentblockhash" class="tsd-kind-icon">recent<wbr>Blockhash</a>
615
- </li>
616
- <li class=" tsd-kind-property tsd-parent-kind-class">
617
- <a href="transaction.html#signatures" class="tsd-kind-icon">signatures</a>
618
- </li>
619
- <li class=" tsd-kind-get-signature tsd-parent-kind-class">
620
- <a href="transaction.html#signature" class="tsd-kind-icon">signature</a>
621
- </li>
622
- <li class=" tsd-kind-method tsd-parent-kind-class">
623
- <a href="transaction.html#add" class="tsd-kind-icon">add</a>
624
- </li>
625
- <li class=" tsd-kind-method tsd-parent-kind-class">
626
- <a href="transaction.html#addsignature" class="tsd-kind-icon">add<wbr>Signature</a>
627
- </li>
628
- <li class=" tsd-kind-method tsd-parent-kind-class">
629
- <a href="transaction.html#compilemessage" class="tsd-kind-icon">compile<wbr>Message</a>
630
- </li>
631
- <li class=" tsd-kind-method tsd-parent-kind-class">
632
- <a href="transaction.html#partialsign" class="tsd-kind-icon">partial<wbr>Sign</a>
633
- </li>
634
- <li class=" tsd-kind-method tsd-parent-kind-class">
635
- <a href="transaction.html#serialize" class="tsd-kind-icon">serialize</a>
636
- </li>
637
- <li class=" tsd-kind-method tsd-parent-kind-class">
638
- <a href="transaction.html#serializemessage" class="tsd-kind-icon">serialize<wbr>Message</a>
639
- </li>
640
- <li class=" tsd-kind-method tsd-parent-kind-class">
641
- <a href="transaction.html#setsigners" class="tsd-kind-icon">set<wbr>Signers</a>
642
- </li>
643
- <li class=" tsd-kind-method tsd-parent-kind-class">
644
- <a href="transaction.html#sign" class="tsd-kind-icon">sign</a>
645
- </li>
646
- <li class=" tsd-kind-method tsd-parent-kind-class">
647
- <a href="transaction.html#verifysignatures" class="tsd-kind-icon">verify<wbr>Signatures</a>
648
- </li>
649
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
650
- <a href="transaction.html#from" class="tsd-kind-icon">from</a>
651
- </li>
652
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
653
- <a href="transaction.html#populate" class="tsd-kind-icon">populate</a>
654
- </li>
655
- </ul>
656
- </li>
657
- </ul>
658
- <ul class="after-current">
659
- </ul>
660
- </nav>
661
- </div>
662
- </div>
663
- </div>
664
- <footer class="with-border-bottom">
665
- <div class="container">
666
- <h2>Legend</h2>
667
- <div class="tsd-legend-group">
668
- <ul class="tsd-legend">
669
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
670
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
671
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
672
- </ul>
673
- <ul class="tsd-legend">
674
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
675
- </ul>
676
- <ul class="tsd-legend">
677
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
678
- </ul>
679
- </div>
680
- </div>
681
- </footer>
682
- <div class="container tsd-generator">
683
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
684
- </div>
685
- <div class="overlay"></div>
686
- <script src="../assets/js/main.js"></script>
687
- </body>
688
- </html>