Skip to content
This repository was archived by the owner on Jul 30, 2025. It is now read-only.

Update documentation for entry functions#819

Merged
vineethk merged 1 commit intomainfrom
vk/entry-functions-update
Feb 13, 2025
Merged

Update documentation for entry functions#819
vineethk merged 1 commit intomainfrom
vk/entry-functions-update

Conversation

@vineethk
Copy link
Contributor

@vineethk vineethk commented Feb 13, 2025

Description

Entry functions allow more than what was previously documented.

Also includes fixes to satisfy the link checker.

Closes aptos-labs/aptos-core#14571

Checklist

  • Do all Lints pass?
    • Have you ran pnpm fmt?
    • Have you ran pnpm lint?

@vercel
Copy link

vercel bot commented Feb 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
developer-docs-nextra ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 13, 2025 9:03pm

Copy link
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Entry functions can take primitive types, String, and vector arguments but cannot take Structs (e.g. Option). They also
must not have any return values.
Entry functions can accept parameters that are: primitive types, reference to a `signer`, vectors (where the element type is itself acceptable),
and certain standard library types such as `String`, `Object`, `Option`, `FixedPoint32`, `FixedPoint64`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

FixedPoint might be supported, but I'm unsure how it's BCS encoded.

Let's skip it for now?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good - I was going based on the code in the extended checker.

@vineethk vineethk merged commit dec5288 into main Feb 13, 2025
6 checks passed
@vineethk vineethk deleted the vk/entry-functions-update branch February 13, 2025 21:06
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[move-book] Entry parameter documentation is out-of-date

3 participants