feat(transaction): Added fee override

robdmoore · robdmoore · commit d16704f6a811 · 2023-03-22T13:42:16.000+08:00
diff --git a/docs/code/interfaces/types_app.AppCallParams.md b/docs/code/interfaces/types_app.AppCallParams.md
@@ -19,6 +19,7 @@ The sending configuration for a transaction
 - [appId](types_app.AppCallParams.md#appid)
 - [args](types_app.AppCallParams.md#args)
 - [callType](types_app.AppCallParams.md#calltype)
+- [fee](types_app.AppCallParams.md#fee)
 - [from](types_app.AppCallParams.md#from)
 - [maxFee](types_app.AppCallParams.md#maxfee)
 - [maxRoundsToWaitForConfirmation](types_app.AppCallParams.md#maxroundstowaitforconfirmation)
@@ -66,6 +67,22 @@ The type of call, everything except create (@see createApp ) and update (@see up
 
 ___
 
+### fee
+
+• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
+
+The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
+
+#### Inherited from
+
+[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee)
+
+#### Defined in
+
+[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+
+___
+
 ### from
 
 • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom)
@@ -90,7 +107,7 @@ The maximum fee that you are happy to pay (default: unbounded) - if this is set
 
 #### Defined in
 
-[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
 
 ___
 
@@ -106,7 +123,7 @@ The maximum number of rounds to wait for confirmation, only applies if `skipWait
 
 #### Defined in
 
-[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
+[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36)
 
 ___
 
diff --git a/docs/code/interfaces/types_app.AppCallTransactionResult.md b/docs/code/interfaces/types_app.AppCallTransactionResult.md
@@ -34,7 +34,7 @@ The response if the transaction was sent and waited for
 
 #### Defined in
 
-[types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42)
+[types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44)
 
 ___
 
@@ -62,4 +62,4 @@ The transaction
 
 #### Defined in
 
-[types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40)
+[types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42)
diff --git a/docs/code/interfaces/types_app.AppDeploymentParams.md b/docs/code/interfaces/types_app.AppDeploymentParams.md
@@ -22,6 +22,7 @@ The parameters to deploy an app
 - [deleteArgs](types_app.AppDeploymentParams.md#deleteargs)
 - [deployTimeParameters](types_app.AppDeploymentParams.md#deploytimeparameters)
 - [existingDeployments](types_app.AppDeploymentParams.md#existingdeployments)
+- [fee](types_app.AppDeploymentParams.md#fee)
 - [from](types_app.AppDeploymentParams.md#from)
 - [maxFee](types_app.AppDeploymentParams.md#maxfee)
 - [maxRoundsToWaitForConfirmation](types_app.AppDeploymentParams.md#maxroundstowaitforconfirmation)
@@ -115,6 +116,22 @@ Optional cached value of the existing apps for the given creator
 
 ___
 
+### fee
+
+• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
+
+The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
+
+#### Inherited from
+
+Omit.fee
+
+#### Defined in
+
+[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+
+___
+
 ### from
 
 • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom)
@@ -143,7 +160,7 @@ Omit.maxFee
 
 #### Defined in
 
-[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
 
 ___
 
@@ -159,7 +176,7 @@ Omit.maxRoundsToWaitForConfirmation
 
 #### Defined in
 
-[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
+[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36)
 
 ___
 
diff --git a/docs/code/interfaces/types_app.CreateAppParams.md b/docs/code/interfaces/types_app.CreateAppParams.md
@@ -19,6 +19,7 @@ Parameters that are passed in when creating an app.
 - [approvalProgram](types_app.CreateAppParams.md#approvalprogram)
 - [args](types_app.CreateAppParams.md#args)
 - [clearStateProgram](types_app.CreateAppParams.md#clearstateprogram)
+- [fee](types_app.CreateAppParams.md#fee)
 - [from](types_app.CreateAppParams.md#from)
 - [maxFee](types_app.CreateAppParams.md#maxfee)
 - [maxRoundsToWaitForConfirmation](types_app.CreateAppParams.md#maxroundstowaitforconfirmation)
@@ -79,6 +80,22 @@ CreateOrUpdateAppParams.clearStateProgram
 
 ___
 
+### fee
+
+• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
+
+The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
+
+#### Inherited from
+
+CreateOrUpdateAppParams.fee
+
+#### Defined in
+
+[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+
+___
+
 ### from
 
 • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom)
@@ -107,7 +124,7 @@ CreateOrUpdateAppParams.maxFee
 
 #### Defined in
 
-[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
 
 ___
 
@@ -123,7 +140,7 @@ CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation
 
 #### Defined in
 
-[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
+[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36)
 
 ___
 
diff --git a/docs/code/interfaces/types_app.UpdateAppParams.md b/docs/code/interfaces/types_app.UpdateAppParams.md
@@ -20,6 +20,7 @@ Parameters that are passed in when updating an app.
 - [approvalProgram](types_app.UpdateAppParams.md#approvalprogram)
 - [args](types_app.UpdateAppParams.md#args)
 - [clearStateProgram](types_app.UpdateAppParams.md#clearstateprogram)
+- [fee](types_app.UpdateAppParams.md#fee)
 - [from](types_app.UpdateAppParams.md#from)
 - [maxFee](types_app.UpdateAppParams.md#maxfee)
 - [maxRoundsToWaitForConfirmation](types_app.UpdateAppParams.md#maxroundstowaitforconfirmation)
@@ -91,6 +92,22 @@ CreateOrUpdateAppParams.clearStateProgram
 
 ___
 
+### fee
+
+• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
+
+The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
+
+#### Inherited from
+
+CreateOrUpdateAppParams.fee
+
+#### Defined in
+
+[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+
+___
+
 ### from
 
 • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom)
@@ -119,7 +136,7 @@ CreateOrUpdateAppParams.maxFee
 
 #### Defined in
 
-[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
 
 ___
 
@@ -135,7 +152,7 @@ CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation
 
 #### Defined in
 
-[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
+[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36)
 
 ___
 
diff --git a/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md b/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md
@@ -33,7 +33,7 @@ The response if the transaction was sent and waited for
 
 #### Defined in
 
-[types/transaction.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L48)
+[types/transaction.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L50)
 
 ___
 
@@ -49,4 +49,4 @@ The transaction
 
 #### Defined in
 
-[types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40)
+[types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42)
diff --git a/docs/code/interfaces/types_transaction.SendTransactionParams.md b/docs/code/interfaces/types_transaction.SendTransactionParams.md
@@ -18,6 +18,7 @@ The sending configuration for a transaction
 
 ### Properties
 
+- [fee](types_transaction.SendTransactionParams.md#fee)
 - [maxFee](types_transaction.SendTransactionParams.md#maxfee)
 - [maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation)
 - [skipSending](types_transaction.SendTransactionParams.md#skipsending)
@@ -26,6 +27,18 @@ The sending configuration for a transaction
 
 ## Properties
 
+### fee
+
+• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
+
+The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
+
+#### Defined in
+
+[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+
+___
+
 ### maxFee
 
 • `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
@@ -34,7 +47,7 @@ The maximum fee that you are happy to pay (default: unbounded) - if this is set
 
 #### Defined in
 
-[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
 
 ___
 
@@ -46,7 +59,7 @@ The maximum number of rounds to wait for confirmation, only applies if `skipWait
 
 #### Defined in
 
-[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
+[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36)
 
 ___
 
diff --git a/docs/code/interfaces/types_transaction.SendTransactionResult.md b/docs/code/interfaces/types_transaction.SendTransactionResult.md
@@ -31,7 +31,7 @@ The response if the transaction was sent and waited for
 
 #### Defined in
 
-[types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42)
+[types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44)
 
 ___
 
@@ -43,4 +43,4 @@ The transaction
 
 #### Defined in
 
-[types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40)
+[types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42)
diff --git a/docs/code/interfaces/types_transaction.TransactionToSign.md b/docs/code/interfaces/types_transaction.TransactionToSign.md
@@ -23,7 +23,7 @@ The account to use to sign the transaction, either an account (with private key
 
 #### Defined in
 
-[types/transaction.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L58)
+[types/transaction.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L60)
 
 ___
 
@@ -35,4 +35,4 @@ The unsigned transaction to sign and send
 
 #### Defined in
 
-[types/transaction.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L56)
+[types/transaction.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L58)
diff --git a/docs/code/interfaces/types_transfer.AlgoTransferParams.md b/docs/code/interfaces/types_transfer.AlgoTransferParams.md
@@ -17,6 +17,7 @@ The sending configuration for a transaction
 ### Properties
 
 - [amount](types_transfer.AlgoTransferParams.md#amount)
+- [fee](types_transfer.AlgoTransferParams.md#fee)
 - [from](types_transfer.AlgoTransferParams.md#from)
 - [maxFee](types_transfer.AlgoTransferParams.md#maxfee)
 - [maxRoundsToWaitForConfirmation](types_transfer.AlgoTransferParams.md#maxroundstowaitforconfirmation)
@@ -41,6 +42,22 @@ The amount to send
 
 ___
 
+### fee
+
+• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)
+
+The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
+
+#### Inherited from
+
+[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee)
+
+#### Defined in
+
+[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+
+___
+
 ### from
 
 • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom)
@@ -65,7 +82,7 @@ The maximum fee that you are happy to pay (default: unbounded) - if this is set
 
 #### Defined in
 
-[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32)
+[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
 
 ___
 
@@ -81,7 +98,7 @@ The maximum number of rounds to wait for confirmation, only applies if `skipWait
 
 #### Defined in
 
-[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34)
+[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36)
 
 ___
 
diff --git a/docs/code/modules/index.md b/docs/code/modules/index.md
@@ -145,7 +145,7 @@ the estimated rate.
 
 #### Defined in
 
-[transaction.ts:261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L261)
+[transaction.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L267)
 
 ___
 
@@ -961,7 +961,7 @@ The suggested transaction parameters
 
 #### Defined in
 
-[transaction.ts:285](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L285)
+[transaction.ts:291](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L291)
 
 ___
 
@@ -1311,7 +1311,7 @@ An object with group transaction ID (`groupTransactionId`) and (if `skipWaiting`
 
 #### Defined in
 
-[transaction.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L109)
+[transaction.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L115)
 
 ___
 
@@ -1449,4 +1449,4 @@ Pending transaction information
 
 #### Defined in
 
-[transaction.ts:214](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L214)
+[transaction.ts:220](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L220)
diff --git a/docs/code/modules/types_transaction.md b/docs/code/modules/types_transaction.md
@@ -42,7 +42,7 @@ ___
 
 #### Defined in
 
-[types/transaction.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L51)
+[types/transaction.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L53)
 
 ___
 
diff --git a/src/transaction.spec.ts b/src/transaction.spec.ts
diff --git a/src/transaction.ts b/src/transaction.ts
diff --git a/src/types/transaction.ts b/src/types/transaction.ts
