Skip to content

Commit 7ea500c

Browse files
committed
lint docs same as docs-lint pr
1 parent e0443a8 commit 7ea500c

File tree

20 files changed

+254
-253
lines changed

20 files changed

+254
-253
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
3434

3535
## Enforcement
3636

37-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at community@interchain.io. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <community@interchain.io>. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
3838

3939
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
4040

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ contributors to help continually secure our operations.
1515
| All [actively supported releases branches](./RELEASES.md#stable-release-policy) |
1616
| main branch |
1717

18-
All actively supported release branches (see table in [section Stable Release Policy in RELEASES.md](./RELEASES.md#stable-release-policy))
19-
of this repository are supported for security updates as well as the **main**
18+
All actively supported release branches (see table in [section Stable Release Policy in RELEASES.md](./RELEASES.md#stable-release-policy))
19+
of this repository are supported for security updates as well as the **main**
2020
branch. Security vulnerabilities should be reported if the vulnerability can be
2121
reproduced on either one of those.
2222

docs/apps/transfer/client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ Example output:
6363
{
6464
"amount": "100"
6565
}
66-
```
66+
```

docs/architecture/adr-008-app-caller-cbs/adr-008-app-caller-cbs.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ This setup worked well for off-chain users interacting with IBC applications.
1818
We are now seeing the desire for secondary applications (e.g. smart contracts, modules) to call into IBC apps as part of their state machine logic and then do some actions on the basis of the packet result. Or to receive a packet from IBC and do some logic upon receipt.
1919

2020
Example Usecases:
21-
- Send an ICS-20 packet, and if it is successful, then send an ICA-packet to swap tokens on LP and return funds to sender
22-
- Execute some logic upon receipt of token transfer to a smart contract address
21+
* Send an ICS-20 packet, and if it is successful, then send an ICA-packet to swap tokens on LP and return funds to sender
22+
* Execute some logic upon receipt of token transfer to a smart contract address
2323

2424
This requires a second layer of callbacks. The IBC application already gets the result of the packet from core IBC, but currently there is no standardized way to pass this information on to an actor module/smart contract.
2525

2626
## Definitions
2727

28-
- Actor: an actor is an on-chain module (this may be a hardcoded module in the chain binary or a smart contract) that wishes to execute custom logic whenever IBC receives a packet flow that it has either sent or received. It **must** be addressable by a string value.
28+
* Actor: an actor is an on-chain module (this may be a hardcoded module in the chain binary or a smart contract) that wishes to execute custom logic whenever IBC receives a packet flow that it has either sent or received. It **must** be addressable by a string value.
2929

3030
## Decision
3131

@@ -113,7 +113,7 @@ IBC Apps or middleware can then call the IBCActor callbacks like so in their own
113113
### Handshake Callbacks
114114

115115
The `OnChanOpenInit` handshake callback will need to include an additional field so that the initiating actor can be tracked and called upon during handshake completion.
116-
The actor provided in the `OnChanOpenInit` callback will be the signer of the `MsgChanOpenInit` message.
116+
The actor provided in the `OnChanOpenInit` callback will be the signer of the `MsgChanOpenInit` message.
117117

118118
```go
119119
func OnChanOpenInit(
@@ -188,7 +188,7 @@ func OnChanCloseConfirm(
188188
}
189189
```
190190

191-
NOTE: The handshake calls `OnChanOpenTry` and `OnChanOpenConfirm` are explicitly left out as it is still to be determined how the actor of the `OnChanOpenTry` step should be provided. Initially only the initiating side of the channel handshake may support setting a channel actor, future improvements should allow both sides of the channel handshake to set channel actors.
191+
NOTE: The handshake calls `OnChanOpenTry` and `OnChanOpenConfirm` are explicitly left out as it is still to be determined how the actor of the `OnChanOpenTry` step should be provided. Initially only the initiating side of the channel handshake may support setting a channel actor, future improvements should allow both sides of the channel handshake to set channel actors.
192192

193193
### PacketCallbacks
194194

@@ -402,20 +402,20 @@ Chains are expected to specify a `chainDefinedActorCallbackLimit` to ensure that
402402

403403
### Positive
404404

405-
- IBC Actors can now programatically execute logic that involves sending a packet and then performing some additional logic once the packet lifecycle is complete
406-
- Middleware implementing ADR-8 can be generally used for any application
407-
- Leverages the same callback architecture used between core IBC and IBC applications
405+
* IBC Actors can now programatically execute logic that involves sending a packet and then performing some additional logic once the packet lifecycle is complete
406+
* Middleware implementing ADR-8 can be generally used for any application
407+
* Leverages the same callback architecture used between core IBC and IBC applications
408408

409409
### Negative
410410

411-
- Callbacks may now have unbounded gas consumption since the actor may execute arbitrary logic. Chains implementing this feature should take care to place limitations on how much gas an actor callback can consume.
411+
* Callbacks may now have unbounded gas consumption since the actor may execute arbitrary logic. Chains implementing this feature should take care to place limitations on how much gas an actor callback can consume.
412412

413413
### Neutral
414414

415-
- Application packets that want to support ADR-8 must additionally have their packet data implement the `CallbackPacketData` interface and register their implementation on the chain codec
415+
* Application packets that want to support ADR-8 must additionally have their packet data implement the `CallbackPacketData` interface and register their implementation on the chain codec
416416

417417
## References
418418

419-
- [Original issue](https://github.com/cosmos/ibc-go/issues/1660)
420-
- [CallbackPacketData interface implementation](https://github.com/cosmos/ibc-go/pull/3287)
421-
- [ICS 20, ICS 27 implementations of the CallbackPacketData interface](https://github.com/cosmos/ibc-go/pull/3287)
419+
* [Original issue](https://github.com/cosmos/ibc-go/issues/1660)
420+
* [CallbackPacketData interface implementation](https://github.com/cosmos/ibc-go/pull/3287)
421+
* [ICS 20, ICS 27 implementations of the CallbackPacketData interface](https://github.com/cosmos/ibc-go/pull/3287)

0 commit comments

Comments
 (0)