Tron Default Opts (#253)

Use pointers for options to support nil initialization, and raise the
default deployment parameters for better reliability.

Author: eduard-cl

.changeset/soft-dingos-worry.md

@@ -0,0 +1,5 @@
+---
+"chainlink-deployments-framework": patch
+---
+
+Refactor the Tron package options to be pointers in order to support optional configuration.

chain/tron/provider/ctf_provider.go

@@ -140,22 +140,22 @@ func (p *CTFChainProvider) Initialize(_ context.Context) (chain.BlockChain, erro
 		Address:  deployerAddr,     // Default "from" address for transactions
 		URL:      fullNodeURL,
 		// Helper for sending and confirming transactions
-		SendAndConfirm: func(ctx context.Context, tx *common.Transaction, opts ...tron.ConfirmRetryOptions) (*soliditynode.TransactionInfo, error) {
+		SendAndConfirm: func(ctx context.Context, tx *common.Transaction, opts *tron.ConfirmRetryOptions) (*soliditynode.TransactionInfo, error) {
 			options := tron.DefaultConfirmRetryOptions()
-			if len(opts) > 0 {
-				options = opts[0]
+			if opts != nil {
+				options = opts
 			}
 
 			// Send transaction and wait for confirmation
 			return client.SendAndConfirmTx(ctx, tx, options)
 		},
 		// Helper for deploying a contract and waiting for confirmation
 		DeployContractAndConfirm: func(
-			ctx context.Context, contractName string, abi string, bytecode string, params []interface{}, opts ...tron.DeployOptions,
+			ctx context.Context, contractName string, abi string, bytecode string, params []interface{}, opts *tron.DeployOptions,
 		) (address.Address, *soliditynode.TransactionInfo, error) {
 			options := tron.DefaultDeployOptions()
-			if len(opts) > 0 {
-				options = opts[0]
+			if opts != nil {
+				options = opts
 			}
 
 			// Create deploy contract transaction
@@ -187,11 +187,11 @@ func (p *CTFChainProvider) Initialize(_ context.Context) (chain.BlockChain, erro
 		},
 		// Helper for triggering a contract method and waiting for confirmation
 		TriggerContractAndConfirm: func(
-			ctx context.Context, contractAddr address.Address, functionName string, params []interface{}, opts ...tron.TriggerOptions,
+			ctx context.Context, contractAddr address.Address, functionName string, params []interface{}, opts *tron.TriggerOptions,
 		) (*soliditynode.TransactionInfo, error) {
 			options := tron.DefaultTriggerOptions()
-			if len(opts) > 0 {
-				options = opts[0]
+			if opts != nil {
+				options = opts
 			}
 
 			// Ensure contract is actually deployed on-chain

chain/tron/provider/rpc_provider.go

@@ -106,22 +106,22 @@ func (p *RPCChainProvider) Initialize(ctx context.Context) (chain.BlockChain, er
 		Address:  deployerAddr,     // Default "from" address for transactions
 		URL:      p.config.FullNodeURL,
 		// Helper for sending and confirming transactions
-		SendAndConfirm: func(ctx context.Context, tx *common.Transaction, opts ...tron.ConfirmRetryOptions) (*soliditynode.TransactionInfo, error) {
+		SendAndConfirm: func(ctx context.Context, tx *common.Transaction, opts *tron.ConfirmRetryOptions) (*soliditynode.TransactionInfo, error) {
 			options := tron.DefaultConfirmRetryOptions()
-			if len(opts) > 0 {
-				options = opts[0]
+			if opts != nil {
+				options = opts
 			}
 
 			// Send transaction and wait for confirmation
 			return client.SendAndConfirmTx(ctx, tx, options)
 		},
 		// Helper for deploying a contract and waiting for confirmation
 		DeployContractAndConfirm: func(
-			ctx context.Context, contractName string, abi string, bytecode string, params []interface{}, opts ...tron.DeployOptions,
+			ctx context.Context, contractName string, abi string, bytecode string, params []interface{}, opts *tron.DeployOptions,
 		) (address.Address, *soliditynode.TransactionInfo, error) {
 			options := tron.DefaultDeployOptions()
-			if len(opts) > 0 {
-				options = opts[0]
+			if opts != nil {
+				options = opts
 			}
 
 			// Create deploy contract transaction
@@ -153,11 +153,11 @@ func (p *RPCChainProvider) Initialize(ctx context.Context) (chain.BlockChain, er
 		},
 		// Helper for triggering a contract method and waiting for confirmation
 		TriggerContractAndConfirm: func(
-			ctx context.Context, contractAddr address.Address, functionName string, params []interface{}, opts ...tron.TriggerOptions,
+			ctx context.Context, contractAddr address.Address, functionName string, params []interface{}, opts *tron.TriggerOptions,
 		) (*soliditynode.TransactionInfo, error) {
 			options := tron.DefaultTriggerOptions()
-			if len(opts) > 0 {
-				options = opts[0]
+			if opts != nil {
+				options = opts
 			}
 
 			// Ensure contract is actually deployed on-chain

chain/tron/provider/rpcclient/client.go

@@ -19,7 +19,7 @@ import (
 
 // confirmRetryOpts returns the retry options for confirming transactions.
 // It wraps a context and sets retry count and delay based on provided config.
-func confirmRetryOpts(ctx context.Context, c tron.ConfirmRetryOptions) []retry.Option {
+func confirmRetryOpts(ctx context.Context, c *tron.ConfirmRetryOptions) []retry.Option {
 	return []retry.Option{
 		retry.Context(ctx),
 		retry.Attempts(c.RetryAttempts),
@@ -53,12 +53,12 @@ func New(client sdk.FullNodeClient, keystore *keystore.Keystore, account address
 func (c *Client) SendAndConfirmTx(
 	ctx context.Context,
 	tx *common.Transaction,
-	opts ...tron.ConfirmRetryOptions,
+	opts *tron.ConfirmRetryOptions,
 ) (*soliditynode.TransactionInfo, error) {
 	// Initialize the configuration with defaults or provided options.
 	option := tron.DefaultConfirmRetryOptions()
-	if len(opts) > 0 {
-		option = opts[0]
+	if opts != nil {
+		option = opts
 	}
 
 	// Decode the TxID from hex into bytes, required for signing

chain/tron/provider/rpcclient/client_test.go

@@ -30,7 +30,7 @@ func TestConfirmRetryOpts_DefaultsAndOverrides(t *testing.T) {
 	require.True(t, hasCtx)
 
 	// Test with custom options
-	customOpts := confirmRetryOpts(ctx, tron.ConfirmRetryOptions{
+	customOpts := confirmRetryOpts(ctx, &tron.ConfirmRetryOptions{
 		RetryAttempts: 3,
 		RetryDelay:    50 * time.Millisecond,
 	})

chain/tron/tron_chain.go

@@ -24,17 +24,17 @@ type ConfirmRetryOptions struct {
 
 // DeployOptions defines optional parameters for deploying a smart contract.
 type DeployOptions struct {
-	OeLimit             int                 // Max energy the creator is willing to provide during execution.
-	CurPercent          int                 // Percentage of resource consumption charged to the contract caller (0–100).
-	FeeLimit            int                 // Max TRX to be used for deploying the contract (gas limit in Tron terms).
-	ConfirmRetryOptions ConfirmRetryOptions // Retry options for confirming the transaction.
+	OeLimit             int                  // Max energy the creator is willing to provide during execution.
+	CurPercent          int                  // Percentage of resource consumption charged to the contract caller (0–100).
+	FeeLimit            int                  // Max TRX to be used for deploying the contract (gas limit in Tron terms).
+	ConfirmRetryOptions *ConfirmRetryOptions // Retry options for confirming the transaction.
 }
 
 // TriggerOptions defines optional parameters for triggering (calling) a smart contract.
 type TriggerOptions struct {
-	FeeLimit            int32               // Max TRX to be used for this transaction call.
-	TAmount             int64               // Amount of TRX to transfer along with the contract call (like msg.value).
-	ConfirmRetryOptions ConfirmRetryOptions // Retry options for confirming the transaction.
+	FeeLimit            int32                // Max TRX to be used for this transaction call.
+	TAmount             int64                // Amount of TRX to transfer along with the contract call (like msg.value).
+	ConfirmRetryOptions *ConfirmRetryOptions // Retry options for confirming the transaction.
 }
 
 // Chain represents a Tron chain
@@ -47,43 +47,43 @@ type Chain struct {
 	DeployerSeed  string             // Optional: mnemonic or raw seed
 
 	// SendAndConfirm provides a utility function to send a transaction and waits for confirmation.
-	SendAndConfirm func(ctx context.Context, tx *common.Transaction, opts ...ConfirmRetryOptions) (*soliditynode.TransactionInfo, error)
+	SendAndConfirm func(ctx context.Context, tx *common.Transaction, opts *ConfirmRetryOptions) (*soliditynode.TransactionInfo, error)
 
 	// DeployContractAndConfirm provides a utility function to deploy a contract and waits for confirmation.
 	DeployContractAndConfirm func(
-		ctx context.Context, contractName string, abi string, bytecode string, params []interface{}, opts ...DeployOptions,
+		ctx context.Context, contractName string, abi string, bytecode string, params []interface{}, opts *DeployOptions,
 	) (address.Address, *soliditynode.TransactionInfo, error)
 
 	// TriggerContractAndConfim provides a utility function to send a contract transaction and waits for confirmation.
 	TriggerContractAndConfirm func(
-		ctx context.Context, contractAddr address.Address, functionName string, params []interface{}, opts ...TriggerOptions,
+		ctx context.Context, contractAddr address.Address, functionName string, params []interface{}, opts *TriggerOptions,
 	) (*soliditynode.TransactionInfo, error)
 }
 
 // DefaultConfirmRetryOptions returns standard retry options used across contract deployment and invocation.
 // Defaults to 180 retries with a 500ms delay between each attempt.
-func DefaultConfirmRetryOptions() ConfirmRetryOptions {
-	return ConfirmRetryOptions{
+func DefaultConfirmRetryOptions() *ConfirmRetryOptions {
+	return &ConfirmRetryOptions{
 		RetryAttempts: 180,
 		RetryDelay:    500 * time.Millisecond,
 	}
 }
 
 // DefaultDeployOptions returns default options used when deploying a contract.
 // It includes a high fee and energy limit suitable for development/testing, and standard retry behavior.
-func DefaultDeployOptions() DeployOptions {
-	return DeployOptions{
-		FeeLimit:            10_000_000, // Default fee limit (in SUN).
-		CurPercent:          100,        // Caller pays full cost.
-		OeLimit:             10_000_000, // Default energy limit.
+func DefaultDeployOptions() *DeployOptions {
+	return &DeployOptions{
+		FeeLimit:            100_000_000, // Default fee limit (in SUN).
+		CurPercent:          100,         // Caller pays full cost.
+		OeLimit:             50_000_000,  // Default energy limit.
 		ConfirmRetryOptions: DefaultConfirmRetryOptions(),
 	}
 }
 
 // DefaultTriggerOptions returns default options for calling smart contract methods.
 // These defaults ensure calls succeed on local/dev environments without TRX transfer.
-func DefaultTriggerOptions() TriggerOptions {
-	return TriggerOptions{
+func DefaultTriggerOptions() *TriggerOptions {
+	return &TriggerOptions{
 		FeeLimit:            10_000_000, // Default fee limit (in SUN).
 		TAmount:             0,          // No TRX transferred by default.
 		ConfirmRetryOptions: DefaultConfirmRetryOptions(),

chain/tron/tron_chain_test.go

@@ -57,9 +57,9 @@ func Test_DefaultOptions(t *testing.T) {
 	t.Run("DefaultDeployOptions", func(t *testing.T) {
 		t.Parallel()
 		opts := tron.DefaultDeployOptions()
-		assert.Equal(t, 10_000_000, opts.FeeLimit)
+		assert.Equal(t, 100_000_000, opts.FeeLimit)
 		assert.Equal(t, 100, opts.CurPercent)
-		assert.Equal(t, 10_000_000, opts.OeLimit)
+		assert.Equal(t, 50_000_000, opts.OeLimit)
 		assert.Equal(t, tron.DefaultConfirmRetryOptions(), opts.ConfirmRetryOptions)
 	})