docs: update links for https security protocol #22514
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces several changes across multiple documentation files. It updates URLs from HTTP to HTTPS in the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
docs/architecture/adr-032-typed-events.md (2)
25-25: Fix grammatical issues for better readabilityThere are several grammatical improvements needed in this paragraph:
- Add a comma after "In addition"
- Use hyphenation for the compound adjective "event-driven" consistently
Apply these changes:
- [Our platform](https://github.com/akash-network/node) requires a number of programmatic on chain interactions both on the provider (datacenter - to bid on new orders and listen for leases created) and user (application developer - to send the app manifest to the provider) side. In addition the Akash team is now maintaining the IBC [`relayer`](https://github.com/ovrclk/relayer), another very event driven process. In working on these core pieces of infrastructure, and integrating lessons learned from Kubernetes development, our team has developed a standard method for defining and consuming typed events in Cosmos SDK modules. We have found that it is extremely useful in building this type of event driven application. + [Our platform](https://github.com/akash-network/node) requires a number of programmatic on chain interactions both on the provider (datacenter - to bid on new orders and listen for leases created) and user (application developer - to send the app manifest to the provider) side. In addition, the Akash team is now maintaining the IBC [`relayer`](https://github.com/ovrclk/relayer), another very event-driven process. In working on these core pieces of infrastructure, and integrating lessons learned from Kubernetes development, our team has developed a standard method for defining and consuming typed events in Cosmos SDK modules. We have found that it is extremely useful in building this type of event-driven application.🧰 Tools
🪛 LanguageTool
[typographical] ~25-~25: Consider adding a comma after this introductory phrase.
Context: ... app manifest to the provider) side. In addition the Akash team is now maintaining the I...(IN_GENERAL_COMMA)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...ithub.com/ovrclk/relayer), another very event driven process. In working on these core piece...(DRIVEN_HYPHEN)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...tremely useful in building this type of event driven application. As the Cosmos SDK gets us...(DRIVEN_HYPHEN)
Line range hint
1-24: Consider enhancing the ADR with additional sectionsThe ADR is well-structured but could benefit from additional clarity in a few areas:
- Given the concrete implementation details, consider updating the status from "Proposed" to "Accepted" or clarify if this is still under discussion.
- Add a section about backward compatibility and migration strategy for existing applications.
- Consider adding a section about testing strategy for typed events.
Would you like assistance in drafting these additional sections?
🧰 Tools
🪛 LanguageTool
[typographical] ~25-~25: Consider adding a comma after this introductory phrase.
Context: ... app manifest to the provider) side. In addition the Akash team is now maintaining the I...(IN_GENERAL_COMMA)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...ithub.com/ovrclk/relayer), another very event driven process. In working on these core piece...(DRIVEN_HYPHEN)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...tremely useful in building this type of event driven application. As the Cosmos SDK gets us...(DRIVEN_HYPHEN)
[uncategorized] ~27-~27: The adjective “event-driven” is spelled with a hyphen.
Context: .... there will be an exploding demand for event driven applications to support new features de...(DRIVEN_HYPHEN)
[uncategorized] ~27-~27: The adjective “event-driven” is spelled with a hyphen.
Context: ...pplications to quickly and easily build event driven apps to aid their core application. Wal...(DRIVEN_HYPHEN)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (3)
CODE_OF_CONDUCT.md(1 hunks)docs/architecture/adr-032-typed-events.md(1 hunks)docs/spec/_ics/ics-030-signed-messages.md(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- CODE_OF_CONDUCT.md
- docs/spec/_ics/ics-030-signed-messages.md
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/adr-032-typed-events.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/architecture/adr-032-typed-events.md
[typographical] ~25-~25: Consider adding a comma after this introductory phrase.
Context: ... app manifest to the provider) side. In addition the Akash team is now maintaining the I...
(IN_GENERAL_COMMA)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...ithub.com/ovrclk/relayer), another very event driven process. In working on these core piece...
(DRIVEN_HYPHEN)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...tremely useful in building this type of event driven application. As the Cosmos SDK gets us...
(DRIVEN_HYPHEN)
| @@ -22,7 +22,7 @@ Currently in the Cosmos SDK, events are defined in the handlers for each message | |||
|
|
|||
| Currently in the Cosmos SDK, events are defined in the handlers for each message, meaning each module doesn't have a canonical set of types for each event. Above all else this makes these events difficult to consume as it requires a great deal of raw string matching and parsing. This proposal focuses on updating the events to use **typed events** defined in each module such that emitting and subscribing to events will be much easier. This workflow comes from the experience of the Akash Network team. | |||
|
|
|||
| [Our platform](http://github.com/ovrclk/akash) requires a number of programmatic on chain interactions both on the provider (datacenter - to bid on new orders and listen for leases created) and user (application developer - to send the app manifest to the provider) side. In addition the Akash team is now maintaining the IBC [`relayer`](https://github.com/ovrclk/relayer), another very event driven process. In working on these core pieces of infrastructure, and integrating lessons learned from Kubernetes development, our team has developed a standard method for defining and consuming typed events in Cosmos SDK modules. We have found that it is extremely useful in building this type of event driven application. | |||
| [Our platform](https://github.com/akash-network/node) requires a number of programmatic on chain interactions both on the provider (datacenter - to bid on new orders and listen for leases created) and user (application developer - to send the app manifest to the provider) side. In addition the Akash team is now maintaining the IBC [`relayer`](https://github.com/ovrclk/relayer), another very event driven process. In working on these core pieces of infrastructure, and integrating lessons learned from Kubernetes development, our team has developed a standard method for defining and consuming typed events in Cosmos SDK modules. We have found that it is extremely useful in building this type of event driven application. | |||
There was a problem hiding this comment.
could u replace the relayer link too?
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/architecture/adr-032-typed-events.md (1)
25-25: Fix grammatical and typographical issuesSeveral improvements needed in this paragraph:
- Add a comma after "In addition"
- Use hyphenated form "event-driven" instead of "event driven"
- The link to the relayer repository should use HTTPS
Apply these changes:
-[Our platform](https://github.com/akash-network/node) requires a number of programmatic on chain interactions both on the provider (datacenter - to bid on new orders and listen for leases created) and user (application developer - to send the app manifest to the provider) side. In addition the Akash team is now maintaining the IBC [`relayer`](https://github.com/cosmos/relayer), another very event driven process. In working on these core pieces of infrastructure, and integrating lessons learned from Kubernetes development, our team has developed a standard method for defining and consuming typed events in Cosmos SDK modules. We have found that it is extremely useful in building this type of event driven application. +[Our platform](https://github.com/akash-network/node) requires a number of programmatic on chain interactions both on the provider (datacenter - to bid on new orders and listen for leases created) and user (application developer - to send the app manifest to the provider) side. In addition, the Akash team is now maintaining the IBC [`relayer`](https://github.com/cosmos/relayer), another very event-driven process. In working on these core pieces of infrastructure, and integrating lessons learned from Kubernetes development, our team has developed a standard method for defining and consuming typed events in Cosmos SDK modules. We have found that it is extremely useful in building this type of event-driven application.🧰 Tools
🪛 LanguageTool
[typographical] ~25-~25: Consider adding a comma after this introductory phrase.
Context: ... app manifest to the provider) side. In addition the Akash team is now maintaining the I...(IN_GENERAL_COMMA)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...ithub.com/cosmos/relayer), another very event driven process. In working on these core piece...(DRIVEN_HYPHEN)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...tremely useful in building this type of event driven application. As the Cosmos SDK gets us...(DRIVEN_HYPHEN)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
docs/architecture/adr-032-typed-events.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/adr-032-typed-events.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/architecture/adr-032-typed-events.md
[typographical] ~25-~25: Consider adding a comma after this introductory phrase.
Context: ... app manifest to the provider) side. In addition the Akash team is now maintaining the I...
(IN_GENERAL_COMMA)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...ithub.com/cosmos/relayer), another very event driven process. In working on these core piece...
(DRIVEN_HYPHEN)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...tremely useful in building this type of event driven application. As the Cosmos SDK gets us...
(DRIVEN_HYPHEN)
🔇 Additional comments (1)
docs/architecture/adr-032-typed-events.md (1)
Line range hint 1-24: Technical content looks good
The ADR is well-structured and provides:
- Clear problem statement and motivation
- Detailed implementation steps with code examples
- Comprehensive guidance for consuming typed events
- Proper integration with protobuf
Also applies to: 26-999
🧰 Tools
🪛 LanguageTool
[uncategorized] ~23-~23: Possible missing comma found.
Context: ... set of types for each event. Above all else this makes these events difficult to co...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~25-~25: Consider adding a comma after this introductory phrase.
Context: ... app manifest to the provider) side. In addition the Akash team is now maintaining the I...
(IN_GENERAL_COMMA)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...ithub.com/cosmos/relayer), another very event driven process. In working on these core piece...
(DRIVEN_HYPHEN)
[uncategorized] ~25-~25: The adjective “event-driven” is spelled with a hyphen.
Context: ...tremely useful in building this type of event driven application. As the Cosmos SDK gets us...
(DRIVEN_HYPHEN)
[uncategorized] ~27-~27: The adjective “event-driven” is spelled with a hyphen.
Context: .... there will be an exploding demand for event driven applications to support new features de...
(DRIVEN_HYPHEN)
[uncategorized] ~27-~27: The adjective “event-driven” is spelled with a hyphen.
Context: ...pplications to quickly and easily build event driven apps to aid their core application. Wal...
(DRIVEN_HYPHEN)
* main: (31 commits) docs: update links for https security protocol (#22514) build(deps): Bump github.com/bytedance/sonic from 1.12.3 to 1.12.4 in /log (#22513) feat(x/protocolpool)!: allow any coins in continuous funds (#21916) docs: Update protobuf tx signing message format outer link (#22510) test(accounts): fix integration tests (#22418) chore(x): fix some typos in comment (#22508) build(deps): Bump cosmossdk.io/log from 1.4.1 to 1.5.0 (#22487) build(deps): Bump cosmossdk.io/core from 1.0.0-alpha.5 to 1.0.0-alpha.6 (#22502) build(deps): Bump golang.org/x/crypto from 0.28.0 to 0.29.0 (#22480) docs(adr75): server v2 (#21069) fix(server/v2): improve server stop (#22455) chore: prepare core changelog (#22495) refactor(store/v2): simplify genesis flow (#22435) build(deps): Bump google.golang.org/grpc from 1.67.1 to 1.68.0 (#22486) build(deps): Bump golang.org/x/sync from 0.8.0 to 0.9.0 (#22482) feat(x/circuit): Allow msg Reset with empty msgURL (#22459) build(deps): Bump actions/xxx-artifact from v3 to v4 (#22468) feat(stf/branch): simplify merged iterator (#22131) refactor(log): disable coloring in testing logger (#22466) chore(x/tx): update changelog to alpha.2 (#22465) ...
Description
update links for https security protocol and new links
Summary by CodeRabbit