Skip to content

Commit

Permalink
docs: document SetMaxTransactionFee, SetTransactionMemo, SetTransacti…
Browse files Browse the repository at this point in the history
…onValidDuration, SetTransactionID everywhere
  • Loading branch information
qtbeee authored and janaakhterov committed Jul 24, 2020
1 parent f28a50d commit d6fca5b
Show file tree
Hide file tree
Showing 22 changed files with 106 additions and 17 deletions.
4 changes: 4 additions & 0 deletions account_create_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -101,18 +101,22 @@ func (builder AccountCreateTransaction) SetReceiverSignatureRequired(required bo
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder AccountCreateTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) AccountCreateTransaction {
return AccountCreateTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder AccountCreateTransaction) SetTransactionMemo(memo string) AccountCreateTransaction {
return AccountCreateTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder AccountCreateTransaction) SetTransactionValidDuration(validDuration time.Duration) AccountCreateTransaction {
return AccountCreateTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder AccountCreateTransaction) SetTransactionID(transactionID TransactionID) AccountCreateTransaction {
return AccountCreateTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
7 changes: 6 additions & 1 deletion account_delete_transaction.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
package hedera

import (
"github.com/hashgraph/hedera-sdk-go/proto"
"time"

"github.com/hashgraph/hedera-sdk-go/proto"
)

// AccountDeleteTransaction marks an account as deleted, moving all its current hbars to another account. It will remain
Expand Down Expand Up @@ -43,18 +44,22 @@ func (builder AccountDeleteTransaction) SetTransferAccountID(id AccountID) Accou
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder AccountDeleteTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) AccountDeleteTransaction {
return AccountDeleteTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder AccountDeleteTransaction) SetTransactionMemo(memo string) AccountDeleteTransaction {
return AccountDeleteTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder AccountDeleteTransaction) SetTransactionValidDuration(validDuration time.Duration) AccountDeleteTransaction {
return AccountDeleteTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder AccountDeleteTransaction) SetTransactionID(transactionID TransactionID) AccountDeleteTransaction {
return AccountDeleteTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
7 changes: 6 additions & 1 deletion account_update_transaction.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
package hedera

import (
"github.com/hashgraph/hedera-sdk-go/proto"
"time"

"github.com/hashgraph/hedera-sdk-go/proto"
)

// AccountUpdateTransaction changes properties for the given account. Any unset field is left unchanged. This
Expand Down Expand Up @@ -96,18 +97,22 @@ func (builder AccountUpdateTransaction) SetReceiveRecordThreshold(threshold Hbar
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder AccountUpdateTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) AccountUpdateTransaction {
return AccountUpdateTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder AccountUpdateTransaction) SetTransactionMemo(memo string) AccountUpdateTransaction {
return AccountUpdateTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder AccountUpdateTransaction) SetTransactionValidDuration(validDuration time.Duration) AccountUpdateTransaction {
return AccountUpdateTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder AccountUpdateTransaction) SetTransactionID(transactionID TransactionID) AccountUpdateTransaction {
return AccountUpdateTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
4 changes: 2 additions & 2 deletions consensus_message_submit_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,8 @@ func (builder ConsensusMessageSubmitTransaction) SetMaxTransactionFee(maxTransac
}
}

// SetMemo sets the memo for this Transaction.
func (builder ConsensusMessageSubmitTransaction) SetMemo(memo string) ConsensusMessageSubmitTransaction {
// SetTransactionMemo sets the memo for this Transaction.
func (builder ConsensusMessageSubmitTransaction) SetTransactionMemo(memo string) ConsensusMessageSubmitTransaction {
return ConsensusMessageSubmitTransaction{builder.TransactionBuilder.SetTransactionMemo(memo),
builder.pb,
builder.maxChunks,
Expand Down
6 changes: 5 additions & 1 deletion consensus_topic_create_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,18 +67,22 @@ func (builder ConsensusTopicCreateTransaction) SetAutoRenewAccountID(id AccountI
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder ConsensusTopicCreateTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) ConsensusTopicCreateTransaction {
return ConsensusTopicCreateTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

func (builder ConsensusTopicCreateTransaction) SetMemo(memo string) ConsensusTopicCreateTransaction {
// SetTransactionMemo sets the memo for this Transaction.
func (builder ConsensusTopicCreateTransaction) SetTransactionMemo(memo string) ConsensusTopicCreateTransaction {
return ConsensusTopicCreateTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder ConsensusTopicCreateTransaction) SetTransactionValidDuration(validDuration time.Duration) ConsensusTopicCreateTransaction {
return ConsensusTopicCreateTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder ConsensusTopicCreateTransaction) SetTransactionID(transactionID TransactionID) ConsensusTopicCreateTransaction {
return ConsensusTopicCreateTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
6 changes: 5 additions & 1 deletion consensus_topic_delete_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,22 @@ func (builder ConsensusTopicDeleteTransaction) SetTopicID(id ConsensusTopicID) C
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder ConsensusTopicDeleteTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) ConsensusTopicDeleteTransaction {
return ConsensusTopicDeleteTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

func (builder ConsensusTopicDeleteTransaction) SetMemo(memo string) ConsensusTopicDeleteTransaction {
// SetTransactionMemo sets the memo for this Transaction.
func (builder ConsensusTopicDeleteTransaction) SetTransactionMemo(memo string) ConsensusTopicDeleteTransaction {
return ConsensusTopicDeleteTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder ConsensusTopicDeleteTransaction) SetTransactionValidDuration(validDuration time.Duration) ConsensusTopicDeleteTransaction {
return ConsensusTopicDeleteTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder ConsensusTopicDeleteTransaction) SetTransactionID(transactionID TransactionID) ConsensusTopicDeleteTransaction {
return ConsensusTopicDeleteTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
6 changes: 5 additions & 1 deletion consensus_topic_update_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -105,18 +105,22 @@ func (builder ConsensusTopicUpdateTransaction) ClearAutoRenewAccountID() Consens
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder ConsensusTopicUpdateTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) ConsensusTopicUpdateTransaction {
return ConsensusTopicUpdateTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

func (builder ConsensusTopicUpdateTransaction) SetMemo(memo string) ConsensusTopicUpdateTransaction {
// SetTransactionMemo sets the memo for this Transaction.
func (builder ConsensusTopicUpdateTransaction) SetTransactionMemo(memo string) ConsensusTopicUpdateTransaction {
return ConsensusTopicUpdateTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder ConsensusTopicUpdateTransaction) SetTransactionValidDuration(validDuration time.Duration) ConsensusTopicUpdateTransaction {
return ConsensusTopicUpdateTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder ConsensusTopicUpdateTransaction) SetTransactionID(transactionID TransactionID) ConsensusTopicUpdateTransaction {
return ConsensusTopicUpdateTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
4 changes: 4 additions & 0 deletions contract_create_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,18 +126,22 @@ func (builder ContractCreateTransaction) SetConstructorParams(params *ContractFu
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder ContractCreateTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) ContractCreateTransaction {
return ContractCreateTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder ContractCreateTransaction) SetTransactionMemo(memo string) ContractCreateTransaction {
return ContractCreateTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder ContractCreateTransaction) SetTransactionValidDuration(validDuration time.Duration) ContractCreateTransaction {
return ContractCreateTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder ContractCreateTransaction) SetTransactionID(transactionID TransactionID) ContractCreateTransaction {
return ContractCreateTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
7 changes: 6 additions & 1 deletion contract_delete_transaction.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
package hedera

import (
"github.com/hashgraph/hedera-sdk-go/proto"
"time"

"github.com/hashgraph/hedera-sdk-go/proto"
)

type ContractDeleteTransaction struct {
Expand Down Expand Up @@ -51,18 +52,22 @@ func (builder ContractDeleteTransaction) SetTransferContractID(id ContractID) Co
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder ContractDeleteTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) ContractDeleteTransaction {
return ContractDeleteTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder ContractDeleteTransaction) SetTransactionMemo(memo string) ContractDeleteTransaction {
return ContractDeleteTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder ContractDeleteTransaction) SetTransactionValidDuration(validDuration time.Duration) ContractDeleteTransaction {
return ContractDeleteTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder ContractDeleteTransaction) SetTransactionID(transactionID TransactionID) ContractDeleteTransaction {
return ContractDeleteTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
4 changes: 4 additions & 0 deletions contract_execute_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,18 +64,22 @@ func (builder ContractExecuteTransaction) SetFunction(name string, params *Contr
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder ContractExecuteTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) ContractExecuteTransaction {
return ContractExecuteTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder ContractExecuteTransaction) SetTransactionMemo(memo string) ContractExecuteTransaction {
return ContractExecuteTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder ContractExecuteTransaction) SetTransactionValidDuration(validDuration time.Duration) ContractExecuteTransaction {
return ContractExecuteTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder ContractExecuteTransaction) SetTransactionID(transactionID TransactionID) ContractExecuteTransaction {
return ContractExecuteTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
7 changes: 6 additions & 1 deletion contract_update_transaction.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
package hedera

import (
"github.com/hashgraph/hedera-sdk-go/proto"
"time"

"github.com/hashgraph/hedera-sdk-go/proto"
)

// ContractUpdateTransaction is used to modify a smart contract instance to have the given parameter values. Any nil
Expand Down Expand Up @@ -91,18 +92,22 @@ func (builder ContractUpdateTransaction) SetContractMemo(memo string) ContractUp
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder ContractUpdateTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) ContractUpdateTransaction {
return ContractUpdateTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder ContractUpdateTransaction) SetTransactionMemo(memo string) ContractUpdateTransaction {
return ContractUpdateTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder ContractUpdateTransaction) SetTransactionValidDuration(validDuration time.Duration) ContractUpdateTransaction {
return ContractUpdateTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder ContractUpdateTransaction) SetTransactionID(transactionID TransactionID) ContractUpdateTransaction {
return ContractUpdateTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
4 changes: 4 additions & 0 deletions crypto_transfer_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,22 @@ func (builder CryptoTransferTransaction) AddTransfer(id AccountID, amount Hbar)
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder CryptoTransferTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) CryptoTransferTransaction {
return CryptoTransferTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder CryptoTransferTransaction) SetTransactionMemo(memo string) CryptoTransferTransaction {
return CryptoTransferTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder CryptoTransferTransaction) SetTransactionValidDuration(validDuration time.Duration) CryptoTransferTransaction {
return CryptoTransferTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder CryptoTransferTransaction) SetTransactionID(transactionID TransactionID) CryptoTransferTransaction {
return CryptoTransferTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
7 changes: 6 additions & 1 deletion file_append_transaction.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
package hedera

import (
"github.com/hashgraph/hedera-sdk-go/proto"
"time"

"github.com/hashgraph/hedera-sdk-go/proto"
)

// FileAppendTransaction appends the given contents to the end of the file. If a file is too big to create with a single
Expand Down Expand Up @@ -43,18 +44,22 @@ func (builder FileAppendTransaction) SetContents(contents []byte) FileAppendTran
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder FileAppendTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) FileAppendTransaction {
return FileAppendTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder FileAppendTransaction) SetTransactionMemo(memo string) FileAppendTransaction {
return FileAppendTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder FileAppendTransaction) SetTransactionValidDuration(validDuration time.Duration) FileAppendTransaction {
return FileAppendTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder FileAppendTransaction) SetTransactionID(transactionID TransactionID) FileAppendTransaction {
return FileAppendTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
4 changes: 4 additions & 0 deletions file_create_transaction.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,18 +72,22 @@ func (builder FileCreateTransaction) SetContents(contents []byte) FileCreateTran
// We override the embedded fluent setter methods to return the outer type
//

// SetMaxTransactionFee sets the max transaction fee for this Transaction.
func (builder FileCreateTransaction) SetMaxTransactionFee(maxTransactionFee Hbar) FileCreateTransaction {
return FileCreateTransaction{builder.TransactionBuilder.SetMaxTransactionFee(maxTransactionFee), builder.pb}
}

// SetTransactionMemo sets the memo for this Transaction.
func (builder FileCreateTransaction) SetTransactionMemo(memo string) FileCreateTransaction {
return FileCreateTransaction{builder.TransactionBuilder.SetTransactionMemo(memo), builder.pb}
}

// SetTransactionValidDuration sets the valid duration for this Transaction.
func (builder FileCreateTransaction) SetTransactionValidDuration(validDuration time.Duration) FileCreateTransaction {
return FileCreateTransaction{builder.TransactionBuilder.SetTransactionValidDuration(validDuration), builder.pb}
}

// SetTransactionID sets the TransactionID for this Transaction.
func (builder FileCreateTransaction) SetTransactionID(transactionID TransactionID) FileCreateTransaction {
return FileCreateTransaction{builder.TransactionBuilder.SetTransactionID(transactionID), builder.pb}
}
Expand Down
Loading

0 comments on commit d6fca5b

Please sign in to comment.