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.

Sign up for GitHub

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

Update transaction option maxGasAmount, gasUnitPrice, expireTimestamp properties to use number type #245

Merged
merged 1 commit into from
Jan 3, 2024
Merged

Update transaction option maxGasAmount, gasUnitPrice, expireTimestamp properties to use number type #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ All notable changes to the Aptos TypeScript SDK will be captured in this file. T

- [`Breaking`] Capitalize `TransactionPayloadMultiSig` type
- Add support to Array value in digital asset property map
- [`Breaking`] Change `maxGasAmount, gasUnitPrice and expireTimestamp` properties in `InputGenerateTransactionOptions` type to `number` type

# 1.2.0 (2023-12-14)

Expand Down
6 changes: 3 additions & 3 deletions src/transactions/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ export type AnyRawTransactionInstance = RawTransaction | MultiAgentRawTransactio
* Optional options to set when generating a transaction
*/
export type InputGenerateTransactionOptions = {
maxGasAmount?: AnyNumber;
gasUnitPrice?: AnyNumber;
expireTimestamp?: AnyNumber;
maxGasAmount?: number;
gasUnitPrice?: number;
expireTimestamp?: number;
Comment on lines +80 to +82
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the only issue is setting "no expiry", as well as anytime after January 19th 2038, it may fail if it's not represented as a bigint or a string...

Would a string work?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JavaScript uses a 64-bit floating-point number to represent dates. Jan 19, 2038 shouldn't be affected with use of number.

Yes a string would work, but would have to be converted to number elsewhere. If your only issue was the 32-bit overflow, would be good to keep as number.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, let's make it a number, I'm convinced since the max safe integer in microseconds is 2255.

Can we document that it must be a SafeInteger? Because I guess the bounds are still the same problem anyways, where the number could be put in here negative, and that would also fail.

For a future update let's add a function that we can use to verify isUnsignedInt which would verify the bounds 0-> Number.MAX_SAFE_NUMBER. Then we won't get weird float values, and we can add it more places to provide better help with it.

accountSequenceNumber?: AnyNumber;
};

Expand Down
Loading