Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Camino Messenger Account and Partner configuration to glossary #317

Open
wants to merge 9 commits into
base: dev
Choose a base branch
from

Conversation

VjeraTurk
Copy link

@VjeraTurk VjeraTurk commented Dec 3, 2024

Small PR suggested by @nkoljanin

Summary by CodeRabbit

  • New Features

    • Added definitions for "Camino Messenger Account" and "Partner Configuration" to the glossary.
    • Updated acronym list to include "CMA" for "Camino Messenger Account" while retaining "CMP" for "Camino Messenger Protocol."
  • Documentation

    • Enhanced glossary structure for improved clarity and context regarding terms related to the Camino ecosystem.
    • Included links to functional documentation for "Camino Messenger Account" and "Partner Configuration."

@nkoljanin nkoljanin marked this pull request as ready for review December 3, 2024 10:02
@nkoljanin nkoljanin requested a review from havan as a code owner December 3, 2024 10:02
Copy link

@nkoljanin nkoljanin left a comment

Choose a reason for hiding this comment

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

@VjeraTurk can we also squeeze in the change to the faucet docs here? Mention that the current max amount is 150CAM per week (instead of the old 50CAM a day), with a disclaimer that it's subject to changes and that the discord bot will always reflect the latest and most correct amount/time https://github.com/chain4travel/camino-docs/blob/dev/docs/developer/guides/how-to-deploy-a-smart-contract.md#3-request-funds-from-the-discord-faucet

@havan
Copy link
Member

havan commented Dec 3, 2024

@VjeraTurk can we also squeeze in the change to the faucet docs here? Mention that the current max amount is 150CAM per week (instead of the old 50CAM a day), with a disclaimer that it's subject to changes and that the discord bot will always reflect the latest and most correct amount/time https://github.com/chain4travel/camino-docs/blob/dev/docs/developer/guides/how-to-deploy-a-smart-contract.md#3-request-funds-from-the-discord-faucet

I've added that to the other docs PR

@havan havan requested a review from SamJaarsma December 3, 2024 11:21
@havan havan dismissed nkoljanin’s stale review December 3, 2024 11:22

Added it into another PR

docs/faq/glossary.md Show resolved Hide resolved

The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings.
It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger.

## Camino Messenger Protocol
Copy link
Contributor

Choose a reason for hiding this comment

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

move "Camino Messenger Protocol" to before "Partner Plugin"

Copy link
Author

Choose a reason for hiding this comment

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

I put acronym CMB before CMP


The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings.
It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger.

Copy link
Contributor

@SamJaarsma SamJaarsma Dec 3, 2024

Choose a reason for hiding this comment

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

The Camino Messenger Account can be created from the Partner Showroom of the Camino Suite or - for development purposes on Columbus only - by using a script

More details can be found in our functional documentation: Camino Partner Showroom

Copy link
Author

@VjeraTurk VjeraTurk Dec 5, 2024

Choose a reason for hiding this comment

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

@SamJaarsma
@havan

I would avoid mentioning the script if it is only meant/encouraged to be used for development purposes (test accounts). Or we mention that here.

If it's ok that mainnet account are created via hardhat, we can keep it but switch the link to c4t branch once the dev is merged.

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed that live accounts should not be used for Camino, only for development on Columbus. Updated the suggestion to include that

Copy link
Author

Choose a reason for hiding this comment

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

done

Copy link
Author

Choose a reason for hiding this comment

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

done

## Partner Configuration

The Partner Configuration allows Partners to make themselves known to the Camino Network as service providers, or as looking for services from other Partners in the Network. Upon matching between services wanted and offered by two parties, such services will be then traded on Camino Messenger.

## Partner plugin

The Partner Plugin serves as a bridge enabling the Camino Messenger Bot to integrate
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The Partner Plugin serves as a bridge enabling the Camino Messenger Bot to integrate
The Partner Plugin serves as a bridge enabling the Camino Messenger Bot to integrate with the Partner distribution or inventory system.
More details can be found in our functional documentation: [Camino Messenger Bot Partner Plugin](https://docs.camino.network/partners/partner-plugin "Camino Messenger Bot Partner Plugin")

Copy link
Author

@VjeraTurk VjeraTurk Dec 5, 2024

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

oops, correct!

docs/faq/glossary.md Show resolved Hide resolved
docs/faq/glossary.md Outdated Show resolved Hide resolved
Co-authored-by: Sam Jaarsma C4T <[email protected]>
Copy link

coderabbitai bot commented Dec 5, 2024

Warning

Rate limit exceeded

@VjeraTurk has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 30 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

Reviewing files that changed from the base of the PR and between 2d8fd3f and 665fa35.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in the pull request focus on enhancing the glossary section of the docs/faq/glossary.md file. Two new entries have been added: "Camino Messenger Account" and "Partner Configuration," which describe their significance within the Camino ecosystem. Additionally, the acronym "CMA" has been introduced to represent "Camino Messenger Account." These modifications provide clearer definitions and improve the overall understanding of terminology related to the Camino Blockchain and Messenger.

Changes

File Path Change Summary
docs/faq/glossary.md Added new entries for "Camino Messenger Account" and "Partner Configuration." Updated acronym list to include "CMA" for "Camino Messenger Account."

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Glossary
    User->>Glossary: Request for definitions
    Glossary-->>User: Provide definitions for "Camino Messenger Account" and "Partner Configuration"
    User->>Glossary: Ask for acronym clarification
    Glossary-->>User: Provide "CMA" for "Camino Messenger Account"
Loading

🐇 "In the land of code where knowledge grows,
New terms arise, as the glossary shows.
With 'Camino Messenger' and 'Partner' in sight,
Clarity blooms, making learning just right!
So hop along, dear friends, and take a glance,
At the wisdom we've added—give it a chance!" 🌼


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
docs/faq/glossary.md (2)

84-88: Remove extra blank lines to maintain consistent formatting.

While the content is informative and well-written, the entry contains extra blank lines that deviate from the document's formatting style. Other entries don't have these extra spaces.

Apply this diff to fix the formatting:

 ## Camino Messenger Account
-
-
 The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings.  
 It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger.
-

444-447: Add missing newline before next section header.

The content and documentation link are excellent. However, there's a formatting issue where the "Partner plugin" section header immediately follows this entry without proper spacing.

Apply this diff to fix the formatting:

 The Partner Configuration allows Partners to make themselves known to the Camino Network as service providers, or as looking for services from other Partners in the Network. Upon matching between services wanted and offered by two parties, such services will be then traded on Camino Messenger.
 More details can be found in our functional documentation: [Camino Partner Configuration](https://docs.camino.network/partners/partner-config "Camino Partner Configuration")
+
 ## Partner plugin
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 353b978 and 2d153d7.

📒 Files selected for processing (1)
  • docs/faq/glossary.md (3 hunks)
🔇 Additional comments (2)
docs/faq/glossary.md (2)

20-20: LGTM! Acronym addition is well-formatted.

The "CMA" acronym is correctly placed in alphabetical order and follows the established format.


84-88: LGTM! New entries maintain high documentation standards.

The new entries for "Camino Messenger Account" and "Partner Configuration" are well-written, maintaining consistent style with the rest of the glossary. They provide clear technical explanations and proper cross-referencing.

Also applies to: 444-447

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
docs/faq/glossary.md (3)

84-88: Consider incorporating additional context and links

While the content is technically accurate, consider incorporating the following suggestions from previous reviews:

  1. Add information about account creation through Partner Showroom
  2. Include relevant documentation links
 ## Camino Messenger Account

 The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings.  
 It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger.
+
+The Camino Messenger Account can be created from the Partner Showroom of the [Camino Suite](https://suite.camino.network/partners) or by using a [script](https://github.com/chain4travel/camino-messenger-bot?tab=readme-ov-file#camino-messenger-account-cm-account)
+
+More details can be found in our functional documentation: [Camino Partner Showroom](https://docs.camino.network/partners/partner-showroom "Camino Partner Showroom")

446-449: Consider adding the documentation link

The entry provides a clear explanation. Consider adding the documentation link as suggested in previous reviews.

 ## Partner Configuration

 The Partner Configuration allows Partners to make themselves known to the Camino Network as service providers, or as looking for services from other Partners in the Network. Upon matching between services wanted and offered by two parties, such services will be then traded on Camino Messenger.
+More details can be found in our functional documentation: [Camino Partner Configuration](https://docs.camino.network/partners/partner-config "Camino Partner Configuration")

441-444: Fix grammar and consider adding documentation link

  1. Add a comma after "products" to improve readability
  2. Consider adding the suggested documentation link
-planning and booking various travel-related services and products often offering a
+planning and booking various travel-related services and products, often offering a
 wide range of options and choices from different suppliers.
+
+More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~441-~441: Possible missing comma found.
Context: ...ing various travel-related services and products often offering a wide range of options ...

(AI_HYDRA_LEO_MISSING_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2d153d7 and e39d9bf.

📒 Files selected for processing (1)
  • docs/faq/glossary.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/faq/glossary.md

[uncategorized] ~441-~441: Possible missing comma found.
Context: ...ing various travel-related services and products often offering a wide range of options ...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (1)
docs/faq/glossary.md (1)

20-20: LGTM: Acronym entry follows the established format

The new CMA acronym entry is properly formatted and correctly placed in alphabetical order.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
docs/faq/glossary.md (1)

84-91: Maintain consistent formatting with other entries.

While the content is accurate and well-explained, the entry contains extra blank lines that are inconsistent with the formatting of other entries in the glossary.

Apply this diff to maintain consistency:

 ## Camino Messenger Account
-
-
 The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings.  
 It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger.
-
 The Camino Messenger Account can be created from the Partner Showroom of the [Camino Suite](https://suite.camino.network/partners)  
-
 More details can be found in our functional documentation: [Camino Partner Showroom](https://docs.camino.network/partners/partner-showroom "Camino Partner Showroom")
-
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e39d9bf and 2d8fd3f.

📒 Files selected for processing (1)
  • docs/faq/glossary.md (3 hunks)
🔇 Additional comments (2)
docs/faq/glossary.md (2)

20-22: LGTM: Acronym additions are well-formatted and properly ordered.

The new acronym "CMA" and the retained "CMP" are correctly formatted, properly linked to their respective sections, and maintain alphabetical ordering.


450-455: LGTM: Partner Configuration entry is well-structured and informative.

The entry provides clear explanation of Partner Configuration's role in the Camino Network, with proper formatting and valid documentation links.

Comment on lines +445 to +448
planning and booking various travel-related services and products often offering a
wide range of options and choices from different suppliers.

More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction)
Copy link

@coderabbitai coderabbitai bot Dec 5, 2024

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove unrelated documentation link from OTA entry.

The link to Camino Messenger Protocol Documentation appears to be incorrectly placed within the OTA (Online Travel Agency) definition. This documentation link seems unrelated to the OTA concept and should be removed or moved to a more appropriate section.

Apply this diff to fix the issue:

 planning and booking various travel-related services and products often offering a
 wide range of options and choices from different suppliers.
-
-More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
planning and booking various travel-related services and products often offering a
wide range of options and choices from different suppliers.
More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction)
planning and booking various travel-related services and products often offering a
wide range of options and choices from different suppliers.

Copy link
Member

Choose a reason for hiding this comment

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

@VjeraTurk @SamJaarsma this looks valid to me, why we have it under OTA section?

Copy link

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes I agree, line 448 should be included below line 97

Comment on lines +445 to +448
planning and booking various travel-related services and products often offering a
wide range of options and choices from different suppliers.

More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction)
Copy link
Contributor

Choose a reason for hiding this comment

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

Yes I agree, line 448 should be included below line 97

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants