Skip to content

notareum/docs

Repository files navigation

Notareum Protocol Documentation

The Trust Layer for Web3

Open protocol for verified blockchain resource sharing. One file format. Every chain. Cryptographically verifiable.

Notareum is a Universal Transfer Interface (UTI) protocol that replaces error-prone copy-paste address sharing with verifiable .nota files: portable, cryptographically signed containers for any blockchain resource. A .nota file can represent a wallet address, smart contract, transaction hash, NFT, or IPFS content identifier. It carries chain context, verification status, and a cryptographic signature that proves the resource is exactly what it claims to be.

The protocol is secured by a decentralized network of staked validators who attest to resource authenticity, governed by the $NOTA token and its vote-escrowed counterpart veNOTA. Any wallet, exchange, or on-chain application can parse a .nota file, verify its signature, and check validator attestations before a user commits a transaction. The result is a drop-in identity layer for every chain that works without central authorities, custodians, or trusted intermediaries.

Notareum is open source. The protocol specification, smart contracts, SDKs in TypeScript, Python, and Rust, and a growing library of examples are all available on GitHub. This documentation covers the full protocol, token design, developer tooling, operator guides, and integration patterns.

Architecture at a glance

flowchart TD
    A[User or dapp] -->|creates| B[.nota file]
    B -->|signed with private key| C[SDK: TS / Py / Rs]
    C -->|register| D[NotaRegistry contract]
    C -->|request verification| E[VerificationEngine]
    E -->|attestations| F[Validator network]
    F -->|quorum met| G[Verified on-chain]
    G -->|portable proof| H[Wallet / Exchange / dapp]
    H -->|verifies signature + status| A
Loading

Quick links

Who this is for

  • Wallet and dapp developers integrating verified resource sharing.
  • Exchange and custodian teams hardening deposit flows against phishing.
  • Validator operators staking NOTA to attest to resources.
  • Protocol designers studying the economic and cryptographic model.
  • End users who want to understand what .nota files are and why they matter.

Repository map

Repository Description
protocol Versioned protocol specification
contracts Solidity smart contracts
notareum-ts-sdk TypeScript SDK (@notareum/sdk)
notareum-py-sdk Python SDK (notareum)
notareum-rs-sdk Rust SDK
whitepaper Protocol whitepaper (LaTeX)
usecases-and-examples Runnable examples

Core principles

  1. Chain Agnostic. Every major blockchain, every resource type.
  2. Human Readable. A .nota file is JSON you can read without tools.
  3. Cryptographically Verifiable. Every file carries a signature.
  4. Extensible. Schema versioning and governance-added resource types.
  5. Lightweight. Typical files are 1 to 2 KB, portable over any channel.

Dive in with What is Notareum, or jump straight to the Quick Start.

About

Notareum Protocol Documentations

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors