Skip to content

Commit ad594a8

Browse files
authored
Only run Rust workflow on particular set of files (#387)
1 parent a0f6ff4 commit ad594a8

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

.github/workflows/rust.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@ name: Rust
22

33
on:
44
push:
5-
branches: ["main"]
5+
branches: [ "main" ]
6+
paths-ignore:
7+
- '**.md'
68
pull_request:
7-
branches: ["main"]
9+
branches: [ "main" ]
10+
paths-ignore:
11+
- '**.md'
812

913
env:
1014
CARGO_TERM_COLOR: always

module-system/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ pub struct Bank<C: sov_modules_api::Context> {
2929
}
3030
```
3131

32-
At first glance, this definition might seem a little bit intimidating because of the generic `C`. Don't worry, we'll explain that
33-
generic in detail later. For now, just notice that a module is a struct with an address and some `#[state]` fields specifying
32+
At first glance, this definition might seem a little bit intimidating because of the generic `C`.
33+
Don't worry, we'll explain that generic in detail later.
34+
For now, just notice that a module is a struct with an address and some `#[state]` fields specifying
3435
what kind of data this module has access to. Under the hood, the `ModuleInfo` derive macro will do some magic to ensure that
3536
any `#[state]` fields get mapped onto unique storage keys so that only this particular module can read or write its state values.
3637

@@ -175,7 +176,7 @@ pub trait Spec {
175176

176177
As you can see, a `Spec` for a rollup specifies the concrete types that will be used for many kinds of cryptographic operations.
177178
That way, you can define your business logic in terms of _abstract_ cryptography, and then instantiate it with cryptography which
178-
is efficient in your particular choice of zkvm.
179+
is efficient in your particular choice of ZKVM.
179180

180181
In addition to the `Spec` trait, the Module System provides a simple `Context` trait which is defined like this:
181182

@@ -191,7 +192,7 @@ pub trait Context: Spec + Clone + Debug + PartialEq {
191192
Modules are expected to be generic over the `Context` type. This trait gives them a convenient handle to access all of the cryptographic operations
192193
defined by a `Spec`, while also making it easy for the Module System to pass in authenticated transaction-specific information which
193194
would not otherwise be available to a module. Currently, a `Context` is only required to contain the `sender` (signer) of the transaction,
194-
but this trait might be extended in future.
195+
but this trait might be extended in the future.
195196

196197
Putting it all together, recall that the Bank struct is defined like this.
197198

0 commit comments

Comments
 (0)