Skip to content

docs: use component terminology for exported methods #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
huklaa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: use component terminology for exported methods #239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/miden-bank/01-account-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,11 +240,11 @@ The bank requires initialization before accepting deposits: `require_initialized

### Exported vs Internal Methods

- **Trait methods** (declared in the `#[component] trait`) are exposed in the generated WIT interface and can be called by other contracts
- **Trait methods** (declared in the `#[component] trait`) are exposed in the generated WIT interface and can be called by other components
- **Inherent helpers** (in the plain `impl BankStorage`) are internal and cannot be called from the outside

```rust
// Exported: Can be called by note scripts and other contracts
// Exported: Can be called by note scripts and other components
fn get_depositor_balance(&self, depositor: AccountId, asset: Asset) -> Felt { ... }

// Internal helper, not exposed
Expand Down Expand Up @@ -497,7 +497,7 @@ impl BankStorage {
2. **`StorageValue<Word>`** stores a single Word, read with `.get()`, write with `.set()`
3. **`StorageMap<Word, Felt>`** stores key-value pairs, access with `.get()` and `.set()`
4. **Storage slots** are identified by name (IDs derived from hashed slot names), each holds 4 Felts (32 bytes)
5. **Trait methods** (declared in the `#[component] trait`) are callable by other contracts via generated bindings; private helpers live in a plain `impl` block
5. **Trait methods** (declared in the `#[component] trait`) are callable by other components via generated bindings; private helpers live in a plain `impl` block

:::tip View Complete Source
See the complete bank account implementation in [contracts/bank-account/src/lib.rs](https://github.com/0xMiden/miden-tutorials/blob/main/examples/miden-bank/contracts/bank-account/src/lib.rs).
Expand Down