Skip to content

Commit 5411e73

Browse files
authored
docs: update version references (#23898)
1 parent 44bd60f commit 5411e73

File tree

8 files changed

+41
-41
lines changed

8 files changed

+41
-41
lines changed

UPGRADING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1177,8 +1177,8 @@ The `simapp` package **should not be imported in your own app**. Instead, you sh
11771177
#### App Wiring
11781178

11791179
SimApp's `app_di.go` is using [App Wiring](https://docs.cosmos.network/main/build/building-apps/app-go-di), the dependency injection framework of the Cosmos SDK.
1180-
This means that modules are injected directly into SimApp thanks to a [configuration file](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/simapp/app_config.go).
1181-
The previous behavior, without the dependency injection framework, is still present in [`app.go`](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/simapp/app.go) and is not going anywhere.
1180+
This means that modules are injected directly into SimApp thanks to a [configuration file](https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/simapp/app_config.go).
1181+
The previous behavior, without the dependency injection framework, is still present in [`app.go`](https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/simapp/app.go) and is not going anywhere.
11821182

11831183
If you are using a `app.go` without dependency injection, add the following lines to your `app.go` in order to provide newer gRPC services:
11841184

depinject/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Provider functions serve as the basis for the dependency tree. They are analysed
7575

7676
`depinject` supports the use of interface types as inputs to provider functions, which helps decouple dependencies between modules. This approach is particularly useful for managing complex systems with multiple modules, such as the Cosmos SDK, where dependencies need to be flexible and maintainable.
7777

78-
For example, `x/bank` expects an [AccountKeeper](https://pkg.go.dev/cosmossdk.io/x/bank/types#AccountKeeper) interface as [input to ProvideModule](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/bank/module.go#L208-L260). `SimApp` uses the implementation in `x/auth`, but the modular design allows for easy changes to the implementation if needed.
78+
For example, `x/bank` expects an [AccountKeeper](https://pkg.go.dev/cosmossdk.io/x/bank/types#AccountKeeper) interface as [input to ProvideModule](https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/bank/module.go#L208-L260). `SimApp` uses the implementation in `x/auth`, but the modular design allows for easy changes to the implementation if needed.
7979

8080
Consider the following example:
8181

depinject/appconfig/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ satisfy this dependency graph which allows staking and slashing to depend on eac
201201
In order to test and debug the module configuration, we need to build an app config, generally defined in a YAML file.
202202
This configuration should be passed first to `appconfig.LoadYAML` to get an `depinject.Config` instance.Then the
203203
`depinject.Config` can be passed to `depinject.Inject` and we can try to resolve dependencies in the app config.
204-
Alternatively, the `depinject.Config` can be created via [pure Go code](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/simapp/app_config.go).
204+
Alternatively, the `depinject.Config` can be created via [pure Go code](https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/simapp/app_config.go).
205205

206206
Ex:
207207

x/auth/tx/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,19 @@ This package represents the Cosmos SDK implementation of the `client.TxConfig`,
4848
The interface defines a set of methods for creating a `client.TxBuilder`.
4949

5050
```go reference
51-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/client/tx_config.go#L25-L31
51+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/client/tx_config.go#L25-L31
5252
```
5353

5454
The default implementation of `client.TxConfig` is instantiated by `NewTxConfig` in `x/auth/tx` module.
5555

5656
```go reference
57-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/auth/tx/config.go#L22-L28
57+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/auth/tx/config.go#L22-L28
5858
```
5959

6060
### `TxBuilder`
6161

6262
```go reference
63-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/client/tx_config.go#L33-L50
63+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/client/tx_config.go#L33-L50
6464
```
6565

6666
The [`client.TxBuilder`](https://docs.cosmos.network/main/core/transactions#transaction-generation) interface is as well implemented by `x/auth/tx`.

x/auth/vesting/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -78,25 +78,25 @@ type VestingAccount interface {
7878
### BaseVestingAccount
7979

8080
```protobuf reference
81-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/vesting/v1beta1/vesting.proto#L11-L35
81+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/vesting/v1beta1/vesting.proto#L11-L35
8282
```
8383

8484
### ContinuousVestingAccount
8585

8686
```protobuf reference
87-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/vesting/v1beta1/vesting.proto#L37-L46
87+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/vesting/v1beta1/vesting.proto#L37-L46
8888
```
8989

9090
### DelayedVestingAccount
9191

9292
```protobuf reference
93-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/vesting/v1beta1/vesting.proto#L48-L57
93+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/vesting/v1beta1/vesting.proto#L48-L57
9494
```
9595

9696
### Period
9797

9898
```protobuf reference
99-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/vesting/v1beta1/vesting.proto#L59-L69
99+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/vesting/v1beta1/vesting.proto#L59-L69
100100
```
101101

102102
```go
@@ -108,7 +108,7 @@ type Periods []Period
108108
### PeriodicVestingAccount
109109

110110
```protobuf reference
111-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/vesting/v1beta1/vesting.proto#L71-L81
111+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/vesting/v1beta1/vesting.proto#L71-L81
112112
```
113113

114114
In order to facilitate less ad-hoc type checking and assertions and to support flexibility in account balance usage, the existing `x/bank` `ViewKeeper` interface is updated to contain the following:
@@ -128,7 +128,7 @@ type ViewKeeper interface {
128128
### PermanentLockedAccount
129129

130130
```protobuf reference
131-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/vesting/v1beta1/vesting.proto#L83-L94
131+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/vesting/v1beta1/vesting.proto#L83-L94
132132
```
133133

134134
## Vesting Account Specification

x/evidence/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ The Cosmos SDK handles two types of evidence inside the ABCI `BeginBlock`:
219219
The evidence module handles these two evidence types the same way. First, the Cosmos SDK converts the CometBFT concrete evidence type to an SDK `Evidence` interface using `Equivocation` as the concrete type.
220220

221221
```protobuf reference
222-
https://github.com/cosmos/cosmos-sdk/blob/v0.50/proto/cosmos/evidence/v1beta1/evidence.proto#L12-L32
222+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/evidence/v1beta1/evidence.proto#L12-L32
223223
```
224224

225225
For some `Equivocation` submitted in `block` to be valid, it must satisfy:
@@ -243,7 +243,7 @@ validator to ever re-enter the validator set.
243243
The `Equivocation` evidence is handled as follows:
244244

245245
```go reference
246-
https://github.com/cosmos/cosmos-sdk/blob/v0.50/x/evidence/keeper/infraction.go#L26-L140
246+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/evidence/keeper/infraction.go#L26-L140
247247
```
248248

249249
**Note:** The slashing, jailing, and tombstoning calls are delegated through the `x/slashing` module

x/group/README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ custom decision policies, as long as they adhere to the `DecisionPolicy`
101101
interface:
102102

103103
```go reference
104-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/types.go#L27-L45
104+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/types.go#L27-L45
105105
```
106106

107107
#### Threshold decision policy
@@ -337,7 +337,7 @@ The metadata has a maximum length that is chosen by the app developer, and
337337
passed into the group keeper as a config.
338338

339339
```go reference
340-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L67-L80
340+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L67-L80
341341
```
342342

343343
It's expected to fail if
@@ -350,7 +350,7 @@ It's expected to fail if
350350
Group members can be updated with the `UpdateGroupMembers`.
351351

352352
```go reference
353-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L88-L102
353+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L88-L102
354354
```
355355

356356
In the list of `MemberUpdates`, an existing member can be removed by setting its weight to 0.
@@ -365,7 +365,7 @@ It's expected to fail if:
365365
The `UpdateGroupAdmin` can be used to update a group admin.
366366

367367
```go reference
368-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L107-L120
368+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L107-L120
369369
```
370370

371371
It's expected to fail if the signer is not the admin of the group.
@@ -375,7 +375,7 @@ It's expected to fail if the signer is not the admin of the group.
375375
The `UpdateGroupMetadata` can be used to update a group metadata.
376376

377377
```go reference
378-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L125-L138
378+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L125-L138
379379
```
380380

381381
It's expected to fail if:
@@ -388,7 +388,7 @@ It's expected to fail if:
388388
A new group policy can be created with the `MsgCreateGroupPolicy`, which has an admin address, a group id, a decision policy and some optional metadata.
389389

390390
```go reference
391-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L147-L165
391+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L147-L165
392392
```
393393

394394
It's expected to fail if:
@@ -402,7 +402,7 @@ It's expected to fail if:
402402
A new group with policy can be created with the `MsgCreateGroupWithPolicy`, which has an admin address, a list of members, a decision policy, a `group_policy_as_admin` field to optionally set group and group policy admin with group policy address and some optional metadata for group and group policy.
403403

404404
```go reference
405-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L191-L215
405+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L191-L215
406406
```
407407

408408
It's expected to fail for the same reasons as `Msg/CreateGroup` and `Msg/CreateGroupPolicy`.
@@ -412,7 +412,7 @@ It's expected to fail for the same reasons as `Msg/CreateGroup` and `Msg/CreateG
412412
The `UpdateGroupPolicyAdmin` can be used to update a group policy admin.
413413

414414
```go reference
415-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L173-L186
415+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L173-L186
416416
```
417417

418418
It's expected to fail if the signer is not the admin of the group policy.
@@ -422,7 +422,7 @@ It's expected to fail if the signer is not the admin of the group policy.
422422
The `UpdateGroupPolicyDecisionPolicy` can be used to update a decision policy.
423423

424424
```go reference
425-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L226-L241
425+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L226-L241
426426
```
427427

428428
It's expected to fail if:
@@ -435,7 +435,7 @@ It's expected to fail if:
435435
The `UpdateGroupPolicyMetadata` can be used to update a group policy metadata.
436436

437437
```go reference
438-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L246-L259
438+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L246-L259
439439
```
440440

441441
It's expected to fail if:
@@ -449,7 +449,7 @@ A new proposal can be created with the `MsgSubmitProposal`, which has a group po
449449
An optional `Exec` value can be provided to try to execute the proposal immediately after proposal creation. Proposers signatures are considered as yes votes in this case.
450450

451451
```go reference
452-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L281-L315
452+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L281-L315
453453
```
454454

455455
It's expected to fail if:
@@ -462,7 +462,7 @@ It's expected to fail if:
462462
A proposal can be withdrawn using `MsgWithdrawProposal` which has an `address` (can be either a proposer or the group policy admin) and a `proposal_id` (which has to be withdrawn).
463463

464464
```go reference
465-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L323-L333
465+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L323-L333
466466
```
467467

468468
It's expected to fail if:
@@ -476,7 +476,7 @@ A new vote can be created with the `MsgVote`, given a proposal id, a voter addre
476476
An optional `Exec` value can be provided to try to execute the proposal immediately after voting.
477477

478478
```go reference
479-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L338-L358
479+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L338-L358
480480
```
481481

482482
It's expected to fail if:
@@ -489,7 +489,7 @@ It's expected to fail if:
489489
A proposal can be executed with the `MsgExec`.
490490

491491
```go reference
492-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L363-L373
492+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L363-L373
493493
```
494494

495495
The messages that are part of this proposal won't be executed if:
@@ -502,7 +502,7 @@ The messages that are part of this proposal won't be executed if:
502502
The `MsgLeaveGroup` allows group member to leave a group.
503503

504504
```go reference
505-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/proto/cosmos/group/v1/tx.proto#L381-L391
505+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/proto/cosmos/group/v1/tx.proto#L381-L391
506506
```
507507

508508
It's expected to fail if:

x/group/internal/orm/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The orm package provides a framework for creating relational database tables wit
2121
A table can be built given a `codec.ProtoMarshaler` model type, a prefix to access the underlying prefix store used to store table data as well as a `Codec` for marshalling/unmarshalling.
2222

2323
```go reference
24-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/table.go#L30-L36
24+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/table.go#L30-L36
2525
```
2626

2727
In the prefix store, entities should be stored by an unique identifier called `RowID` which can be based either on an `uint64` auto-increment counter, string or dynamic size bytes.
@@ -42,7 +42,7 @@ The `table` struct is private, so that we only have custom tables built on top o
4242
`AutoUInt64Table` is a table type with an auto incrementing `uint64` ID.
4343

4444
```go reference
45-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/auto_uint64.go#L15-L18
45+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/auto_uint64.go#L15-L18
4646
```
4747

4848
It's based on the `Sequence` struct which is a persistent unique key generator based on a counter encoded using 8 byte big endian.
@@ -56,7 +56,7 @@ It's based on the `Sequence` struct which is a persistent unique key generator b
5656
The model provided for creating a `PrimaryKeyTable` should implement the `PrimaryKeyed` interface:
5757

5858
```go reference
59-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/primary_key.go#L30-L44
59+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/primary_key.go#L30-L44
6060
```
6161

6262
`PrimaryKeyFields()` method returns the list of key parts for a given object.
@@ -75,25 +75,25 @@ Key parts, except the last part, follow these rules:
7575
Secondary indexes can be used on `Indexable` [tables](01_table.md). Indeed, those tables implement the `Indexable` interface that provides a set of functions that can be called by indexes to register and interact with the tables, like callback functions that are called on entries creation, update or deletion to create, update or remove corresponding entries in the table secondary indexes.
7676

7777
```go reference
78-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/types.go#L88-L93
78+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/types.go#L88-L93
7979
```
8080

8181
### MultiKeyIndex
8282

8383
A `MultiKeyIndex` is an index where multiple entries can point to the same underlying object.
8484

8585
```go reference
86-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/index.go#L26-L32
86+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/index.go#L26-L32
8787
```
8888

8989
Internally, it uses an `Indexer` that manages the persistence of the index based on searchable keys and create/update/delete operations.
9090

9191
```go reference
92-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/index.go#L15-L20
92+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/index.go#L15-L20
9393
```
9494

9595
```go reference
96-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/indexer.go#L15-L19
96+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/indexer.go#L15-L19
9797
```
9898

9999
The currently used implementation of an `indexer`, `Indexer`, relies on an `IndexerFunc` that should be provided when instantiating the index. Based on the source object, this function returns one or multiple index keys as `[]interface{}`. Such secondary index keys should be bytes, string or `uint64` in order to be handled properly by the [key codec](01_table.md#key-codec) which defines specific encoding for those types.
@@ -112,19 +112,19 @@ Both [tables](01_table.md) and [secondary indexes](02_secondary_index.md) suppor
112112
An `Iterator` allows iteration through a sequence of key value pairs.
113113

114114
```go reference
115-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/types.go#L77-L85
115+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/types.go#L77-L85
116116
```
117117

118118
Tables rely on a `typeSafeIterator` that is used by `PrefixScan` and `ReversePrefixScan` `table` methods to iterate through a range of `RowID`s.
119119

120120
```go reference
121-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/table.go#L287-L291
121+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/table.go#L287-L291
122122
```
123123

124124
Secondary indexes rely on an `indexIterator` that can strip the `RowID` from the full index key in order to get the underlying value in the table prefix store.
125125

126126
```go reference
127-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/index.go#L233-L239
127+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/index.go#L233-L239
128128
```
129129

130130
Under the hood, both use a prefix store `Iterator` (alias for tm-db `Iterator`).
@@ -135,7 +135,7 @@ The `Paginate` function does pagination given an [`Iterator`](#iterator) and a `
135135
It unmarshals the results into the provided dest interface that should be a pointer to a slice of models.
136136

137137
```go reference
138-
https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/x/group/internal/orm/iterator.go#L102-L220
138+
https://github.com/cosmos/cosmos-sdk/tree/release/v0.50.x/x/group/internal/orm/iterator.go#L102-L220
139139
```
140140

141141
Secondary indexes have a `GetPaginated` method that returns an `Iterator` for the given searched secondary index key, starting from the `query.PageRequest` key if provided. It's important to note that this `query.PageRequest` key should be a `RowID` (that could have been returned by a previous paginated request). The returned `Iterator` can then be used with the `Paginate` function and the same `query.PageRequest`.

0 commit comments

Comments
 (0)