LaconicNetwork/cosmos-sdk
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

chore: small improvements (#13672)

Browse Source 
* ci: update buf

* add recommended vscode extension

* update gh username

* follow-up #13613

* add more sugestions

* remove atlas github action
This commit is contained in:
Julien Robert
2022-10-26 22:47:28 +00:00
committed by GitHub
parent f73e426b22
commit c303d7f341
8 changed files with 36 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/architecture/adr-060-abci-1.0.md
+1 -1
View File
@@ -2,7 +2,7 @@
## Changelog
* 2022-08-10: Initial Draft (@alexanderbez, @marbar3778)
* 2022-08-10: Initial Draft (@alexanderbez, @tac0turtle)
## Status
docs/docs/building-modules/04-query-services.md
+10 -19
View File
@@ -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.
* 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.
* 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.
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
* 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
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/rapid@v0.5.3) 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.
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
```
docs/docs/building-modules/14-testing.md
+15
View File
@@ -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/rapid@v0.5.3) 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):