Skip to content

Commit

Permalink
chore: small improvements (cosmos#13672)
Browse files Browse the repository at this point in the history
* ci: update buf

* add recommended vscode extension

* update gh username

* follow-up cosmos#13613

* add more sugestions

* remove atlas github action
  • Loading branch information
julienrbrt authored Oct 26, 2022
1 parent f73e426 commit c303d7f
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 81 deletions.
58 changes: 0 additions & 58 deletions .github/workflows/atlas.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/cosmovisor-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Release Cosmovisor
on:
push:
tags:
- "cosmovisor/v*.*.*"
- "tools/cosmovisor/v*.*.*"
permissions:
contents: read

Expand Down
7 changes: 7 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"golang.go",
"bufbuild.vscode-buf",
"davidanson.vscode-markdownlint"
]
}
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ To synchronize we have few major meetings:
* Cosmos SDK Sprint Review on Monday and Thursday at 14:00 UTC (limited participation to core devs).
* Cosmos SDK Community Call on Thursday at 16:00 UTC.

If you would like to join one of the community call, then please contact us on [Discord](https://discord.com/invite/cosmosnetwork) or reach out directly to Marko (@marbar3778).
If you would like to join one of the community call, then please contact us on [Discord](https://discord.com/invite/cosmosnetwork) or reach out directly to Marko (@tac0turtle).

## Architecture Decision Records (ADR)

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ protoImageName=ghcr.io/cosmos/proto-builder:$(protoVer)
containerProtoGen=$(PROJECT_NAME)-proto-gen-$(protoVer)
containerProtoGenSwagger=$(PROJECT_NAME)-proto-gen-swagger-$(protoVer)
containerProtoFmt=$(PROJECT_NAME)-proto-fmt-$(protoVer)
DOCKER_BUF := $(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace bufbuild/buf:1.7.0
DOCKER_BUF := $(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace bufbuild/buf:1.9.0

proto-all: proto-format proto-lint proto-gen

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/adr-060-abci-1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Changelog

* 2022-08-10: Initial Draft (@alexanderbez, @marbar3778)
* 2022-08-10: Initial Draft (@alexanderbez, @tac0turtle)

## Status

Expand Down
29 changes: 10 additions & 19 deletions docs/docs/building-modules/04-query-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,27 +58,18 @@ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/x/bank/keeper/grpc_query.go
### Calling queries from the State Machine

The Cosmos SDK v0.47 introduces a new `cosmos.query.v1.module_query_safe` Protobuf annotation which is used to state that a query that is safe to be called from within the state machine, for example:
- a Keeper's query function can be called from another module's Keeper,
- ADR-033 intermodule query calls,
- CosmWasm contracts can also directly interact with these queries.

If the `module_query_safe` annotation set to `true`, it means:
- The query is deterministic: given a block height it will return the same response upon multiple calls, and doesn't introduce any state-machine breaking changes across SDK patch versions.
- Gas consumption never fluctuates across calls and across patch versions.
* a Keeper's query function can be called from another module's Keeper,
* ADR-033 intermodule query calls,
* CosmWasm contracts can also directly interact with these queries.

If you are a module developer and want to use `module_query_safe` annotation for your own query, you have to ensure the following things:
- the query is deterministic and won't introduce state-machine-breaking changes without coordinated upgrades
- it has its gas tracked, to avoid the attack vector where no gas is accounted for
on potentially high-computation queries.

#### Deterministic and Regression tests
If the `module_query_safe` annotation set to `true`, it means:

Tests are written for queries in the Cosmos SDK which have `module_query_safe`. Each query is tested using 2 methods:
- we use property-based testing using the [`rapid`](https://pkg.go.dev/pgregory.net/[email protected]) library. The property that is tested is that the query response and gas consumption are the same upon 1000 query calls.
- we write regression tests with hardcoded responses and gas, and make sure they don't change upon 1000 calls and between SDK patch versions.
* The query is deterministic: given a block height it will return the same response upon multiple calls, and doesn't introduce any state-machine breaking changes across SDK patch versions.
* Gas consumption never fluctuates across calls and across patch versions.

Here's an example of regression tests:
If you are a module developer and want to use `module_query_safe` annotation for your own query, you have to ensure the following things:

```go reference
https://github.com/cosmos/cosmos-sdk/blob/9f3575a10f1a6f1315b94a9be783df5156ce2292/tests/integration/bank/keeper/deterministic_test.go#L102-L115
```
* the query is deterministic and won't introduce state-machine-breaking changes without coordinated upgrades
* it has its gas tracked, to avoid the attack vector where no gas is accounted for
on potentially high-computation queries.
15 changes: 15 additions & 0 deletions docs/docs/building-modules/14-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,21 @@ Now the types are injected and we can use them for our tests:
https://github.com/cosmos/cosmos-sdk/blob/e09516f4795c637ab12b30bf732ce5d86da78424/tests/integration/distribution/keeper/keeper_test.go#L21-L53
```

## Deterministic and Regression tests

Tests are written for queries in the Cosmos SDK which have `module_query_safe` Protobuf annotation.

Each query is tested using 2 methods:

* Use property-based testing with the [`rapid`](https://pkg.go.dev/pgregory.net/[email protected]) library. The property that is tested is that the query response and gas consumption are the same upon 1000 query calls.
* Regression tests are written with hardcoded responses and gas, and verify they don't change upon 1000 calls and between SDK patch versions.

Here's an example of regression tests:

```go reference
https://github.com/cosmos/cosmos-sdk/blob/9f3575a10f1a6f1315b94a9be783df5156ce2292/tests/integration/bank/keeper/deterministic_test.go#L102-L115
```

## Simulations

Simulations uses as well a minimal application, built with [`depinject`](../building-apps/01-depinject.md):
Expand Down

0 comments on commit c303d7f

Please sign in to comment.