feat: calc apr

[cgilbe27]

Relates to #936

Typescript for calculating APR

Summary by CodeRabbit

• New Features
  • Introduced new mathematical functionalities for polynomial evaluation, epoch mint provision calculation, staking APR computation, and staking inflation claimable calculation.

[coderabbitai]

Walkthrough

The update enriches the SDK with advanced mathematical capabilities, catering to polynomial evaluation, epoch mint provision computation, staking APR calculation, and staking inflation claimable estimation. These additions bolster the SDK's financial computation prowess, ensuring accuracy and efficiency in handling related tasks.

Changes

Files	Change Summary
src/sdk/utils/math.ts, src/sdk/utils/math.test.ts	Added functions for polynomial evaluation, epoch mint provision, staking APR computation, and staking inflation claimable calculation. Includes computeStakingEmissionPerPeriod for precise staking inflation claimable calculation. Test cases validate functionality.

🐰🌟
Amidst the code's realm, where logic takes flight,
A rabbit codes with joy, in the glow of byte-light.
Polynomials dance, epochs whisper in math's embrace,
In lines of code, a magical space.
With each commit's beat, a tale unfurls,
In the SDK's domain, where innovation whirls!

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

[github-actions]

Lines	Statements	Branches	Functions
	90.29% (1014/1123)	72.2% (304/421)	76.48% (244/319)

DIsmiss

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4f541d2 and 84cf8b5.

Files selected for processing (1)

• src/sdk/utils/math.test.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• src/sdk/utils/math.test.ts

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 84cf8b5 and 10d660f.

Files selected for processing (2)

• src/sdk/utils/math.test.ts (1 hunks)
• src/sdk/utils/math.ts (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• src/sdk/utils/math.test.ts
• src/sdk/utils/math.ts

[nibibot]

🎉 This PR is included in version 4.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀