Technical Documentation
These pages describe Nami at the infrastructure product level.
The technical documentation examines the architecture, contracts, and mechanisms that implement the protocol.
It is published on GitHub and maintained alongside the evolution of the codebase.
Contents
The repository contains technical specifications for the systems that comprise Nami.
Depending on the component, the documentation may cover:
- architecture and interactions between contracts;
- on-chain flows and state transitions;
- value flows and accounting;
- roles, permissions, and timing constraints;
- calculation, settlement, and verification processes;
- external dependencies and security assumptions;
- architectural diagrams and operational sequences.
The repository's README contains the current index and provides access to the available documentation.
Intended Audience
The technical documentation is intended for auditors, security researchers, developers, and integrators seeking to analyze Nami's systems, verify their behavior, or interact with its contracts.
It can also be used to examine the protocol in greater depth without starting directly from the source code.
Code and Deployments
The documentation supports analysis of the codebase but does not replace the source code.
The protocol's effective behavior is determined by the deployed contracts, their configuration, and the current state of the system.