agentleFS
hiromailyhiromaily/go-crypto-wallet/llms.txt

go-crypto-wallet

llms.txt128 starsChanged 6 months agoMITView on GitHub

Cryptocurrency wallet implementation supporting BTC, BCH, ETH, XRP, and ERC-20 tokens Read these documents in order:

We split this llms.txt into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read these documents in order:

    line 15

≈ “Common” is an estimate: at least 1 in 5 of the 3,225 llms.txt files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
llms.txt
# go-crypto-wallet

> Cryptocurrency wallet implementation supporting BTC, BCH, ETH, XRP, and ERC-20 tokens

## Project Summary

- **Type**: Multi-signature cryptocurrency wallet with offline signing capability
- **Primary Language**: Go (backend, wallet operations)
- **Additional Languages**: TypeScript/JavaScript (apps/), Solidity (smart contracts), SQL, HCL, Protobuf
- **Architecture**: Clean Architecture with clear layer separation
- **Security Model**: Cold wallet (offline) for key generation and signing, Watch wallet (online) for monitoring

## For AI Agents

Read these documents in order:

1. **[AGENTS.md](AGENTS.md)** - Agent behavior guidelines (how to act)
2. **[ARCHITECTURE.md](ARCHITECTURE.md)** - System architecture (how it's designed)
3. **[docs/guidelines/](docs/guidelines/)** - Project guidelines and standards

## Quick Reference

### Core Values (Priority Order)

1. Security First - Never log private keys, consider offline wallet impact
2. Clean Architecture - Domain has ZERO infrastructure dependencies
3. Incremental Changes - No breaking changes without rollback plan
4. Code Quality - Follow language-specific linting and testing standards

### Wallet Types

| Wallet | Environment | Purpose |
|--------|-------------|---------|
| Watch | Online | Monitor transactions, create unsigned tx, send signed tx |
| Keygen | Offline | Generate keys, create multisig addresses, first signature |
| Sign | Offline | Authorization signatures for multisig transactions |

### Directory Structure

```
cmd/           → Application entry points (keygen, sign, watch)
internal/      → Core application code (Clean Architecture)
├── domain/         → Pure business logic (ZERO dependencies)
├── application/    → Use cases, ports, DTOs
├── infrastructure/ → External systems (API, DB, storage)
└── interface-adapters/ → CLI commands, wallet adapters
pkg/           → Reusable shared packages
apps/          → TypeScript/JavaScript applications
docs/          → Documentation
```

### Verification Commands

| Language | Lint | Format | Build | Test |
|----------|------|--------|-------|------|
| Go | `make go-lint` | `make go-fmt` | `make check-build` | `make go-test` |
| TypeScript | `npm run lint` | `npm run format` | `npm run build` | `npm test` |
| Shell | - | `make shfmt` | - | - |

### Auto-Generated Files (DO NOT EDIT)

- `internal/infrastructure/database/sqlc/*.go` - SQLC generated
- `internal/infrastructure/api/ripple/xrp/*.pb.go` - Protocol Buffer generated
- `internal/infrastructure/contract/token-abi.go` - ABI generated

## Documentation Map

### Architecture & Design

- [ARCHITECTURE.md](ARCHITECTURE.md) - Clean Architecture overview
- [docs/chains/btc/](docs/chains/btc/) - Bitcoin-specific documentation
- [docs/chains/eth/](docs/chains/eth/) - Ethereum-specific documentation

### Project Guidelines and Standards

- [docs/guidelines/](docs/guidelines/) - Project guidelines and standards (SSOT)

### AI Agent Context

- [docs/task-contexts/](docs/task-contexts/) - Task-type specific context

## Supported Cryptocurrencies

- **BTC** (Bitcoin) - Full support including Taproot (BIP341/BIP86) and MuSig2 (BIP327)
- **BCH** (Bitcoin Cash) - Based on Bitcoin ABC
- **ETH** (Ethereum) - Including ERC-20 token support
- **XRP** (Ripple) - Via gRPC server communication

## Key Technologies

- Go 1.26.2
- btcsuite/btcd v0.25.0
- ethereum/go-ethereum v1.16.7
- golangci-lint v2.8.0
- Atlas v1.0.0 (DB migration)
- MySQL 8.4+

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.