Release 0.4.0-beta

[nhenin]

Summary by CodeRabbit

• New Features

  • Added initial account deposits feature with associated utility functions.
  • Introduced an experimental sourceMap API for annotated contract sources.

• Breaking Changes

  • Modified API methods in RestClient to use keyword arguments for enhanced clarity and usability.
  • Added annotations to the contract type in marlowe-object.

• Enhancements

  • Included an optional strict parameter for dynamic type checking in RestClient methods.

• Documentation

  • Updated version numbers and script source URLs across various documentation and package files to reflect the new beta version 0.4.0-beta.

• Chores

  • Updated multiple package versions from 0.4.0-beta-rc1 to 0.4.0-beta.

[coderabbitai]

Warning

Rate Limit Exceeded

@nhenin has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 11 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 93598c0 and dcdca30.

Walkthrough

The updates primarily involve transitioning from 0.4.0-beta-rc1 to 0.4.0-beta across various Marlowe.io packages and documentation, signifying a stabilization phase before full release. Additionally, there are significant breaking changes in the @marlowe.io/runtime-rest-client and new features in @marlowe.io/marlowe-object. Bjorn Kihlberg has been removed from the contributors list across multiple packages.

Changes

Files	Change Summary
Various package.json files	Updated version from 0.4.0-beta-rc1 to 0.4.0-beta; Removed Bjorn Kihlberg from contributors.
Various documentation and README files	Updated version numbers in URLs and script sources from 0.4.0-beta-rc1 to 0.4.0-beta.
CHANGELOG.md	Introduced breaking changes in @marlowe.io/runtime-rest-client; Added new types and features in @marlowe.io/runtime-core and @marlowe.io/marlowe-object.

🐰✨
In the land of code, where the bits do leap,
A version change, not shallow but deep.
From rc1 to beta, the numbers align,
Farewell Bjorn, 'twas a journey fine.
Hop and skip, the changes we sweep! 🌟
🥕🐇

---

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: 1

Out of diff range and nitpick comments (4)

doc/modules-system.md (4)

Line range hint 3-3: Consider adding a comma after "2015" for better readability.

---

Line range hint 3-3: Add a period after "etc" to adhere to American English conventions.

---

Line range hint 7-7: Change "a ESM bundle" to "an ESM bundle" to correct the article usage before a vowel sound.

---

9-9: Consider adding a comma after "modules" to improve the readability of the sentence.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2ef0439 and 93598c0.

Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

Files selected for processing (23)

• CHANGELOG.md (1 hunks)
• doc/howToDevelop.md (1 hunks)
• doc/modules-system.md (1 hunks)
• doc/versioning-and-releases.md (2 hunks)
• jsdelivr-npm-importmap.js (1 hunks)
• package.json (2 hunks)
• packages/adapter/package.json (1 hunks)
• packages/language/core/v1/Readme.md (1 hunks)
• packages/language/core/v1/package.json (2 hunks)
• packages/language/examples/package.json (2 hunks)
• packages/language/specification-client/package.json (2 hunks)
• packages/marlowe-object/package.json (2 hunks)
• packages/marlowe-template/package.json (2 hunks)
• packages/runtime/client/rest/Readme.md (1 hunks)
• packages/runtime/client/rest/package.json (2 hunks)
• packages/runtime/core/package.json (2 hunks)
• packages/runtime/lifecycle/package.json (2 hunks)
• packages/runtime/lifecycle/src/browser/index.ts (1 hunks)
• packages/testing-kit/package.json (2 hunks)
• packages/token-metadata-client/package.json (1 hunks)
• packages/wallet/Readme.md (1 hunks)
• packages/wallet/package.json (1 hunks)
• rollup/config.mjs (1 hunks)

Files skipped from review due to trivial changes (17)

• jsdelivr-npm-importmap.js
• package.json
• packages/adapter/package.json
• packages/language/core/v1/package.json
• packages/language/examples/package.json
• packages/language/specification-client/package.json
• packages/marlowe-object/package.json
• packages/marlowe-template/package.json
• packages/runtime/client/rest/Readme.md
• packages/runtime/client/rest/package.json
• packages/runtime/core/package.json
• packages/runtime/lifecycle/package.json
• packages/runtime/lifecycle/src/browser/index.ts
• packages/testing-kit/package.json
• packages/token-metadata-client/package.json
• packages/wallet/package.json
• rollup/config.mjs

Additional comments not posted (6)

doc/modules-system.md (1)

12-12: Update the script source URL to reflect the new version "0.4.0-beta".

packages/language/core/v1/Readme.md (1)

19-19: Update the script source URL to reflect the new version "0.4.0-beta".

packages/wallet/Readme.md (1)

23-23: Update the script source URL to reflect the new version "0.4.0-beta".

doc/versioning-and-releases.md (2)

13-13: Clarify the beta versioning rules to ensure they are understood correctly.

---

45-45: Ensure the git commands are correct and that they reflect the intended actions for tagging and pushing the new version.

doc/howToDevelop.md (1)

209-215: Ensure that the file paths in the JSON dependencies are correct and that they point to the intended tarball files.