|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Contributions are welcome! Please: |
| 4 | + |
| 5 | +1. Fork the repo and create a feature branch |
| 6 | +2. Make your changes and add tests where appropriate |
| 7 | +3. Run `pnpm ci` to validate (lint, typecheck, test, build) |
| 8 | +4. Open a pull request |
| 9 | + |
| 10 | +## Project Structure |
| 11 | + |
| 12 | +```text |
| 13 | +src/ |
| 14 | +├── index.ts # Entry point, registers all commands |
| 15 | +├── commands/ |
| 16 | +│ ├── account/ # Account queries and management |
| 17 | +│ ├── amm/ # AMM commands |
| 18 | +│ ├── channel/ # Payment channel commands |
| 19 | +│ ├── check/ # Check commands |
| 20 | +│ ├── dex/ # DEX / order book commands |
| 21 | +│ ├── escrow/ # Escrow commands |
| 22 | +│ ├── ledger/ # Ledger queries, features, subscribe |
| 23 | +│ ├── mpt/ # Multi-Purpose Token commands |
| 24 | +│ ├── nft/ # NFT commands |
| 25 | +│ ├── signing/ # Sign, submit, multisign commands |
| 26 | +│ ├── tx/ # Send, trust-set, clawback, build |
| 27 | +│ ├── utility/ # Conversion helpers, completions |
| 28 | +│ └── wallet/ # Wallet generate, fund, from-seed |
| 29 | +└── lib/ |
| 30 | + ├── client.ts # XRPL WebSocket client lifecycle |
| 31 | + ├── config.ts # Config file + alias resolution |
| 32 | + ├── memo.ts # Memo parser |
| 33 | + ├── schemas.ts # Zod schemas for input validation |
| 34 | + ├── tokens.ts # Token notation parser |
| 35 | + ├── tx.ts # Shared transaction helpers |
| 36 | + ├── validate.ts # Composable validation helpers |
| 37 | + └── wallet.ts # Wallet loading from seed/keyfile |
| 38 | +test/ |
| 39 | +├── *.test.ts # Unit tests |
| 40 | +└── e2e/ # E2E tests (testnet) |
| 41 | +``` |
| 42 | + |
| 43 | +## Code Style |
| 44 | + |
| 45 | +- [Biome](https://biomejs.dev/) for linting and formatting |
| 46 | +- Tabs for indentation, double quotes |
| 47 | +- ESM-only (`"type": "module"`) |
0 commit comments