Skip to content
Open
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
9 changes: 8 additions & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,13 @@
"hexlify",
"repoint",
"repointed",
"cutover"
"cutover",
"autonumber",
"dedup",
"Linkdrop",
"keypair",
"typedata",
"exfiltrated",
"runbook"
]
}
10 changes: 10 additions & 0 deletions src/envelopes/doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Envelopes — Documentation

Bearer-link asset transfer: a sender wraps ETH, ERC-20, ERC-721, or ERC-1155 assets in an on-chain envelope, gets a shareable URL, and anyone holding the URL can claim the contents through the app. Front-run-safe by construction (claim signature commits to the claimer's address).

## Contents

| Document | Description |
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| [spec/envelopes-specification.md](spec/envelopes-specification.md) | Full technical specification (architecture, roles, interfaces, flows, storage, security, testing, ops) |
| [integration-guide.md](integration-guide.md) | Operational runbook — TypeScript/ethers.js integration, Cast CLI, sender + app + recipient flows, admin operations, bug-fix rollout |
Comment on lines +1 to +10
Loading
Loading