From 65b618dae92fbf9b336802946be59b7afe46d227 Mon Sep 17 00:00:00 2001 From: Joe Polny Date: Fri, 21 Jun 2024 12:30:57 -0400 Subject: [PATCH 1/3] feat: add fv and lv to SendTransactionParams --- src/transaction/transaction.ts | 3 +++ src/types/transaction.ts | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/src/transaction/transaction.ts b/src/transaction/transaction.ts index 3a7f024f..89c96120 100644 --- a/src/transaction/transaction.ts +++ b/src/transaction/transaction.ts @@ -194,6 +194,9 @@ export const sendTransaction = async function ( const { transaction, from, sendParams } = send const { skipSending, skipWaiting, fee, maxFee, suppressLog, maxRoundsToWaitForConfirmation, atc } = sendParams ?? {} + if (sendParams?.firstValid) transaction.firstRound = sendParams.firstValid + if (sendParams?.lastValid) transaction.lastRound = sendParams.lastValid + controlFees(transaction, { fee, maxFee }) if (atc) { diff --git a/src/types/transaction.ts b/src/types/transaction.ts index f04d9426..58cf4f4c 100644 --- a/src/types/transaction.ts +++ b/src/types/transaction.ts @@ -43,6 +43,10 @@ export interface SendTransactionParams { maxRoundsToWaitForConfirmation?: number /** **WARNING**: Not recommended for production use due to https://github.com/algorand/go-algorand/issues/5914. Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. */ populateAppCallResources?: boolean + /** The first round this transaction will be valid */ + firstValid?: number + /** The last round this transaction will be valid */ + lastValid?: number } /** The result of sending a transaction */ From ae74ecd4ad0a3a3e59580bc66bc1c467d8a3a70e Mon Sep 17 00:00:00 2001 From: Joe Polny Date: Fri, 21 Jun 2024 12:31:17 -0400 Subject: [PATCH 2/3] generate docs --- .../interfaces/types_app.AppCallParams.md | 34 +++++++++++++++++++ .../types_app.AppCallTransactionResult.md | 8 ++--- ...ypes_app.AppCallTransactionResultOfType.md | 8 ++--- .../types_app.AppDeploymentParams.md | 34 +++++++++++++++++++ .../interfaces/types_app.CreateAppParams.md | 34 +++++++++++++++++++ .../interfaces/types_app.UpdateAppParams.md | 34 +++++++++++++++++++ .../types_asset.AssetOptInParams.md | 34 +++++++++++++++++++ .../types_asset.AssetOptOutParams.md | 34 +++++++++++++++++++ .../types_asset.CreateAssetParams.md | 34 +++++++++++++++++++ ...saction.AtomicTransactionComposerToSend.md | 4 +-- ..._transaction.ConfirmedTransactionResult.md | 4 +-- ...transaction.ConfirmedTransactionResults.md | 8 ++--- ...on.SendAtomicTransactionComposerResults.md | 10 +++--- ...types_transaction.SendTransactionParams.md | 26 ++++++++++++++ ...types_transaction.SendTransactionResult.md | 4 +-- ...ypes_transaction.SendTransactionResults.md | 4 +-- ...ypes_transaction.TransactionGroupToSend.md | 6 ++-- .../types_transaction.TransactionToSign.md | 4 +-- .../types_transfer.AlgoRekeyParams.md | 34 +++++++++++++++++++ .../types_transfer.AlgoTransferParams.md | 34 +++++++++++++++++++ .../types_transfer.EnsureFundedParams.md | 34 +++++++++++++++++++ .../types_transfer.TransferAssetParams.md | 34 +++++++++++++++++++ docs/code/modules/index.md | 18 +++++----- docs/code/modules/types_transaction.md | 2 +- 24 files changed, 440 insertions(+), 40 deletions(-) diff --git a/docs/code/interfaces/types_app.AppCallParams.md b/docs/code/interfaces/types_app.AppCallParams.md index 9ac5dd71..a80c2168 100644 --- a/docs/code/interfaces/types_app.AppCallParams.md +++ b/docs/code/interfaces/types_app.AppCallParams.md @@ -21,7 +21,9 @@ Parameters representing a call to an app. - [atc](types_app.AppCallParams.md#atc) - [callType](types_app.AppCallParams.md#calltype) - [fee](types_app.AppCallParams.md#fee) +- [firstValid](types_app.AppCallParams.md#firstvalid) - [from](types_app.AppCallParams.md#from) +- [lastValid](types_app.AppCallParams.md#lastvalid) - [maxFee](types_app.AppCallParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_app.AppCallParams.md#maxroundstowaitforconfirmation) - [note](types_app.AppCallParams.md#note) @@ -101,6 +103,22 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[firstValid](types_transaction.SendTransactionParams.md#firstvalid) + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + ### from • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) @@ -113,6 +131,22 @@ The account to make the call from ___ +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[lastValid](types_transaction.SendTransactionParams.md#lastvalid) + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### maxFee • `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) diff --git a/docs/code/interfaces/types_app.AppCallTransactionResult.md b/docs/code/interfaces/types_app.AppCallTransactionResult.md index 7281375c..71e74527 100644 --- a/docs/code/interfaces/types_app.AppCallTransactionResult.md +++ b/docs/code/interfaces/types_app.AppCallTransactionResult.md @@ -36,7 +36,7 @@ The response if the transaction was sent and waited for #### Defined in -[src/types/transaction.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L53) +[src/types/transaction.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L57) ___ @@ -53,7 +53,7 @@ the index of the confirmation will match the index of the underlying transaction #### Defined in -[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) +[src/types/transaction.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L67) ___ @@ -85,7 +85,7 @@ The transaction #### Defined in -[src/types/transaction.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L51) +[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) ___ @@ -101,4 +101,4 @@ The transactions that have been prepared and/or sent #### Defined in -[src/types/transaction.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L59) +[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) diff --git a/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md b/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md index daced681..b2806cc8 100644 --- a/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md +++ b/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md @@ -46,7 +46,7 @@ The response if the transaction was sent and waited for #### Defined in -[src/types/transaction.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L53) +[src/types/transaction.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L57) ___ @@ -63,7 +63,7 @@ the index of the confirmation will match the index of the underlying transaction #### Defined in -[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) +[src/types/transaction.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L67) ___ @@ -91,7 +91,7 @@ The transaction #### Defined in -[src/types/transaction.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L51) +[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) ___ @@ -107,4 +107,4 @@ The transactions that have been prepared and/or sent #### Defined in -[src/types/transaction.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L59) +[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) diff --git a/docs/code/interfaces/types_app.AppDeploymentParams.md b/docs/code/interfaces/types_app.AppDeploymentParams.md index 903652dc..cf9abb12 100644 --- a/docs/code/interfaces/types_app.AppDeploymentParams.md +++ b/docs/code/interfaces/types_app.AppDeploymentParams.md @@ -24,7 +24,9 @@ The parameters to deploy an app - [deployTimeParams](types_app.AppDeploymentParams.md#deploytimeparams) - [existingDeployments](types_app.AppDeploymentParams.md#existingdeployments) - [fee](types_app.AppDeploymentParams.md#fee) +- [firstValid](types_app.AppDeploymentParams.md#firstvalid) - [from](types_app.AppDeploymentParams.md#from) +- [lastValid](types_app.AppDeploymentParams.md#lastvalid) - [maxFee](types_app.AppDeploymentParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_app.AppDeploymentParams.md#maxroundstowaitforconfirmation) - [metadata](types_app.AppDeploymentParams.md#metadata) @@ -146,6 +148,22 @@ Omit.fee ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +Omit.firstValid + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + ### from • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) @@ -162,6 +180,22 @@ Omit.from ___ +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +Omit.lastValid + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### maxFee • `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) diff --git a/docs/code/interfaces/types_app.CreateAppParams.md b/docs/code/interfaces/types_app.CreateAppParams.md index 4a1c2cbf..94b23faa 100644 --- a/docs/code/interfaces/types_app.CreateAppParams.md +++ b/docs/code/interfaces/types_app.CreateAppParams.md @@ -21,7 +21,9 @@ Parameters that are passed in when creating an app. - [atc](types_app.CreateAppParams.md#atc) - [clearStateProgram](types_app.CreateAppParams.md#clearstateprogram) - [fee](types_app.CreateAppParams.md#fee) +- [firstValid](types_app.CreateAppParams.md#firstvalid) - [from](types_app.CreateAppParams.md#from) +- [lastValid](types_app.CreateAppParams.md#lastvalid) - [maxFee](types_app.CreateAppParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_app.CreateAppParams.md#maxroundstowaitforconfirmation) - [note](types_app.CreateAppParams.md#note) @@ -115,6 +117,22 @@ CreateOrUpdateAppParams.fee ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +CreateOrUpdateAppParams.firstValid + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + ### from • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) @@ -131,6 +149,22 @@ CreateOrUpdateAppParams.from ___ +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +CreateOrUpdateAppParams.lastValid + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### maxFee • `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) diff --git a/docs/code/interfaces/types_app.UpdateAppParams.md b/docs/code/interfaces/types_app.UpdateAppParams.md index 09bbb2b4..66569d37 100644 --- a/docs/code/interfaces/types_app.UpdateAppParams.md +++ b/docs/code/interfaces/types_app.UpdateAppParams.md @@ -22,7 +22,9 @@ Parameters that are passed in when updating an app. - [atc](types_app.UpdateAppParams.md#atc) - [clearStateProgram](types_app.UpdateAppParams.md#clearstateprogram) - [fee](types_app.UpdateAppParams.md#fee) +- [firstValid](types_app.UpdateAppParams.md#firstvalid) - [from](types_app.UpdateAppParams.md#from) +- [lastValid](types_app.UpdateAppParams.md#lastvalid) - [maxFee](types_app.UpdateAppParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_app.UpdateAppParams.md#maxroundstowaitforconfirmation) - [note](types_app.UpdateAppParams.md#note) @@ -126,6 +128,22 @@ CreateOrUpdateAppParams.fee ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +CreateOrUpdateAppParams.firstValid + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + ### from • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) @@ -142,6 +160,22 @@ CreateOrUpdateAppParams.from ___ +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +CreateOrUpdateAppParams.lastValid + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### maxFee • `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) diff --git a/docs/code/interfaces/types_asset.AssetOptInParams.md b/docs/code/interfaces/types_asset.AssetOptInParams.md index 712bd67b..276bd34b 100644 --- a/docs/code/interfaces/types_asset.AssetOptInParams.md +++ b/docs/code/interfaces/types_asset.AssetOptInParams.md @@ -22,6 +22,8 @@ Parameters for `assetOptIn` call. - [assetId](types_asset.AssetOptInParams.md#assetid) - [atc](types_asset.AssetOptInParams.md#atc) - [fee](types_asset.AssetOptInParams.md#fee) +- [firstValid](types_asset.AssetOptInParams.md#firstvalid) +- [lastValid](types_asset.AssetOptInParams.md#lastvalid) - [lease](types_asset.AssetOptInParams.md#lease) - [maxFee](types_asset.AssetOptInParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_asset.AssetOptInParams.md#maxroundstowaitforconfirmation) @@ -90,6 +92,38 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[firstValid](types_transaction.SendTransactionParams.md#firstvalid) + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[lastValid](types_transaction.SendTransactionParams.md#lastvalid) + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### lease • `Optional` **lease**: `string` \| `Uint8Array` diff --git a/docs/code/interfaces/types_asset.AssetOptOutParams.md b/docs/code/interfaces/types_asset.AssetOptOutParams.md index c79bacfa..86343e76 100644 --- a/docs/code/interfaces/types_asset.AssetOptOutParams.md +++ b/docs/code/interfaces/types_asset.AssetOptOutParams.md @@ -22,6 +22,8 @@ Parameters for `assetOptOut` call. - [atc](types_asset.AssetOptOutParams.md#atc) - [ensureZeroBalance](types_asset.AssetOptOutParams.md#ensurezerobalance) - [fee](types_asset.AssetOptOutParams.md#fee) +- [firstValid](types_asset.AssetOptOutParams.md#firstvalid) +- [lastValid](types_asset.AssetOptOutParams.md#lastvalid) - [lease](types_asset.AssetOptOutParams.md#lease) - [maxFee](types_asset.AssetOptOutParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_asset.AssetOptOutParams.md#maxroundstowaitforconfirmation) @@ -122,6 +124,38 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +[AssetOptInParams](types_asset.AssetOptInParams.md).[firstValid](types_asset.AssetOptInParams.md#firstvalid) + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +[AssetOptInParams](types_asset.AssetOptInParams.md).[lastValid](types_asset.AssetOptInParams.md#lastvalid) + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### lease • `Optional` **lease**: `string` \| `Uint8Array` diff --git a/docs/code/interfaces/types_asset.CreateAssetParams.md b/docs/code/interfaces/types_asset.CreateAssetParams.md index efddbc12..3870e6aa 100644 --- a/docs/code/interfaces/types_asset.CreateAssetParams.md +++ b/docs/code/interfaces/types_asset.CreateAssetParams.md @@ -21,8 +21,10 @@ Parameters for `createAsset` call. - [creator](types_asset.CreateAssetParams.md#creator) - [decimals](types_asset.CreateAssetParams.md#decimals) - [fee](types_asset.CreateAssetParams.md#fee) +- [firstValid](types_asset.CreateAssetParams.md#firstvalid) - [freezeAccount](types_asset.CreateAssetParams.md#freezeaccount) - [frozenByDefault](types_asset.CreateAssetParams.md#frozenbydefault) +- [lastValid](types_asset.CreateAssetParams.md#lastvalid) - [lease](types_asset.CreateAssetParams.md#lease) - [manager](types_asset.CreateAssetParams.md#manager) - [maxFee](types_asset.CreateAssetParams.md#maxfee) @@ -118,6 +120,22 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[firstValid](types_transaction.SendTransactionParams.md#firstvalid) + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + ### freezeAccount • `Optional` **freezeAccount**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) @@ -143,6 +161,22 @@ Whether to freeze holdings for this asset by default. If `true` then for anyone ___ +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[lastValid](types_transaction.SendTransactionParams.md#lastvalid) + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### lease • `Optional` **lease**: `string` \| `Uint8Array` diff --git a/docs/code/interfaces/types_transaction.AtomicTransactionComposerToSend.md b/docs/code/interfaces/types_transaction.AtomicTransactionComposerToSend.md index b791dec7..9f0c79f5 100644 --- a/docs/code/interfaces/types_transaction.AtomicTransactionComposerToSend.md +++ b/docs/code/interfaces/types_transaction.AtomicTransactionComposerToSend.md @@ -23,7 +23,7 @@ The `AtomicTransactionComposer` with transactions loaded to send #### Defined in -[src/types/transaction.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L132) +[src/types/transaction.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L136) ___ @@ -35,4 +35,4 @@ Any parameters to control the semantics of the send to the network #### Defined in -[src/types/transaction.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L134) +[src/types/transaction.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L138) diff --git a/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md b/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md index 4b5ad2b2..259c670a 100644 --- a/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md +++ b/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md @@ -33,7 +33,7 @@ The response from sending and waiting for the transaction #### Defined in -[src/types/transaction.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L83) +[src/types/transaction.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L87) ___ @@ -49,4 +49,4 @@ The transaction #### Defined in -[src/types/transaction.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L51) +[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) diff --git a/docs/code/interfaces/types_transaction.ConfirmedTransactionResults.md b/docs/code/interfaces/types_transaction.ConfirmedTransactionResults.md index be464e70..cc46e3ce 100644 --- a/docs/code/interfaces/types_transaction.ConfirmedTransactionResults.md +++ b/docs/code/interfaces/types_transaction.ConfirmedTransactionResults.md @@ -37,7 +37,7 @@ The response from sending and waiting for the primary transaction #### Defined in -[src/types/transaction.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L89) +[src/types/transaction.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L93) ___ @@ -53,7 +53,7 @@ The response from sending and waiting for the transactions #### Defined in -[src/types/transaction.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L91) +[src/types/transaction.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L95) ___ @@ -69,7 +69,7 @@ The transaction #### Defined in -[src/types/transaction.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L51) +[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) ___ @@ -85,4 +85,4 @@ The transactions that have been prepared and/or sent #### Defined in -[src/types/transaction.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L59) +[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) diff --git a/docs/code/interfaces/types_transaction.SendAtomicTransactionComposerResults.md b/docs/code/interfaces/types_transaction.SendAtomicTransactionComposerResults.md index 584c6af4..a6a0afe9 100644 --- a/docs/code/interfaces/types_transaction.SendAtomicTransactionComposerResults.md +++ b/docs/code/interfaces/types_transaction.SendAtomicTransactionComposerResults.md @@ -37,7 +37,7 @@ the index of the confirmation will match the index of the underlying transaction #### Defined in -[src/types/transaction.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L77) +[src/types/transaction.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L81) ___ @@ -49,7 +49,7 @@ base64 encoded representation of the group ID of the atomic group #### Defined in -[src/types/transaction.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L69) +[src/types/transaction.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L73) ___ @@ -61,7 +61,7 @@ If ABI method(s) were called the processed return values #### Defined in -[src/types/transaction.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L73) +[src/types/transaction.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L77) ___ @@ -77,7 +77,7 @@ The transactions that have been prepared and/or sent #### Defined in -[src/types/transaction.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L59) +[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) ___ @@ -89,4 +89,4 @@ The transaction IDs that have been prepared and/or sent #### Defined in -[src/types/transaction.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L71) +[src/types/transaction.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L75) diff --git a/docs/code/interfaces/types_transaction.SendTransactionParams.md b/docs/code/interfaces/types_transaction.SendTransactionParams.md index 7d321cd5..29be014b 100644 --- a/docs/code/interfaces/types_transaction.SendTransactionParams.md +++ b/docs/code/interfaces/types_transaction.SendTransactionParams.md @@ -30,6 +30,8 @@ The sending configuration for a transaction - [atc](types_transaction.SendTransactionParams.md#atc) - [fee](types_transaction.SendTransactionParams.md#fee) +- [firstValid](types_transaction.SendTransactionParams.md#firstvalid) +- [lastValid](types_transaction.SendTransactionParams.md#lastvalid) - [maxFee](types_transaction.SendTransactionParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) - [populateAppCallResources](types_transaction.SendTransactionParams.md#populateappcallresources) @@ -63,6 +65,30 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### maxFee • `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) diff --git a/docs/code/interfaces/types_transaction.SendTransactionResult.md b/docs/code/interfaces/types_transaction.SendTransactionResult.md index f6772f6f..58470c14 100644 --- a/docs/code/interfaces/types_transaction.SendTransactionResult.md +++ b/docs/code/interfaces/types_transaction.SendTransactionResult.md @@ -33,7 +33,7 @@ The response if the transaction was sent and waited for #### Defined in -[src/types/transaction.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L53) +[src/types/transaction.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L57) ___ @@ -45,4 +45,4 @@ The transaction #### Defined in -[src/types/transaction.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L51) +[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) diff --git a/docs/code/interfaces/types_transaction.SendTransactionResults.md b/docs/code/interfaces/types_transaction.SendTransactionResults.md index ffa5c9e9..12e5e9b4 100644 --- a/docs/code/interfaces/types_transaction.SendTransactionResults.md +++ b/docs/code/interfaces/types_transaction.SendTransactionResults.md @@ -34,7 +34,7 @@ the index of the confirmation will match the index of the underlying transaction #### Defined in -[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) +[src/types/transaction.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L67) ___ @@ -46,4 +46,4 @@ The transactions that have been prepared and/or sent #### Defined in -[src/types/transaction.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L59) +[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) diff --git a/docs/code/interfaces/types_transaction.TransactionGroupToSend.md b/docs/code/interfaces/types_transaction.TransactionGroupToSend.md index 3841e720..7e281f35 100644 --- a/docs/code/interfaces/types_transaction.TransactionGroupToSend.md +++ b/docs/code/interfaces/types_transaction.TransactionGroupToSend.md @@ -25,7 +25,7 @@ Any parameters to control the semantics of the send to the network #### Defined in -[src/types/transaction.ts:119](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L119) +[src/types/transaction.ts:123](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L123) ___ @@ -37,7 +37,7 @@ Optional signer to pass in, required if at least one transaction provided is jus #### Defined in -[src/types/transaction.ts:126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L126) +[src/types/transaction.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L130) ___ @@ -51,4 +51,4 @@ The list of transactions to send, which can either be a raw transaction (in whic #### Defined in -[src/types/transaction.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L124) +[src/types/transaction.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L128) diff --git a/docs/code/interfaces/types_transaction.TransactionToSign.md b/docs/code/interfaces/types_transaction.TransactionToSign.md index c28fa19f..70ad95ed 100644 --- 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 -[src/types/transaction.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L111) +[src/types/transaction.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L115) ___ @@ -35,4 +35,4 @@ The unsigned transaction to sign and send #### Defined in -[src/types/transaction.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L109) +[src/types/transaction.ts:113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L113) diff --git a/docs/code/interfaces/types_transfer.AlgoRekeyParams.md b/docs/code/interfaces/types_transfer.AlgoRekeyParams.md index a32e4848..8a001417 100644 --- a/docs/code/interfaces/types_transfer.AlgoRekeyParams.md +++ b/docs/code/interfaces/types_transfer.AlgoRekeyParams.md @@ -18,7 +18,9 @@ Parameters for `rekeyAccount` call. - [atc](types_transfer.AlgoRekeyParams.md#atc) - [fee](types_transfer.AlgoRekeyParams.md#fee) +- [firstValid](types_transfer.AlgoRekeyParams.md#firstvalid) - [from](types_transfer.AlgoRekeyParams.md#from) +- [lastValid](types_transfer.AlgoRekeyParams.md#lastvalid) - [lease](types_transfer.AlgoRekeyParams.md#lease) - [maxFee](types_transfer.AlgoRekeyParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_transfer.AlgoRekeyParams.md#maxroundstowaitforconfirmation) @@ -64,6 +66,22 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[firstValid](types_transaction.SendTransactionParams.md#firstvalid) + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + ### from • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) @@ -76,6 +94,22 @@ The account that will be rekeyed ___ +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[lastValid](types_transaction.SendTransactionParams.md#lastvalid) + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### lease • `Optional` **lease**: `string` \| `Uint8Array` diff --git a/docs/code/interfaces/types_transfer.AlgoTransferParams.md b/docs/code/interfaces/types_transfer.AlgoTransferParams.md index f0a934f6..14c14e83 100644 --- a/docs/code/interfaces/types_transfer.AlgoTransferParams.md +++ b/docs/code/interfaces/types_transfer.AlgoTransferParams.md @@ -19,7 +19,9 @@ Parameters for `transferAlgos` call. - [amount](types_transfer.AlgoTransferParams.md#amount) - [atc](types_transfer.AlgoTransferParams.md#atc) - [fee](types_transfer.AlgoTransferParams.md#fee) +- [firstValid](types_transfer.AlgoTransferParams.md#firstvalid) - [from](types_transfer.AlgoTransferParams.md#from) +- [lastValid](types_transfer.AlgoTransferParams.md#lastvalid) - [lease](types_transfer.AlgoTransferParams.md#lease) - [maxFee](types_transfer.AlgoTransferParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_transfer.AlgoTransferParams.md#maxroundstowaitforconfirmation) @@ -77,6 +79,22 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[firstValid](types_transaction.SendTransactionParams.md#firstvalid) + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + ### from • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) @@ -89,6 +107,22 @@ The account that will send the ALGOs ___ +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[lastValid](types_transaction.SendTransactionParams.md#lastvalid) + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### lease • `Optional` **lease**: `string` \| `Uint8Array` diff --git a/docs/code/interfaces/types_transfer.EnsureFundedParams.md b/docs/code/interfaces/types_transfer.EnsureFundedParams.md index 27559ebd..8e79f3f3 100644 --- a/docs/code/interfaces/types_transfer.EnsureFundedParams.md +++ b/docs/code/interfaces/types_transfer.EnsureFundedParams.md @@ -19,7 +19,9 @@ Parameters for `ensureFunded` call. - [accountToFund](types_transfer.EnsureFundedParams.md#accounttofund) - [atc](types_transfer.EnsureFundedParams.md#atc) - [fee](types_transfer.EnsureFundedParams.md#fee) +- [firstValid](types_transfer.EnsureFundedParams.md#firstvalid) - [fundingSource](types_transfer.EnsureFundedParams.md#fundingsource) +- [lastValid](types_transfer.EnsureFundedParams.md#lastvalid) - [lease](types_transfer.EnsureFundedParams.md#lease) - [maxFee](types_transfer.EnsureFundedParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_transfer.EnsureFundedParams.md#maxroundstowaitforconfirmation) @@ -78,6 +80,22 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[firstValid](types_transaction.SendTransactionParams.md#firstvalid) + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + ### fundingSource • `Optional` **fundingSource**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) \| [`TestNetDispenserApiClient`](../classes/types_dispenser_client.TestNetDispenserApiClient.md) @@ -90,6 +108,22 @@ The account to use as a funding source, will default to using the dispenser acco ___ +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[lastValid](types_transaction.SendTransactionParams.md#lastvalid) + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### lease • `Optional` **lease**: `string` \| `Uint8Array` diff --git a/docs/code/interfaces/types_transfer.TransferAssetParams.md b/docs/code/interfaces/types_transfer.TransferAssetParams.md index f8358eb5..266da1fe 100644 --- a/docs/code/interfaces/types_transfer.TransferAssetParams.md +++ b/docs/code/interfaces/types_transfer.TransferAssetParams.md @@ -21,7 +21,9 @@ Parameters for `transferAsset` call. - [atc](types_transfer.TransferAssetParams.md#atc) - [clawbackFrom](types_transfer.TransferAssetParams.md#clawbackfrom) - [fee](types_transfer.TransferAssetParams.md#fee) +- [firstValid](types_transfer.TransferAssetParams.md#firstvalid) - [from](types_transfer.TransferAssetParams.md#from) +- [lastValid](types_transfer.TransferAssetParams.md#lastvalid) - [lease](types_transfer.TransferAssetParams.md#lease) - [maxFee](types_transfer.TransferAssetParams.md#maxfee) - [maxRoundsToWaitForConfirmation](types_transfer.TransferAssetParams.md#maxroundstowaitforconfirmation) @@ -103,6 +105,22 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr ___ +### firstValid + +• `Optional` **firstValid**: `number` + +The first round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[firstValid](types_transaction.SendTransactionParams.md#firstvalid) + +#### Defined in + +[src/types/transaction.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L47) + +___ + ### from • **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) @@ -115,6 +133,22 @@ The account that will send the asset ___ +### lastValid + +• `Optional` **lastValid**: `number` + +The last round this transaction will be valid + +#### Inherited from + +[SendTransactionParams](types_transaction.SendTransactionParams.md).[lastValid](types_transaction.SendTransactionParams.md#lastvalid) + +#### Defined in + +[src/types/transaction.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L49) + +___ + ### lease • `Optional` **lease**: `string` \| `Uint8Array` diff --git a/docs/code/modules/index.md b/docs/code/modules/index.md index 072e6a3e..a63a10d8 100644 --- a/docs/code/modules/index.md +++ b/docs/code/modules/index.md @@ -363,7 +363,7 @@ the estimated rate. #### Defined in -[src/transaction/transaction.ts:816](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L816) +[src/transaction/transaction.ts:819](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L819) ___ @@ -419,7 +419,7 @@ Allows for control of fees on a `Transaction` or `SuggestedParams` object #### Defined in -[src/transaction/transaction.ts:839](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L839) +[src/transaction/transaction.ts:842](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L842) ___ @@ -1634,7 +1634,7 @@ The array of transactions with signers #### Defined in -[src/transaction/transaction.ts:871](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L871) +[src/transaction/transaction.ts:874](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L874) ___ @@ -1999,7 +1999,7 @@ The suggested transaction parameters #### Defined in -[src/transaction/transaction.ts:862](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L862) +[src/transaction/transaction.ts:865](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L865) ___ @@ -2385,7 +2385,7 @@ The dryrun result #### Defined in -[src/transaction/transaction.ts:696](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L696) +[src/transaction/transaction.ts:699](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L699) ___ @@ -2516,7 +2516,7 @@ A new ATC with the resources packed into the transactions #### Defined in -[src/transaction/transaction.ts:308](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L308) +[src/transaction/transaction.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L311) ___ @@ -2684,7 +2684,7 @@ An object with transaction IDs, transactions, group transaction ID (`groupTransa #### Defined in -[src/transaction/transaction.ts:561](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L561) +[src/transaction/transaction.ts:564](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L564) ___ @@ -2709,7 +2709,7 @@ An object with transaction IDs, transactions, group transaction ID (`groupTransa #### Defined in -[src/transaction/transaction.ts:714](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L714) +[src/transaction/transaction.ts:717](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L717) ___ @@ -2992,4 +2992,4 @@ Throws an error if the transaction is not confirmed or rejected in the next `tim #### Defined in -[src/transaction/transaction.ts:759](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L759) +[src/transaction/transaction.ts:762](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L762) diff --git a/docs/code/modules/types_transaction.md b/docs/code/modules/types_transaction.md index 92c5fdbe..8a19c5a1 100644 --- a/docs/code/modules/types_transaction.md +++ b/docs/code/modules/types_transaction.md @@ -53,7 +53,7 @@ many types of accounts, including: #### Defined in -[src/types/transaction.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L104) +[src/types/transaction.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L108) ___ From 623edb0e3a0396ae9b89c37b5331e07b88f72f7e Mon Sep 17 00:00:00 2001 From: Joe Polny Date: Fri, 21 Jun 2024 13:18:26 -0400 Subject: [PATCH 3/3] update fv/lv comment --- docs/code/interfaces/types_app.AppCallParams.md | 4 ++-- docs/code/interfaces/types_app.AppDeploymentParams.md | 4 ++-- docs/code/interfaces/types_app.CreateAppParams.md | 4 ++-- docs/code/interfaces/types_app.UpdateAppParams.md | 4 ++-- docs/code/interfaces/types_asset.AssetOptInParams.md | 4 ++-- docs/code/interfaces/types_asset.AssetOptOutParams.md | 4 ++-- docs/code/interfaces/types_asset.CreateAssetParams.md | 4 ++-- .../interfaces/types_transaction.SendTransactionParams.md | 4 ++-- docs/code/interfaces/types_transfer.AlgoRekeyParams.md | 4 ++-- docs/code/interfaces/types_transfer.AlgoTransferParams.md | 4 ++-- docs/code/interfaces/types_transfer.EnsureFundedParams.md | 4 ++-- docs/code/interfaces/types_transfer.TransferAssetParams.md | 4 ++-- src/types/transaction.ts | 4 ++-- 13 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/code/interfaces/types_app.AppCallParams.md b/docs/code/interfaces/types_app.AppCallParams.md index a80c2168..f65beffb 100644 --- a/docs/code/interfaces/types_app.AppCallParams.md +++ b/docs/code/interfaces/types_app.AppCallParams.md @@ -107,7 +107,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -135,7 +135,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_app.AppDeploymentParams.md b/docs/code/interfaces/types_app.AppDeploymentParams.md index cf9abb12..c841dc91 100644 --- a/docs/code/interfaces/types_app.AppDeploymentParams.md +++ b/docs/code/interfaces/types_app.AppDeploymentParams.md @@ -152,7 +152,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -184,7 +184,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_app.CreateAppParams.md b/docs/code/interfaces/types_app.CreateAppParams.md index 94b23faa..d9a1f1e7 100644 --- a/docs/code/interfaces/types_app.CreateAppParams.md +++ b/docs/code/interfaces/types_app.CreateAppParams.md @@ -121,7 +121,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -153,7 +153,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_app.UpdateAppParams.md b/docs/code/interfaces/types_app.UpdateAppParams.md index 66569d37..d8423443 100644 --- a/docs/code/interfaces/types_app.UpdateAppParams.md +++ b/docs/code/interfaces/types_app.UpdateAppParams.md @@ -132,7 +132,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -164,7 +164,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_asset.AssetOptInParams.md b/docs/code/interfaces/types_asset.AssetOptInParams.md index 276bd34b..50206943 100644 --- a/docs/code/interfaces/types_asset.AssetOptInParams.md +++ b/docs/code/interfaces/types_asset.AssetOptInParams.md @@ -96,7 +96,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -112,7 +112,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_asset.AssetOptOutParams.md b/docs/code/interfaces/types_asset.AssetOptOutParams.md index 86343e76..5f6ea339 100644 --- a/docs/code/interfaces/types_asset.AssetOptOutParams.md +++ b/docs/code/interfaces/types_asset.AssetOptOutParams.md @@ -128,7 +128,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -144,7 +144,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_asset.CreateAssetParams.md b/docs/code/interfaces/types_asset.CreateAssetParams.md index 3870e6aa..d46324aa 100644 --- a/docs/code/interfaces/types_asset.CreateAssetParams.md +++ b/docs/code/interfaces/types_asset.CreateAssetParams.md @@ -124,7 +124,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -165,7 +165,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_transaction.SendTransactionParams.md b/docs/code/interfaces/types_transaction.SendTransactionParams.md index 29be014b..5caa74b1 100644 --- a/docs/code/interfaces/types_transaction.SendTransactionParams.md +++ b/docs/code/interfaces/types_transaction.SendTransactionParams.md @@ -69,7 +69,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Defined in @@ -81,7 +81,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Defined in diff --git a/docs/code/interfaces/types_transfer.AlgoRekeyParams.md b/docs/code/interfaces/types_transfer.AlgoRekeyParams.md index 8a001417..a7d4f1a7 100644 --- a/docs/code/interfaces/types_transfer.AlgoRekeyParams.md +++ b/docs/code/interfaces/types_transfer.AlgoRekeyParams.md @@ -70,7 +70,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -98,7 +98,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_transfer.AlgoTransferParams.md b/docs/code/interfaces/types_transfer.AlgoTransferParams.md index 14c14e83..b229088e 100644 --- a/docs/code/interfaces/types_transfer.AlgoTransferParams.md +++ b/docs/code/interfaces/types_transfer.AlgoTransferParams.md @@ -83,7 +83,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -111,7 +111,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_transfer.EnsureFundedParams.md b/docs/code/interfaces/types_transfer.EnsureFundedParams.md index 8e79f3f3..0df9bff4 100644 --- a/docs/code/interfaces/types_transfer.EnsureFundedParams.md +++ b/docs/code/interfaces/types_transfer.EnsureFundedParams.md @@ -84,7 +84,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -112,7 +112,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/docs/code/interfaces/types_transfer.TransferAssetParams.md b/docs/code/interfaces/types_transfer.TransferAssetParams.md index 266da1fe..f7b899da 100644 --- a/docs/code/interfaces/types_transfer.TransferAssetParams.md +++ b/docs/code/interfaces/types_transfer.TransferAssetParams.md @@ -109,7 +109,7 @@ ___ • `Optional` **firstValid**: `number` -The first round this transaction will be valid +If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from @@ -137,7 +137,7 @@ ___ • `Optional` **lastValid**: `number` -The last round this transaction will be valid +If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod #### Inherited from diff --git a/src/types/transaction.ts b/src/types/transaction.ts index 58cf4f4c..a50813d8 100644 --- a/src/types/transaction.ts +++ b/src/types/transaction.ts @@ -43,9 +43,9 @@ export interface SendTransactionParams { maxRoundsToWaitForConfirmation?: number /** **WARNING**: Not recommended for production use due to https://github.com/algorand/go-algorand/issues/5914. Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. */ populateAppCallResources?: boolean - /** The first round this transaction will be valid */ + /** If provided, explicitly set the first round this transaction will be valid. If not set, the suggested round will be retrieved from algod */ firstValid?: number - /** The last round this transaction will be valid */ + /** If provided, explicitly set the last round this transaction will be valid. If not set, the suggested round will be retrieved from algod */ lastValid?: number }