Skip to content

Commit a0b0894

Browse files
crodriguezvegamergify[bot]
authored andcommitted
chore: fix broken link to bank module spec (#2201)
## Description closes: #XXXX --- Before we can merge this PR, please make sure that all the following items have been checked off. If any of the checklist items are not applicable, please leave them but write a little note why. - [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. - [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md). - [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing) - [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`) - [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code). - [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` - [x] Re-reviewed `Files changed` in the Github PR explorer - [ ] Review `Codecov Report` in the comment section below once CI passes (cherry picked from commit 1a0918d) # Conflicts: # docs/apps/transfer/params.md
1 parent 8e3edab commit a0b0894

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/apps/transfer/params.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--
2+
order: 7
3+
-->
4+
5+
# Parameters
6+
7+
The IBC transfer application module contains the following parameters:
8+
9+
| Key | Type | Default Value |
10+
|------------------|------|---------------|
11+
| `SendEnabled` | bool | `true` |
12+
| `ReceiveEnabled` | bool | `true` |
13+
14+
## `SendEnabled`
15+
16+
The transfers enabled parameter controls send cross-chain transfer capabilities for all fungible tokens.
17+
18+
To prevent a single token from being transferred from the chain, set the `SendEnabled` parameter to `true` and then, depending on the Cosmos SDK version, do one of the following:
19+
20+
- For Cosmos SDK v0.46.x or earlier, set the bank module's [`SendEnabled` parameter](https://github.com/cosmos/cosmos-sdk/blob/release/v0.46.x/x/bank/spec/05_params.md#sendenabled) for the denomination to `false`.
21+
- For Cosmos SDK versions above v0.46.x, set the bank module's `SendEnabled` entry for the denomination to `false` using `MsgSetSendEnabled` as a governance proposal.
22+
23+
## `ReceiveEnabled`
24+
25+
The transfers enabled parameter controls receive cross-chain transfer capabilities for all fungible tokens.
26+
27+
To prevent a single token from being transferred to the chain, set the `ReceiveEnabled` parameter to `true` and then, depending on the Cosmos SDK version, do one of the following:
28+
29+
- For Cosmos SDK v0.46.x or earlier, set the bank module's [`SendEnabled` parameter](https://github.com/cosmos/cosmos-sdk/blob/release/v0.46.x/x/bank/spec/05_params.md#sendenabled) for the denomination to `false`.
30+
- For Cosmos SDK versions above v0.46.x, set the bank module's `SendEnabled` entry for the denomination to `false` using `MsgSetSendEnabled` as a governance proposal.

0 commit comments

Comments
 (0)