-
Notifications
You must be signed in to change notification settings - Fork 58
/
topic_update_transaction.go
420 lines (350 loc) · 13.9 KB
/
topic_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
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
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"
)
// TopicUpdateTransaction
// Updates all fields on a Topic that are set in the transaction.
type TopicUpdateTransaction struct {
Transaction
topicID *TopicID
autoRenewAccountID *AccountID
adminKey Key
submitKey Key
memo string
autoRenewPeriod *time.Duration
expirationTime *time.Time
}
// NewTopicUpdateTransaction creates a TopicUpdateTransaction transaction which
// updates all fields on a Topic that are set in the transaction.
func NewTopicUpdateTransaction() *TopicUpdateTransaction {
tx := TopicUpdateTransaction{
Transaction: _NewTransaction(),
}
tx.SetAutoRenewPeriod(7890000 * time.Second)
tx._SetDefaultMaxTransactionFee(NewHbar(2))
return &tx
}
func _TopicUpdateTransactionFromProtobuf(tx Transaction, pb *services.TransactionBody) *TopicUpdateTransaction {
adminKey, _ := _KeyFromProtobuf(pb.GetConsensusUpdateTopic().GetAdminKey())
submitKey, _ := _KeyFromProtobuf(pb.GetConsensusUpdateTopic().GetSubmitKey())
expirationTime := _TimeFromProtobuf(pb.GetConsensusUpdateTopic().GetExpirationTime())
autoRenew := _DurationFromProtobuf(pb.GetConsensusUpdateTopic().GetAutoRenewPeriod())
return &TopicUpdateTransaction{
Transaction: tx,
topicID: _TopicIDFromProtobuf(pb.GetConsensusUpdateTopic().GetTopicID()),
autoRenewAccountID: _AccountIDFromProtobuf(pb.GetConsensusUpdateTopic().GetAutoRenewAccount()),
adminKey: adminKey,
submitKey: submitKey,
memo: pb.GetConsensusUpdateTopic().GetMemo().Value,
autoRenewPeriod: &autoRenew,
expirationTime: &expirationTime,
}
}
// SetTopicID sets the topic to be updated.
func (tx *TopicUpdateTransaction) SetTopicID(topicID TopicID) *TopicUpdateTransaction {
tx._RequireNotFrozen()
tx.topicID = &topicID
return tx
}
// GetTopicID returns the topic to be updated.
func (tx *TopicUpdateTransaction) GetTopicID() TopicID {
if tx.topicID == nil {
return TopicID{}
}
return *tx.topicID
}
// SetAdminKey sets the key required to update/delete the topic. If unset, the key will not be changed.
//
// Setting the AdminKey to an empty KeyList will clear the adminKey.
func (tx *TopicUpdateTransaction) SetAdminKey(publicKey Key) *TopicUpdateTransaction {
tx._RequireNotFrozen()
tx.adminKey = publicKey
return tx
}
// GetAdminKey returns the key required to update/delete the topic.
func (tx *TopicUpdateTransaction) GetAdminKey() (Key, error) {
return tx.adminKey, nil
}
// SetSubmitKey will set the key allowed to submit messages to the topic. If unset, the key will not be changed.
//
// Setting the submitKey to an empty KeyList will clear the submitKey.
func (tx *TopicUpdateTransaction) SetSubmitKey(publicKey Key) *TopicUpdateTransaction {
tx._RequireNotFrozen()
tx.submitKey = publicKey
return tx
}
// GetSubmitKey returns the key allowed to submit messages to the topic.
func (tx *TopicUpdateTransaction) GetSubmitKey() (Key, error) {
return tx.submitKey, nil
}
// SetTopicMemo sets a short publicly visible memo about the topic. No guarantee of uniqueness.
func (tx *TopicUpdateTransaction) SetTopicMemo(memo string) *TopicUpdateTransaction {
tx._RequireNotFrozen()
tx.memo = memo
return tx
}
// GetTopicMemo returns the short publicly visible memo about the topic.
func (tx *TopicUpdateTransaction) GetTopicMemo() string {
return tx.memo
}
// SetExpirationTime sets the effective timestamp at (and after) which all transactions and queries
// will fail. The expirationTime may be no longer than 90 days from the timestamp of this transaction.
func (tx *TopicUpdateTransaction) SetExpirationTime(expiration time.Time) *TopicUpdateTransaction {
tx._RequireNotFrozen()
tx.expirationTime = &expiration
return tx
}
// GetExpirationTime returns the effective timestamp at (and after) which all transactions and queries will fail.
func (tx *TopicUpdateTransaction) GetExpirationTime() time.Time {
if tx.expirationTime != nil {
return *tx.expirationTime
}
return time.Time{}
}
// SetAutoRenewPeriod sets the amount of time to extend the topic's lifetime automatically at expirationTime if the
// autoRenewAccount is configured and has funds. This is limited to a maximum of 90 days (server-sIDe configuration
// which may change).
func (tx *TopicUpdateTransaction) SetAutoRenewPeriod(period time.Duration) *TopicUpdateTransaction {
tx._RequireNotFrozen()
tx.autoRenewPeriod = &period
return tx
}
// GetAutoRenewPeriod returns the amount of time to extend the topic's lifetime automatically at expirationTime if the
// autoRenewAccount is configured and has funds.
func (tx *TopicUpdateTransaction) GetAutoRenewPeriod() time.Duration {
if tx.autoRenewPeriod != nil {
return *tx.autoRenewPeriod
}
return time.Duration(0)
}
// SetAutoRenewAccountID sets the optional account to be used at the topic's expirationTime to extend the life of the
// topic. The topic lifetime will be extended up to a maximum of the autoRenewPeriod or however long the topic can be
// extended using all funds on the account (whichever is the smaller duration/amount). If specified as the default value
// (0.0.0), the autoRenewAccount will be removed.
func (tx *TopicUpdateTransaction) SetAutoRenewAccountID(autoRenewAccountID AccountID) *TopicUpdateTransaction {
tx._RequireNotFrozen()
tx.autoRenewAccountID = &autoRenewAccountID
return tx
}
// GetAutoRenewAccountID returns the optional account to be used at the topic's expirationTime to extend the life of the
// topic.
func (tx *TopicUpdateTransaction) GetAutoRenewAccountID() AccountID {
if tx.autoRenewAccountID == nil {
return AccountID{}
}
return *tx.autoRenewAccountID
}
// ClearTopicMemo explicitly clears any memo on the topic by sending an empty string as the memo
func (tx *TopicUpdateTransaction) ClearTopicMemo() *TopicUpdateTransaction {
return tx.SetTopicMemo("")
}
// ClearAdminKey explicitly clears any admin key on the topic by sending an empty key list as the key
func (tx *TopicUpdateTransaction) ClearAdminKey() *TopicUpdateTransaction {
return tx.SetAdminKey(PublicKey{nil, nil})
}
// ClearSubmitKey explicitly clears any submit key on the topic by sending an empty key list as the key
func (tx *TopicUpdateTransaction) ClearSubmitKey() *TopicUpdateTransaction {
return tx.SetSubmitKey(PublicKey{nil, nil})
}
// ClearAutoRenewAccountID explicitly clears any auto renew account ID on the topic by sending an empty accountID
func (tx *TopicUpdateTransaction) ClearAutoRenewAccountID() *TopicUpdateTransaction {
tx.autoRenewAccountID = &AccountID{}
return tx
}
// ---- Required Interfaces ---- //
// Sign uses the provided privateKey to sign the transaction.
func (tx *TopicUpdateTransaction) Sign(privateKey PrivateKey) *TopicUpdateTransaction {
tx.Transaction.Sign(privateKey)
return tx
}
// SignWithOperator signs the transaction with client's operator privateKey.
func (tx *TopicUpdateTransaction) SignWithOperator(client *Client) (*TopicUpdateTransaction, error) {
_, 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 *TopicUpdateTransaction) SignWith(
publicKey PublicKey,
signer TransactionSigner,
) *TopicUpdateTransaction {
tx.Transaction.SignWith(publicKey, signer)
return tx
}
// AddSignature adds a signature to the transaction.
func (tx *TopicUpdateTransaction) AddSignature(publicKey PublicKey, signature []byte) *TopicUpdateTransaction {
tx.Transaction.AddSignature(publicKey, signature)
return tx
}
// When execution is attempted, a single attempt will timeout when this deadline is reached. (The SDK may subsequently retry the execution.)
func (tx *TopicUpdateTransaction) SetGrpcDeadline(deadline *time.Duration) *TopicUpdateTransaction {
tx.Transaction.SetGrpcDeadline(deadline)
return tx
}
func (tx *TopicUpdateTransaction) Freeze() (*TopicUpdateTransaction, error) {
return tx.FreezeWith(nil)
}
func (tx *TopicUpdateTransaction) FreezeWith(client *Client) (*TopicUpdateTransaction, error) {
_, err := tx.Transaction.freezeWith(client, tx)
return tx, err
}
// SetMaxTransactionFee sets the max transaction fee for this TopicUpdateTransaction.
func (tx *TopicUpdateTransaction) SetMaxTransactionFee(fee Hbar) *TopicUpdateTransaction {
tx.Transaction.SetMaxTransactionFee(fee)
return tx
}
// SetRegenerateTransactionID sets if transaction IDs should be regenerated when `TRANSACTION_EXPIRED` is received
func (tx *TopicUpdateTransaction) SetRegenerateTransactionID(regenerateTransactionID bool) *TopicUpdateTransaction {
tx.Transaction.SetRegenerateTransactionID(regenerateTransactionID)
return tx
}
// SetTransactionMemo sets the memo for this TopicUpdateTransaction.
func (tx *TopicUpdateTransaction) SetTransactionMemo(memo string) *TopicUpdateTransaction {
tx.Transaction.SetTransactionMemo(memo)
return tx
}
// SetTransactionValidDuration sets the valid duration for this TopicUpdateTransaction.
func (tx *TopicUpdateTransaction) SetTransactionValidDuration(duration time.Duration) *TopicUpdateTransaction {
tx.Transaction.SetTransactionValidDuration(duration)
return tx
}
// ToBytes serialise the tx to bytes, no matter if it is signed (locked), or not
func (tx *TopicUpdateTransaction) ToBytes() ([]byte, error) {
bytes, err := tx.Transaction.toBytes(tx)
if err != nil {
return nil, err
}
return bytes, nil
}
// SetTransactionID sets the TransactionID for this TopicUpdateTransaction.
func (tx *TopicUpdateTransaction) SetTransactionID(transactionID TransactionID) *TopicUpdateTransaction {
tx.Transaction.SetTransactionID(transactionID)
return tx
}
// SetNodeAccountIDs sets the _Node AccountID for this TopicUpdateTransaction.
func (tx *TopicUpdateTransaction) SetNodeAccountIDs(nodeID []AccountID) *TopicUpdateTransaction {
tx.Transaction.SetNodeAccountIDs(nodeID)
return tx
}
// SetMaxRetry sets the max number of errors before execution will fail.
func (tx *TopicUpdateTransaction) SetMaxRetry(count int) *TopicUpdateTransaction {
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 *TopicUpdateTransaction) SetMaxBackoff(max time.Duration) *TopicUpdateTransaction {
tx.Transaction.SetMaxBackoff(max)
return tx
}
// SetMinBackoff sets the minimum amount of time to wait between retries.
func (tx *TopicUpdateTransaction) SetMinBackoff(min time.Duration) *TopicUpdateTransaction {
tx.Transaction.SetMinBackoff(min)
return tx
}
func (tx *TopicUpdateTransaction) SetLogLevel(level LogLevel) *TopicUpdateTransaction {
tx.Transaction.SetLogLevel(level)
return tx
}
func (tx *TopicUpdateTransaction) Execute(client *Client) (TransactionResponse, error) {
return tx.Transaction.execute(client, tx)
}
func (tx *TopicUpdateTransaction) Schedule() (*ScheduleCreateTransaction, error) {
return tx.Transaction.schedule(tx)
}
// ----------- Overridden functions ----------------
func (tx *TopicUpdateTransaction) getName() string {
return "TopicUpdateTransaction"
}
func (tx *TopicUpdateTransaction) validateNetworkOnIDs(client *Client) error {
if client == nil || !client.autoValidateChecksums {
return nil
}
if tx.topicID != nil {
if err := tx.topicID.ValidateChecksum(client); err != nil {
return err
}
}
if tx.autoRenewAccountID != nil {
if err := tx.autoRenewAccountID.ValidateChecksum(client); err != nil {
return err
}
}
return nil
}
func (tx *TopicUpdateTransaction) build() *services.TransactionBody {
return &services.TransactionBody{
TransactionFee: tx.transactionFee,
Memo: tx.Transaction.memo,
TransactionValidDuration: _DurationToProtobuf(tx.GetTransactionValidDuration()),
TransactionID: tx.transactionID._ToProtobuf(),
Data: &services.TransactionBody_ConsensusUpdateTopic{
ConsensusUpdateTopic: tx.buildProtoBody(),
},
}
}
func (tx *TopicUpdateTransaction) buildScheduled() (*services.SchedulableTransactionBody, error) {
return &services.SchedulableTransactionBody{
TransactionFee: tx.transactionFee,
Memo: tx.Transaction.memo,
Data: &services.SchedulableTransactionBody_ConsensusUpdateTopic{
ConsensusUpdateTopic: tx.buildProtoBody(),
},
}, nil
}
func (tx *TopicUpdateTransaction) buildProtoBody() *services.ConsensusUpdateTopicTransactionBody {
body := &services.ConsensusUpdateTopicTransactionBody{
Memo: &wrapperspb.StringValue{Value: tx.memo},
}
if tx.topicID != nil {
body.TopicID = tx.topicID._ToProtobuf()
}
if tx.autoRenewAccountID != nil {
body.AutoRenewAccount = tx.autoRenewAccountID._ToProtobuf()
}
if tx.autoRenewPeriod != nil {
body.AutoRenewPeriod = _DurationToProtobuf(*tx.autoRenewPeriod)
}
if tx.expirationTime != nil {
body.ExpirationTime = _TimeToProtobuf(*tx.expirationTime)
}
if tx.adminKey != nil {
body.AdminKey = tx.adminKey._ToProtoKey()
}
if tx.submitKey != nil {
body.SubmitKey = tx.submitKey._ToProtoKey()
}
return body
}
func (tx *TopicUpdateTransaction) getMethod(channel *_Channel) _Method {
return _Method{
transaction: channel._GetTopic().UpdateTopic,
}
}
func (tx *TopicUpdateTransaction) _ConstructScheduleProtobuf() (*services.SchedulableTransactionBody, error) {
return tx.buildScheduled()
}