search

input-output-hk / marlowe-ts-sdk

Marlowe TypeScript SDK
https://marlowe.iohk.io/
Apache License 2.0
22 stars 11 forks source link

Add annotations to marlowe-object #181

Closed hrajchert closed 7 months ago

hrajchert commented 8 months ago

This PR adds annotations to the marlowe-object package, which simplifies deriving a logical state from the contract. See how the getState function was simplified in the marlowe-object-flow example.

It also adds a new experimental feature called sourceMap that partially solves the issue of knowing if a Contract matches a certain structure.

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

Walkthrough

The recent updates bring significant enhancements across various components focused on Marlowe contracts. These changes streamline interaction through improved annotations, health checks for actions, and refined contract management. Updates in bundle conversion and testing configurations enhance the development environment for Marlowe contracts.

Changes

Files Summary
.../annotations.ts, .../actions.ts, .../value-and-observation.ts, .../payee.ts, .../participants.ts, .../guards.ts Introduced and enhanced functionalities for annotations, actions, values, payees, participants, and type guards.
.../applicable-inputs.ts, packages/adapter/src/time.ts, .../contract/endpoints/sources.ts, .../lifecycle/src/generic/contracts.ts Modified to include health checks, time adjustments, and updates in contract source management.
.../contract-closure.ts, .../marlowe-object-flow.ts, .../bundle-conversion.ts, .../bundle-list.ts, .../bundle-map.ts, .../contract.ts Added and updated functionalities related to contract closures, object flow, bundle conversions, and contract definitions.
jest.unit.config.js, jest.unit.config.mjs Added new Jest configuration for unit testing.
jsdelivr-npm-importmap.js Updated import maps for package management.
packages/language/core/v1/src/contract.ts, .../semantics.ts Significantly altered contract matching and semantics functionalities.
.../test/bundleListToMap.spec.ts, .../test/bundleMapToList.spec.ts Introduced tests for bundle conversion functions.

"In the realm of code, where contracts intertwine,
A rabbit hopped forth, with changes so fine.
🐰 With a leap and a bound, it refined the flow,
Enhancing the Marlowe, with a soft, gentle glow."

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
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 .` - `Generate unit-tests for this file.` - 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 tests 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 from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.