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: new functions in stdlib from stdlib.fc and math.fc #986

Merged
merged 51 commits into from
Feb 5, 2025

Conversation

Gusarich
Copy link
Member

@Gusarich Gusarich commented Oct 25, 2024

Issue

Closes #770
Towards #1029 (only myCode())

Checklist

  • I have updated CHANGELOG.md
  • I have documented my contribution in docs/ and made the build locally
  • I have added tests to demonstrate the contribution is correctly implemented: this usually includes both positive and negative tests, showing the happy path(s) and featuring intentionally broken cases
  • I have run all the tests locally and no test failure was reported
  • I have run the linter, formatter and spellchecker
  • I did not do unrelated and/or undiscussed refactorings

Current State

  • All stdlib.fc functions are present in Tact stdlib in some form, with some exceptions:
    • no tuple manipulation functions, because there is no tuple support in Tact. Do we really need them? @anton-trunov
    • no minmax and no slice_bits_refs because we don't have tensor types in Tact and it would be useless: Tensor types #1116
    • no set_data and get_data because Tact manages persistent storage by itself
    • no bless and other continuation functions because Tact manages control flow itself and for running some arbitrary code it's better to use RUNVM which doesn't require continuations parameters
    • no raw_reserve_extra because it requires an uint32 -> varuint32 dictionary and we only support varuint16 for values currently: VarUInt32, VarInt16, VarInt32 serialization types #1117
  • All mathlib.fc functions are present in Tact stdlib in some form, with some exceptions:
    • no fixed-point arithmetic related functions: Fixed-point arithmetics library #1118
    • no nan and is_nan because we don't support NaN in Tact. Do we really need them? @anton-trunov
    • no sub_rev because it is useless in our case
    • no ...MOD instructions because they return two values as a tensor and it won't be very developer-friendly in Tact to make them return tuples in my opinion: Tensor types #1116
  • All new functions are covered with tests

@Gusarich Gusarich added this to the v1.6.0 milestone Oct 25, 2024
Copy link
Member

@novusnota novusnota left a comment

Choose a reason for hiding this comment

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

Sorry for reviewing the draft, I just wanted to keep those notes around :)

stdlib/stdlib.fc Outdated Show resolved Hide resolved
stdlib/stdlib.fc Outdated Show resolved Hide resolved
stdlib/stdlib.fc Outdated Show resolved Hide resolved
stdlib/std/math.tact Outdated Show resolved Hide resolved
stdlib/std/cells.tact Outdated Show resolved Hide resolved
stdlib/std/cells.tact Outdated Show resolved Hide resolved
stdlib/std/cells.tact Outdated Show resolved Hide resolved
stdlib/std/cells.tact Outdated Show resolved Hide resolved
@Gusarich Gusarich force-pushed the stdlib-extension-with-mathlib branch from 178e712 to b9b6206 Compare November 17, 2024 07:41
@Gusarich
Copy link
Member Author

@novusnota @anton-trunov Implemented all functions. I'd like to hear some intermediate feedback on them before I proceed with writing tests.

I made sure to include all missing functions from both stdlib.fc and mathlib.fc with some exceptions (see PR description).

Copy link
Member

@anton-trunov anton-trunov left a comment

Choose a reason for hiding this comment

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

afair, mathlib.fc has lots of functions for fixed-arithmetic as well, I think we should add those too (perhaps as a separate library, like fixed_point_math.tact).

Also, I left a couple comments in the source code

CHANGELOG.md Outdated Show resolved Hide resolved
stdlib/std/cells.tact Outdated Show resolved Hide resolved
stdlib/std/math.tact Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@Gusarich Gusarich marked this pull request as ready for review November 28, 2024 05:21
@Gusarich Gusarich requested a review from a team as a code owner November 28, 2024 05:21
@Gusarich
Copy link
Member Author

@anton-trunov @novusnota covered all new functions with tests!

Found and fixed a few little mistakes in types (for addressNone and computeDataSize functions). Also added comments with formulas for new math functions

@anton-trunov
Copy link
Member

@Gusarich Let's

  • resolve the merge conflicts
  • move the notes from "current state" to their own separate issues

@anton-trunov anton-trunov self-assigned this Nov 28, 2024
Copy link
Member

@anton-trunov anton-trunov left a comment

Choose a reason for hiding this comment

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

We should document the new functions in https://docs.tact-lang.org/ref/core-math and other relevant doc pages

@novusnota
Copy link
Member

We should document the new functions in https://docs.tact-lang.org/ref/core-math and other relevant doc pages

Will do

@novusnota
Copy link
Member

macOS CIs exceed some time limits even after restarting those in isolation. Other than that, this PR seems to be done, I've even added the couple of "gas-expensive" badges :)

We should document the new functions in https://docs.tact-lang.org/ref/core-math and other relevant doc pages

✔️

Copy link
Member

@anton-trunov anton-trunov left a comment

Choose a reason for hiding this comment

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

Almost done, just one final push

@novusnota
Copy link
Member

Let's finally merge this :)

@novusnota
Copy link
Member

Uno momento

@novusnota
Copy link
Member

@i582 Resolved your suggestions (hopefully), please take a look

Copy link
Contributor

@i582 i582 left a comment

Choose a reason for hiding this comment

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

LGTM

@anton-trunov anton-trunov merged commit 13fee13 into tact-lang:main Feb 5, 2025
23 checks passed
@novusnota
Copy link
Member

Hooray 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Port stdlib.fc and mathlib.fc's asm functions to Tact's stdlib
6 participants