Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: first/last valid on SendTransactionParams #292

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/code/interfaces/types_app.AppCallParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -101,6 +103,22 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr

___

### firstValid

• `Optional` **firstValid**: `number`

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

[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)
Expand All @@ -113,6 +131,22 @@ The account to make the call from

___

### lastValid

• `Optional` **lastValid**: `number`

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

[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)
Expand Down
8 changes: 4 additions & 4 deletions docs/code/interfaces/types_app.AppCallTransactionResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

___

Expand All @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand All @@ -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)
Original file line number Diff line number Diff line change
Expand Up @@ -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)

___

Expand All @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand All @@ -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)
34 changes: 34 additions & 0 deletions docs/code/interfaces/types_app.AppDeploymentParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -146,6 +148,22 @@ Omit.fee

___

### firstValid

• `Optional` **firstValid**: `number`

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

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)
Expand All @@ -162,6 +180,22 @@ Omit.from

___

### lastValid

• `Optional` **lastValid**: `number`

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

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)
Expand Down
34 changes: 34 additions & 0 deletions docs/code/interfaces/types_app.CreateAppParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -115,6 +117,22 @@ CreateOrUpdateAppParams.fee

___

### firstValid

• `Optional` **firstValid**: `number`

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

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)
Expand All @@ -131,6 +149,22 @@ CreateOrUpdateAppParams.from

___

### lastValid

• `Optional` **lastValid**: `number`

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

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)
Expand Down
34 changes: 34 additions & 0 deletions docs/code/interfaces/types_app.UpdateAppParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -126,6 +128,22 @@ CreateOrUpdateAppParams.fee

___

### firstValid

• `Optional` **firstValid**: `number`

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

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)
Expand All @@ -142,6 +160,22 @@ CreateOrUpdateAppParams.from

___

### lastValid

• `Optional` **lastValid**: `number`

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

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)
Expand Down
34 changes: 34 additions & 0 deletions docs/code/interfaces/types_asset.AssetOptInParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -90,6 +92,38 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr

___

### firstValid

• `Optional` **firstValid**: `number`

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

[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`

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

[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`
Expand Down
34 changes: 34 additions & 0 deletions docs/code/interfaces/types_asset.AssetOptOutParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -122,6 +124,38 @@ The flat fee you want to pay, useful for covering extra fees in a transaction gr

___

### firstValid

• `Optional` **firstValid**: `number`

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

[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`

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

[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`
Expand Down
Loading
Loading