-
Notifications
You must be signed in to change notification settings - Fork 131
/
FileAppendTransaction.js
473 lines (412 loc) · 14 KB
/
FileAppendTransaction.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
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
268
269
270
271
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
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
420
421
422
423
424
425
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
462
463
464
465
466
467
468
469
470
471
472
473
/*-
*
* Hedera JavaScript SDK
*
* Copyright (C) 2020 - 2023 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
import Hbar from "../Hbar.js";
import Transaction, {
TRANSACTION_REGISTRY,
} from "../transaction/Transaction.js";
import * as utf8 from "../encoding/utf8.js";
import FileId from "./FileId.js";
import TransactionId from "../transaction/TransactionId.js";
import Timestamp from "../Timestamp.js";
import List from "../transaction/List.js";
/**
* @namespace proto
* @typedef {import("@hashgraph/proto").proto.ITransaction} HashgraphProto.proto.ITransaction
* @typedef {import("@hashgraph/proto").proto.ISignedTransaction} HashgraphProto.proto.ISignedTransaction
* @typedef {import("@hashgraph/proto").proto.TransactionBody} HashgraphProto.proto.TransactionBody
* @typedef {import("@hashgraph/proto").proto.ITransactionBody} HashgraphProto.proto.ITransactionBody
* @typedef {import("@hashgraph/proto").proto.ITransactionResponse} HashgraphProto.proto.ITransactionResponse
* @typedef {import("@hashgraph/proto").proto.IFileAppendTransactionBody} HashgraphProto.proto.IFileAppendTransactionBody
* @typedef {import("@hashgraph/proto").proto.IFileID} HashgraphProto.proto.IFileID
*/
/**
* @typedef {import("../channel/Channel.js").default} Channel
* @typedef {import("../client/Client.js").default<Channel, *>} Client
* @typedef {import("../account/AccountId.js").default} AccountId
* @typedef {import("../transaction/TransactionResponse.js").default} TransactionResponse
* @typedef {import("../schedule/ScheduleCreateTransaction.js").default} ScheduleCreateTransaction
*/
/**
* A transaction specifically to append data to a file on the network.
*
* If a file has multiple keys, all keys must sign to modify its contents.
*/
export default class FileAppendTransaction extends Transaction {
/**
* @param {object} [props]
* @param {FileId | string} [props.fileId]
* @param {Uint8Array | string} [props.contents]
* @param {number} [props.maxChunks]
* @param {number} [props.chunkSize]
*/
constructor(props = {}) {
super();
/**
* @private
* @type {?FileId}
*/
this._fileId = null;
/**
* @private
* @type {?Uint8Array}
*/
this._contents = null;
/**
* @private
* @type {number}
*/
this._maxChunks = 20;
/**
* @private
* @type {number}
*/
this._chunkSize = 4096;
this._defaultMaxTransactionFee = new Hbar(5);
if (props.fileId != null) {
this.setFileId(props.fileId);
}
if (props.contents != null) {
this.setContents(props.contents);
}
if (props.maxChunks != null) {
this.setMaxChunks(props.maxChunks);
}
if (props.chunkSize != null) {
this.setChunkSize(props.chunkSize);
}
/** @type {List<TransactionId>} */
this._transactionIds = new List();
}
/**
* @internal
* @param {HashgraphProto.proto.ITransaction[]} transactions
* @param {HashgraphProto.proto.ISignedTransaction[]} signedTransactions
* @param {TransactionId[]} transactionIds
* @param {AccountId[]} nodeIds
* @param {HashgraphProto.proto.ITransactionBody[]} bodies
* @returns {FileAppendTransaction}
*/
static _fromProtobuf(
transactions,
signedTransactions,
transactionIds,
nodeIds,
bodies
) {
const body = bodies[0];
const append =
/** @type {HashgraphProto.proto.IFileAppendTransactionBody} */ (
body.fileAppend
);
let contents;
for (let i = 0; i < bodies.length; i += nodeIds.length) {
const fileAppend =
/** @type {HashgraphProto.proto.IFileAppendTransactionBody} */ (
bodies[i].fileAppend
);
if (fileAppend.contents == null) {
break;
}
if (contents == null) {
contents = new Uint8Array(
/** @type {Uint8Array} */ (fileAppend.contents)
);
continue;
}
/** @type {Uint8Array} */
const concat = new Uint8Array(
contents.length +
/** @type {Uint8Array} */ (fileAppend.contents).length
);
concat.set(contents, 0);
concat.set(
/** @type {Uint8Array} */ (fileAppend.contents),
contents.length
);
contents = concat;
}
return Transaction._fromProtobufTransactions(
new FileAppendTransaction({
fileId:
append.fileID != null
? FileId._fromProtobuf(
/** @type {HashgraphProto.proto.IFileID} */ (
append.fileID
)
)
: undefined,
contents: contents,
}),
transactions,
signedTransactions,
transactionIds,
nodeIds,
bodies
);
}
/**
* @returns {?FileId}
*/
get fileId() {
return this._fileId;
}
/**
* Set the keys which must sign any transactions modifying this file. Required.
*
* All keys must sign to modify the file's contents or keys. No key is required
* to sign for extending the expiration time (except the one for the operator account
* paying for the transaction). Only one key must sign to delete the file, however.
*
* To require more than one key to sign to delete a file, add them to a
* KeyList and pass that here.
*
* The network currently requires a file to have at least one key (or key list or threshold key)
* but this requirement may be lifted in the future.
*
* @param {FileId | string} fileId
* @returns {this}
*/
setFileId(fileId) {
this._requireNotFrozen();
this._fileId =
typeof fileId === "string"
? FileId.fromString(fileId)
: fileId.clone();
return this;
}
/**
* @returns {?Uint8Array}
*/
get contents() {
return this._contents;
}
/**
* Set the given byte array as the file's contents.
*
* This may be omitted to append an empty file.
*
* Note that total size for a given transaction is limited to 6KiB (as of March 2020) by the
* network; if you exceed this you may receive a HederaPreCheckStatusException
* with Status#TransactionOversize.
*
* In this case, you will need to break the data into chunks of less than ~6KiB and execute this
* transaction with the first chunk and then use FileAppendTransaction with
* FileAppendTransaction#setContents(Uint8Array) for the remaining chunks.
*
* @param {Uint8Array | string} contents
* @returns {this}
*/
setContents(contents) {
this._requireNotFrozen();
this._contents =
contents instanceof Uint8Array ? contents : utf8.encode(contents);
return this;
}
/**
* @returns {?number}
*/
get maxChunks() {
return this._maxChunks;
}
/**
* @param {number} maxChunks
* @returns {this}
*/
setMaxChunks(maxChunks) {
this._requireNotFrozen();
this._maxChunks = maxChunks;
return this;
}
/**
* @returns {?number}
*/
get chunkSize() {
return this._chunkSize;
}
/**
* @param {number} chunkSize
* @returns {this}
*/
setChunkSize(chunkSize) {
this._chunkSize = chunkSize;
return this;
}
/**
* Freeze this transaction from further modification to prepare for
* signing or serialization.
*
* Will use the `Client`, if available, to generate a default Transaction ID and select 1/3
* nodes to prepare this transaction for.
*
* @param {?import("../client/Client.js").default<Channel, *>} client
* @returns {this}
*/
freezeWith(client) {
super.freezeWith(client);
if (this._contents == null) {
return this;
}
const chunks = Math.floor(
(this._contents.length + (this._chunkSize - 1)) / this._chunkSize
);
if (chunks > this._maxChunks) {
throw new Error(
`Contents with size ${this._contents.length} too long for ${this._maxChunks} chunks`
);
}
let nextTransactionId = this._getTransactionId();
// Hack around the locked list. Should refactor a bit to remove such code
this._transactionIds.locked = false;
this._transactions.clear();
this._transactionIds.clear();
this._signedTransactions.clear();
for (let chunk = 0; chunk < chunks; chunk++) {
this._transactionIds.push(nextTransactionId);
this._transactionIds.advance();
for (const nodeAccountId of this._nodeAccountIds.list) {
this._signedTransactions.push(
this._makeSignedTransaction(nodeAccountId)
);
}
nextTransactionId = new TransactionId(
/** @type {AccountId} */ (nextTransactionId.accountId),
new Timestamp(
/** @type {Timestamp} */ (
nextTransactionId.validStart
).seconds,
/** @type {Timestamp} */ (
nextTransactionId.validStart
).nanos.add(1)
)
);
}
this._transactionIds.advance();
this._transactionIds.setLocked();
return this;
}
/**
* @returns {ScheduleCreateTransaction}
*/
schedule() {
this._requireNotFrozen();
if (this._contents != null && this._contents.length > this._chunkSize) {
throw new Error(
`cannot schedule \`FileAppendTransaction\` with message over ${this._chunkSize} bytes`
);
}
return super.schedule();
}
/**
* @param {import("../client/Client.js").default<Channel, *>} client
* @param {number=} requestTimeout
* @returns {Promise<TransactionResponse>}
*/
async execute(client, requestTimeout) {
return (await this.executeAll(client, requestTimeout))[0];
}
/**
* @param {import("../client/Client.js").default<Channel, *>} client
* @param {number=} requestTimeout
* @returns {Promise<TransactionResponse[]>}
*/
async executeAll(client, requestTimeout) {
if (!super._isFrozen()) {
this.freezeWith(client);
}
// on execute, sign each transaction with the operator, if present
// and we are signing a transaction that used the default transaction ID
const transactionId = this._getTransactionId();
const operatorAccountId = client.operatorAccountId;
if (
operatorAccountId != null &&
operatorAccountId.equals(
/** @type {AccountId} */ (transactionId.accountId)
)
) {
await super.signWithOperator(client);
}
const responses = [];
let remainingTimeout = requestTimeout;
for (let i = 0; i < this._transactionIds.length; i++) {
const startTimestamp = Date.now();
const response = await super.execute(client, remainingTimeout);
if (remainingTimeout != null) {
remainingTimeout = Date.now() - startTimestamp;
}
await response.getReceipt(client);
responses.push(response);
}
return responses;
}
/**
* @param {Client} client
*/
_validateChecksums(client) {
if (this._fileId != null) {
this._fileId.validateChecksum(client);
}
}
/**
* @override
* @internal
* @param {Channel} channel
* @param {HashgraphProto.proto.ITransaction} request
* @returns {Promise<HashgraphProto.proto.ITransactionResponse>}
*/
_execute(channel, request) {
return channel.file.appendContent(request);
}
/**
* @override
* @protected
* @returns {NonNullable<HashgraphProto.proto.TransactionBody["data"]>}
*/
_getTransactionDataCase() {
return "fileAppend";
}
/**
* @override
* @protected
* @returns {HashgraphProto.proto.IFileAppendTransactionBody}
*/
_makeTransactionData() {
const length = this._contents != null ? this._contents.length : 0;
const startIndex = this._transactionIds.index * this._chunkSize;
const endIndex = Math.min(startIndex + this._chunkSize, length);
return {
fileID: this._fileId != null ? this._fileId._toProtobuf() : null,
contents:
this._contents != null
? this._contents.slice(startIndex, endIndex)
: null,
};
}
/**
* @returns {string}
*/
_getLogId() {
const timestamp = /** @type {import("../Timestamp.js").default} */ (
this._transactionIds.current.validStart
);
return `FileAppendTransaction:${timestamp.toString()}`;
}
}
// eslint-disable-next-line @typescript-eslint/unbound-method
TRANSACTION_REGISTRY.set("fileAppend", FileAppendTransaction._fromProtobuf);