Skip to content

Commit

Permalink
Merge pull request #4148 from anoma/zjcio-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
mergify[bot] authored Dec 11, 2024
2 parents 8f11599 + 4ac07cd commit 0af3996
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 14 deletions.
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
Examples of behavior that contribute to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
Expand Down Expand Up @@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand Down
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,16 @@

## Overview

[Namada](http://namada.net) is a Proof-of-Stake L1 for interchain asset-agnostic privacy. Namada uses CometBFT
[Namada](http://namada.net) is a Proof-of-Stake L1 for multichain asset-agnostic data protection. Namada uses CometBFT
consensus and enables multi-asset shielded transfers for any native
or non-native asset. Namada features full IBC protocol support,
a natively integrated Ethereum bridge, a modern proof-of-stake
system with automatic reward compounding and cubic slashing, and a
stake-weighted governance signalling mechanism. Users of shielded
transfers are rewarded for their contributions to the privacy set in
or non-native asset. Namada features full IBC protocol support, a modern proof-of-stake
system with cubic slashing, and a
stake-weighted on-chain governance mechanism. Users of Namada's MASP (Multi-Asset Shielded Pool) are rewarded for their contributions to the shielded set in
the form of native protocol tokens. A multi-asset shielded transfer
wallet is provided in order to facilitate safe and private user
wallet is provided in order to facilitate safe user
interaction with the protocol.

* Blogpost: [Introducing Namada: Interchain Asset-agnostic Privacy](https://namada.net/blog/introducing-namada-multichain-asset-agnostic-data-protection)
* Blogpost: [Introducing Namada: Multichain Asset-agnostic Data Protection](https://namada.net/blog/introducing-namada-multichain-asset-agnostic-data-protection)

## 📓 Docs

Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ This example is run as follows:
cargo run --example generate-txs -- <vectors.json> <debugs.txt>
```
where `<vectors.json>` is the path where the JSON test vectors will be stored
and `<debugs.txt>` is where rust `Debug` representations oof this data will be
and `<debugs.txt>` is where rust `Debug` representations of this data will be
stored.
2 changes: 1 addition & 1 deletion fuzz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- Run e.g. `make fuzz-txs-mempool` (uses nightly)
- If there is any crash, the fuzzer has found an issue. Read the stack trace for details. It will also print instructions on how to re-run the same case.
- When there are no panics you'll see it printing statistics. E.g. `cov: 26771 ft: 111572 corp: 2688/1423Kb lim: 2369 exec/s: 39 rss: 647Mb L: 2232/2335 MS: 5`
- The important stat you'll want to look watch is the very first one - `cov` - "Total number of code blocks or edges covered by executing the current corpus." (more details at <https://llvm.org/docs/LibFuzzer.html#output>)
- The important stat you'll want to watch is the very first one - `cov` - "Total number of code blocks or edges covered by executing the current corpus." (more details at <https://llvm.org/docs/LibFuzzer.html#output>)
- After the number in `cov` seems to have settled and is no longer increasing, the fuzzer has most likely explored all possible branches. We're going to check that next with coverage.
- To generate raw coverage data, run e.g. `cargo +$(cat rust-nightly-version) fuzz coverage txs_mempool --dev`. This will create `fuzz/coverage/txs_mempool/coverage.profdata` (the path gets printed at the end).
- To turn the raw coverage data into a report:
Expand Down
2 changes: 0 additions & 2 deletions genesis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ The [tokens.toml file](tokens.toml) contains tokens with their aliases and valid

The [balances.toml file](balances.toml) contains token balances associated with the public keys.

TODO: add shielded balances

## Parameters

The [parameters.toml file](parameters.toml) contains the general chain parameters, PoS and governance parameters.
Expand Down

0 comments on commit 0af3996

Please sign in to comment.