Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ const config: Config = {
src: "img/logo.png",
alt: "Miden Logo",
height: 240,
href: "/protocol",
},
title: "MIDEN",
items: [
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Accounts / Smart Contracts

An `Account` represents the primary entity in Miden. It is capable of holding assets, storing data, and executing custom code. Each `Account` is a smart contract with a programmable interface through which note and transaction scripts can interact with the account's state and assets. By executing [transactions](../transaction) against an account, its state can be modified.
An `Account` represents the primary entity in Miden. It is capable of holding assets, storing data, and executing custom code. Each `Account` is a smart contract with a programmable interface through which note and transaction scripts can interact with the account's state and assets. By executing [transactions](../transaction.md) against an account, its state can be modified.

## What is the purpose of an account?

Expand Down Expand Up @@ -46,7 +46,7 @@ Note that a transaction does not always change the state of an account. For inst

## Account creation

For an `Account` to be recognized by the network, it must exist in the [account database](../state#account-database) maintained by Miden node(s).
For an `Account` to be recognized by the network, it must exist in the [account database](../state.md#account-database) maintained by Miden node(s).

However, a user can locally create a new `Account` ID before it's recognized network-wide. The typical process might be:

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
12 changes: 6 additions & 6 deletions docs/src/index.md → docs/src/protocol/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,19 @@ An [Account](account/index.md) can hold assets and define rules how assets can b

### Notes

A [Note](note) is a message that accounts send to each other. A note stores assets and a script that defines how the note can be consumed. The [note chapter](note) describes the design, the storage types, and the creation of a note.
A [Note](note.md) is a message that accounts send to each other. A note stores assets and a script that defines how the note can be consumed. The [note chapter](note.md) describes the design, the storage types, and the creation of a note.

### Assets

An [Asset](asset) can be fungible and non-fungible. They are stored in the owner's account itself or in a note. The [asset chapter](asset) describes asset issuance, customization, and storage.
An [Asset](asset.md) can be fungible and non-fungible. They are stored in the owner's account itself or in a note. The [asset chapter](asset.md) describes asset issuance, customization, and storage.

### Transactions

A [Transaction](transaction) describes the production and consumption of notes by a single account.
A [Transaction](transaction.md) describes the production and consumption of notes by a single account.

Executing a transaction always results in a STARK proof.

The [transaction chapter](transaction) describes the transaction design and implementation, including an in-depth discussion of how transaction execution happens in the transaction kernel program.
The [transaction chapter](transaction.md) describes the transaction design and implementation, including an in-depth discussion of how transaction execution happens in the transaction kernel program.

#### Accounts produce and consume notes to communicate

Expand All @@ -59,11 +59,11 @@ Miden's state model captures the individual states of all accounts and notes, an

### State model

[State](state) describes everything that is the case at a certain point in time. Individual states of accounts or notes can be stored on-chain and off-chain. This chapter describes the three different state databases in Miden.
[State](state.md) describes everything that is the case at a certain point in time. Individual states of accounts or notes can be stored on-chain and off-chain. This chapter describes the three different state databases in Miden.

### Blockchain

The [Blockchain](blockchain) defines how state progresses as aggregated-state-updates in batches, blocks, and epochs. The [blockchain chapter](blockchain) describes the execution model and how blocks are built.
The [Blockchain](blockchain.md) defines how state progresses as aggregated-state-updates in batches, blocks, and epochs. The [blockchain chapter](blockchain.md) describes the execution model and how blocks are built.

##### Operators capture and progress state

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/src/standards/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
label: "Standards"
# Determines where this documentation section appears relative to other sections on the main documentation page (which is the parent of this folder in the miden-docs repository)
position: 4
collapsed: true
12 changes: 12 additions & 0 deletions docs/src/standards/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 1
title: Overview
---

# Miden Standards

:::note
Placeholder. Documentation for the components published by `miden-standards` will land here in follow-up PRs.
:::

The `miden-standards` crate provides reusable account components that build on top of the [protocol](../protocol/index.md) primitives. Examples include faucet components, authentication components, access-control components, and mint/burn policies.
Loading