Fix how the ContractId and TxId branded types are printed in the documentation

[hrajchert]

In the PR#184 I added the preserveBrand function that helped with the uses of branded types inside recursive data types, but the typing was a little bit off, and it changed the generated documentation from this

to this

This PR:

• fixes that issue
• creates a branded type for TxId

and moreover it improves the generated output to this:

Note that in order to preserve the type alias (at least in typescript version 4.9.5) we need to define ContractId like this

export type ContractId = t.Branded<string, ContractIdBrand>;

instead of

export type ContractId = t.TypeOf<typeof ContractIdGuard>;

Summary by CodeRabbit

• Refactor
  • Updated function signatures and type usage across multiple files for enhanced type safety and consistency.
• New Features
  • Introduced branded types and guards (TxIdGuard, ContractIdBrand, TxIdBrand) to ensure more robust type checking and validation.
• Bug Fixes
  • Fixed inconsistencies in type usage for transaction IDs across the application, aligning them with the new type guards.

[coderabbitai[bot]]

Walkthrough

The changes focus on enhancing type safety and consistency by introducing type guards like TxIdGuard and branding types such as ContractIdBrand and TxIdBrand. These updates aim to ensure precise type checks and clear code semantics. The modifications range from adjusting function signatures to refining types and updating imports to align with the new type safety measures.

Changes

Files	Change Summary
packages/adapter/src/io-ts.ts	Updated preservedBrand function to use generic types and improve type checks.
packages/runtime/.../rest/src/contract/transaction/details.ts packages/runtime/.../rest/src/contract/transaction/endpoints/collection.ts packages/runtime/.../rest/src/contract/transaction/endpoints/singleton.ts packages/runtime/.../rest/src/contract/transaction/header.ts	Updated to use TxIdGuard for improved type safety in transaction-related files.
packages/runtime/core/src/contract/id.ts packages/runtime/core/src/payout/index.ts packages/runtime/core/src/tx/id.ts	Introduced and utilized ContractIdBrand, TxIdBrand, and TxIdGuard; updated functions to include txId.

🐰✨
Changes abound, in code we trust,
Types refined, a must, a must!
With guards and brands, we pave the way,
For safer code, day by day.
Hoppin' through the fields of type,
Our code now strong, without the hype.
🌟🐇

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.