go-crypto-wallet
AGENTS.md128 starsChanged 6 months agoMITView on GitHub
This document defines the behavior and values for AI agents working on this project. For detailed documentation, see llms.txt and ARCHITECTURE.md. When modifying rules, skills, or documentation, always edit the SSOT location. Sync Process: Don't Repeat Yourself (DRY): Define once, reference everywhere. When information exists in multiple places, update the SSOT and reference it from others.
We split this AGENTS.md into the rules it gives an agent
5 rules. About 0 are common, 5 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
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
- Distinctive: line 23
Incremental Changes: - No breaking changes without rollback plan
- Distinctive: line 24
Code Quality: - Follow language-specific linting and testing standards
- Distinctive: line 31
Read relevant documentation before making changes
- Distinctive: line 32
Run verification commands after code changes
- Distinctive: line 34
Consider impact on offline wallet operations
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md 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.
Files
<!--
⚠️ AUTO-GENERATED FILE — DO NOT EDIT
Source: template/pages/AGENTS.tpl.md · Run `make docs` to regenerate.
-->Agent Guidelines for go-crypto-wallet
This document defines the behavior and values for AI agents working on this project. For detailed documentation, see llms.txt and ARCHITECTURE.md.
Project Identity
- Type: Multi-signature cryptocurrency wallet (BTC, BCH, ETH, XRP, ERC-20)
- Security Model: Offline cold wallets (keygen, sign) + Online watch wallet
- Architecture: Clean Architecture with strict layer separation
- Status: Under refactoring based on Clean Code principles
Core Values (Priority Order)
- Security First - Private key protection is non-negotiable
- Clean Architecture - Domain layer has ZERO infrastructure dependencies
- Single Source of Truth (SSOT) - One authoritative location for each piece of information
- Incremental Changes - No breaking changes without rollback plan
- Code Quality - Follow language-specific linting and testing standards
Expected Behavior
Always Do
- Check current branch before starting any task (see
git-workflowskill) - Read relevant documentation before making changes
- Run verification commands after code changes
- Wrap errors with context using
fmt.Errorf("context: %w", err) - Consider impact on offline wallet operations
Never Do
- ❌ Log private keys or sensitive information
- ❌ Edit files marked
DO NOT EDIT(auto-generated) - ❌ Push directly to
mainbranch - ❌ Run
git mergeorgh pr merge - ❌ Run
protocorbufcommands directly (always use Makefile targets likemake proto,make proto-ts)
Ask Before
- Making security-related changes
- Breaking changes to public APIs
- Changes affecting multiple layers
SSOT Structure
When modifying rules, skills, or documentation, always edit the SSOT location.
AI Agent Configuration
| Category | SSOT Location | Other Locations |
| Rules | .claude/rules/*.md | .cursor/rules/*.mdc (auto-generated) |
| Skills | .claude/skills/*/SKILL.md | .cursor/skills/ (symlink) |
| Commands | .claude/commands/ | .cursor/commands/ (reference only) |
Sync Process:
.cursor/rules/→ Auto-generated viamake sync-cursor-rules.cursor/skills/→ Symlink to.claude/skills/
Project Documentation
| Category | SSOT Location | Notes |
| Guidelines | docs/guidelines/ | Coding, testing, security, workflow, database, code-generation |
| Architecture | ARCHITECTURE.md | System design |
| Agent behavior | AGENTS.md (this file) | Entry point for all agents |
Key Principle
Don't Repeat Yourself (DRY): Define once, reference everywhere. When information exists in multiple places, update the SSOT and reference it from others.
Documentation Map
| Need | Document | |
| Project overview | llms.txt | |
| Architecture design | ARCHITECTURE.md | |
| AI Agent instruction design | docs/ai/design.md | |
| Guidelines | docs/guidelines/ | |
| Coding conventions | docs/guidelines/coding-conventions.md | |
| Security | docs/guidelines/security.md | |
| Testing | docs/guidelines/testing.md | |
| Workflow | docs/guidelines/workflow.md | |
| Database changes | docs/database/db-management.md | |
| Auto-generated files | docs/guidelines/code-generation.md | |
| CLI commands | internal/interface-adapters/cli/README.md | Command × Chain × UseCase matrix (SSOT) |
| Internal packages | internal/AGENTS.md | |
| Public packages | pkg/AGENTS.md |
Quick Reference
Identifying BTC Address Types
| Prefix | Type | BIP | SegWit |
1... | P2PKH | BIP44 | ❌ |
3... | P2SH or P2SH-P2WPKH | BIP16/BIP49 | △ |
bc1q... | P2WPKH or P2WSH | BIP84 | ✅ |
bc1p... | P2TR (Taproot) | BIP86 | ✅ |
Identifying BCH Address Types
| Prefix | Type | Multisig |
bitcoincash:q... | P2PKH | ❌ |
bitcoincash:p... | P2SH | ✅ |
Transaction Size Comparison
| Pattern | Weight | vBytes | Notes |
| P2PKH Single-sig (1-in, 2-out) | ~680 | ~170 | Legacy |
| P2WPKH Single-sig (1-in, 2-out) | ~440 | ~110 | Native SegWit |
| P2TR Single-sig (1-in, 2-out) | ~396 | ~99 | Taproot |
| 2-of-3 P2WSH Multisig | ~1,100 | ~275 | Traditional Multisig |
| 2-of-3 MuSig2 (P2TR) | ~560 | ~140 | Signature Aggregation |
See Also
- llms.txt - AI-friendly project sitemap
- ARCHITECTURE.md - System architecture
- docs/guidelines/ - Project guidelines and standards
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository62 other files it gives its agents.
- internal/AGENTS.mdAGENTS.md
- pkg/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- internal/CLAUDE.mdCLAUDE.md
- pkg/CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/agent-files.mdcCursor rule
- .cursor/rules/apps/bun.mdcCursor rule
- .cursor/rules/apps/eth-contracts.mdcCursor rule
- .cursor/rules/apps/xrp-server.mdcCursor rule
- .cursor/rules/database/atlas-hcl.mdcCursor rule
- .cursor/rules/database/sqlc.mdcCursor rule
- .cursor/rules/documentation-language.mdcCursor rule
- .cursor/rules/general.mdcCursor rule
- .cursor/rules/github-actions.mdcCursor rule
- .cursor/rules/go/conventions.mdcCursor rule
- .cursor/rules/go/di.mdcCursor rule
- .cursor/rules/go/go-path.mdcCursor rule
- .cursor/rules/go/go-test.mdcCursor rule
- .cursor/rules/internal/application-layer.mdcCursor rule
- .cursor/rules/internal/btc-shared.mdcCursor rule
- .cursor/rules/internal/clean-architecture.mdcCursor rule
- .cursor/rules/internal/cli-structure.mdcCursor rule
- .cursor/rules/internal/domain-layer.mdcCursor rule
- .cursor/rules/internal/dto.mdcCursor rule
- .cursor/rules/internal/infrastructure-layer.mdcCursor rule
- .cursor/rules/internal/interface-adapters-layer.mdcCursor rule
- .cursor/rules/internal/internal-interface.mdcCursor rule
- .cursor/rules/internal/mockery.mdcCursor rule
- .cursor/rules/internal/repository.mdcCursor rule
- .cursor/rules/internal/usecase.mdcCursor rule
- .cursor/rules/proto.mdcCursor rule
- .cursor/rules/README.mdCursor rule
- .cursor/rules/security.mdcCursor rule
- .cursor/rules/shell-script.mdcCursor rule
- .cursor/rules/ssot.mdcCursor rule
- .cursor/rules/task-context-loading.mdcCursor rule
- .cursor/rules/typescript.mdcCursor rule
- .cursor/rules/yaml.mdcCursor rule
- llms.txtllms.txt
- bch-developmentSkill
- btc-terminologySkill
- db-migrationSkill
- devopsSkill
- docs-ssotSkill
- docs-updateSkill
- fix-pr-reviewSkill
- github-issue-creationSkill
- git-workflowSkill
- go-developmentSkill
- knowledge-gapSkill
- label-context-mappingSkill
- makefile-updateSkill
- mockerySkill
- openspec-apply-changeSkill
- openspec-archive-changeSkill
- openspec-exploreSkill
- openspec-proposeSkill
- shell-scriptsSkill
- solidity-developmentSkill
- The first 60 shown.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
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.