-
Notifications
You must be signed in to change notification settings - Fork 58
/
file_update_transaction.go
364 lines (309 loc) · 11.3 KB
/
file_update_transaction.go
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
package hedera
/*-
*
* Hedera Go SDK
*
* Copyright (C) 2020 - 2024 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 (
"time"
"google.golang.org/protobuf/types/known/wrapperspb"
"github.com/hashgraph/hedera-protobufs-go/services"
)
// FileUpdateTransaction
// Modify the metadata and/or contents of a file. If a field is not set in the transaction body, the
// corresponding file attribute will be unchanged. This transaction must be signed by all the keys
// in the top level of a key list (M-of-M) of the file being updated. If the keys themselves are
// being updated, then the transaction must also be signed by all the new keys. If the keys contain
// additional KeyList or ThresholdKey then M-of-M secondary KeyList or ThresholdKey signing
// requirements must be meet
type FileUpdateTransaction struct {
Transaction
fileID *FileID
keys *KeyList
expirationTime *time.Time
contents []byte
memo string
}
// NewFileUpdateTransaction creates a FileUpdateTransaction which modifies the metadata and/or contents of a file.
// If a field is not set in the transaction body, the corresponding file attribute will be unchanged.
// tx transaction must be signed by all the keys in the top level of a key list (M-of-M) of the file being updated.
// If the keys themselves are being updated, then the transaction must also be signed by all the new keys. If the keys contain
// additional KeyList or ThresholdKey then M-of-M secondary KeyList or ThresholdKey signing
// requirements must be meet
func NewFileUpdateTransaction() *FileUpdateTransaction {
tx := FileUpdateTransaction{
Transaction: _NewTransaction(),
}
tx._SetDefaultMaxTransactionFee(NewHbar(5))
return &tx
}
func _FileUpdateTransactionFromProtobuf(tx Transaction, pb *services.TransactionBody) *FileUpdateTransaction {
keys, _ := _KeyListFromProtobuf(pb.GetFileUpdate().GetKeys())
expiration := _TimeFromProtobuf(pb.GetFileUpdate().GetExpirationTime())
return &FileUpdateTransaction{
Transaction: tx,
fileID: _FileIDFromProtobuf(pb.GetFileUpdate().GetFileID()),
keys: &keys,
expirationTime: &expiration,
contents: pb.GetFileUpdate().GetContents(),
memo: pb.GetFileUpdate().GetMemo().Value,
}
}
// SetFileID Sets the FileID to be updated
func (tx *FileUpdateTransaction) SetFileID(fileID FileID) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.fileID = &fileID
return tx
}
// GetFileID returns the FileID to be updated
func (tx *FileUpdateTransaction) GetFileID() FileID {
if tx.fileID == nil {
return FileID{}
}
return *tx.fileID
}
// SetKeys Sets the new list of keys that can modify or delete the file
func (tx *FileUpdateTransaction) SetKeys(keys ...Key) *FileUpdateTransaction {
tx._RequireNotFrozen()
if tx.keys == nil {
tx.keys = &KeyList{keys: []Key{}}
}
keyList := NewKeyList()
keyList.AddAll(keys)
tx.keys = keyList
return tx
}
func (tx *FileUpdateTransaction) GetKeys() KeyList {
if tx.keys != nil {
return *tx.keys
}
return KeyList{}
}
// SetExpirationTime Sets the new expiry time
func (tx *FileUpdateTransaction) SetExpirationTime(expiration time.Time) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.expirationTime = &expiration
return tx
}
// GetExpirationTime returns the new expiry time
func (tx *FileUpdateTransaction) GetExpirationTime() time.Time {
if tx.expirationTime != nil {
return *tx.expirationTime
}
return time.Time{}
}
// SetContents Sets the new contents that should overwrite the file's current contents
func (tx *FileUpdateTransaction) SetContents(contents []byte) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.contents = contents
return tx
}
// GetContents returns the new contents that should overwrite the file's current contents
func (tx *FileUpdateTransaction) GetContents() []byte {
return tx.contents
}
// SetFileMemo Sets the new memo to be associated with the file (UTF-8 encoding max 100 bytes)
func (tx *FileUpdateTransaction) SetFileMemo(memo string) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.memo = memo
return tx
}
// GeFileMemo
// Deprecated: use GetFileMemo()
func (tx *FileUpdateTransaction) GeFileMemo() string {
return tx.memo
}
func (tx *FileUpdateTransaction) GetFileMemo() string {
return tx.memo
}
// ----- Required Interfaces ------- //
// Sign uses the provided privateKey to sign the transaction.
func (tx *FileUpdateTransaction) Sign(
privateKey PrivateKey,
) *FileUpdateTransaction {
tx.Transaction.Sign(privateKey)
return tx
}
// SignWithOperator signs the transaction with client's operator privateKey.
func (tx *FileUpdateTransaction) SignWithOperator(
client *Client,
) (*FileUpdateTransaction, error) {
// If the transaction is not signed by the _Operator, we need
// to sign the transaction with the _Operator
_, err := tx.Transaction.signWithOperator(client, tx)
if err != nil {
return nil, err
}
return tx, nil
}
// SignWith executes the TransactionSigner and adds the resulting signature data to the Transaction's signature map
// with the publicKey as the map key.
func (tx *FileUpdateTransaction) SignWith(
publicKey PublicKey,
signer TransactionSigner,
) *FileUpdateTransaction {
tx.Transaction.SignWith(publicKey, signer)
return tx
}
// AddSignature adds a signature to the transaction.
func (tx *FileUpdateTransaction) AddSignature(publicKey PublicKey, signature []byte) *FileUpdateTransaction {
tx.Transaction.AddSignature(publicKey, signature)
return tx
}
// When execution is attempted, a single attempt will timeout when tx deadline is reached. (The SDK may subsequently retry the execution.)
func (tx *FileUpdateTransaction) SetGrpcDeadline(deadline *time.Duration) *FileUpdateTransaction {
tx.Transaction.SetGrpcDeadline(deadline)
return tx
}
func (tx *FileUpdateTransaction) Freeze() (*FileUpdateTransaction, error) {
return tx.FreezeWith(nil)
}
func (tx *FileUpdateTransaction) FreezeWith(client *Client) (*FileUpdateTransaction, error) {
_, err := tx.Transaction.freezeWith(client, tx)
return tx, err
}
// SetMaxTransactionFee sets the maximum transaction fee the operator (paying account) is willing to pay.
func (tx *FileUpdateTransaction) SetMaxTransactionFee(fee Hbar) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.Transaction.SetMaxTransactionFee(fee)
return tx
}
// SetRegenerateTransactionID sets if transaction IDs should be regenerated when `TRANSACTION_EXPIRED` is received
func (tx *FileUpdateTransaction) SetRegenerateTransactionID(regenerateTransactionID bool) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.Transaction.SetRegenerateTransactionID(regenerateTransactionID)
return tx
}
// SetTransactionMemo sets the memo for this FileUpdateTransaction.
func (tx *FileUpdateTransaction) SetTransactionMemo(memo string) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.Transaction.SetTransactionMemo(memo)
return tx
}
// SetTransactionValidDuration sets the valid duration for this FileUpdateTransaction.
func (tx *FileUpdateTransaction) SetTransactionValidDuration(duration time.Duration) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.Transaction.SetTransactionValidDuration(duration)
return tx
}
// ToBytes serialise the tx to bytes, no matter if it is signed (locked), or not
func (tx *FileUpdateTransaction) ToBytes() ([]byte, error) {
bytes, err := tx.Transaction.toBytes(tx)
if err != nil {
return nil, err
}
return bytes, nil
}
// SetTransactionID sets the TransactionID for this FileUpdateTransaction.
func (tx *FileUpdateTransaction) SetTransactionID(transactionID TransactionID) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.Transaction.SetTransactionID(transactionID)
return tx
}
// SetNodeAccountID sets the _Node AccountID for this FileUpdateTransaction.
func (tx *FileUpdateTransaction) SetNodeAccountIDs(nodeID []AccountID) *FileUpdateTransaction {
tx._RequireNotFrozen()
tx.Transaction.SetNodeAccountIDs(nodeID)
return tx
}
// SetMaxRetry sets the max number of errors before execution will fail.
func (tx *FileUpdateTransaction) SetMaxRetry(count int) *FileUpdateTransaction {
tx.Transaction.SetMaxRetry(count)
return tx
}
// SetMaxBackoff The maximum amount of time to wait between retries.
// Every retry attempt will increase the wait time exponentially until it reaches this time.
func (tx *FileUpdateTransaction) SetMaxBackoff(max time.Duration) *FileUpdateTransaction {
tx.Transaction.SetMaxBackoff(max)
return tx
}
// SetMinBackoff sets the minimum amount of time to wait between retries.
func (tx *FileUpdateTransaction) SetMinBackoff(min time.Duration) *FileUpdateTransaction {
tx.Transaction.SetMinBackoff(min)
return tx
}
func (tx *FileUpdateTransaction) SetLogLevel(level LogLevel) *FileUpdateTransaction {
tx.Transaction.SetLogLevel(level)
return tx
}
func (tx *FileUpdateTransaction) Execute(client *Client) (TransactionResponse, error) {
return tx.Transaction.execute(client, tx)
}
func (tx *FileUpdateTransaction) Schedule() (*ScheduleCreateTransaction, error) {
return tx.Transaction.schedule(tx)
}
// ----------- Overridden functions ----------------
func (tx *FileUpdateTransaction) getName() string {
return "FileUpdateTransaction"
}
func (tx *FileUpdateTransaction) validateNetworkOnIDs(client *Client) error {
if client == nil || !client.autoValidateChecksums {
return nil
}
if tx.fileID != nil {
if err := tx.fileID.ValidateChecksum(client); err != nil {
return err
}
}
return nil
}
func (tx *FileUpdateTransaction) build() *services.TransactionBody {
return &services.TransactionBody{
TransactionFee: tx.transactionFee,
Memo: tx.Transaction.memo,
TransactionValidDuration: _DurationToProtobuf(tx.GetTransactionValidDuration()),
TransactionID: tx.transactionID._ToProtobuf(),
Data: &services.TransactionBody_FileUpdate{
FileUpdate: tx.buildProtoBody(),
},
}
}
func (tx *FileUpdateTransaction) buildScheduled() (*services.SchedulableTransactionBody, error) {
return &services.SchedulableTransactionBody{
TransactionFee: tx.transactionFee,
Memo: tx.Transaction.memo,
Data: &services.SchedulableTransactionBody_FileUpdate{
FileUpdate: tx.buildProtoBody(),
},
}, nil
}
func (tx *FileUpdateTransaction) buildProtoBody() *services.FileUpdateTransactionBody {
body := &services.FileUpdateTransactionBody{
Memo: &wrapperspb.StringValue{Value: tx.memo},
}
if tx.fileID != nil {
body.FileID = tx.fileID._ToProtobuf()
}
if tx.expirationTime != nil {
body.ExpirationTime = _TimeToProtobuf(*tx.expirationTime)
}
if tx.keys != nil {
body.Keys = tx.keys._ToProtoKeyList()
}
if tx.contents != nil {
body.Contents = tx.contents
}
return body
}
func (tx *FileUpdateTransaction) getMethod(channel *_Channel) _Method {
return _Method{
transaction: channel._GetFile().UpdateFile,
}
}
func (tx *FileUpdateTransaction) _ConstructScheduleProtobuf() (*services.SchedulableTransactionBody, error) {
return tx.buildScheduled()
}