# Romu

> Romu is MPC custody for exchanges: no single machine holds a wallet's whole key, every node re-checks the rules before it signs, and people approve large withdrawals on their phones. These are the developer docs, written in Persian. Code, endpoint names and JSON are English.

Facts that matter when writing code:
- Base URL: https://api.romu.ir (sandbox: TRON Nile and BSC testnet, test money; use it first), https://api.romu.io (production: TRON and BSC mainnet, real money)
- Every request is signed with your own Ed25519 key; see the signing guide for the exact nine-line string to sign.
- Amounts are decimal strings in the asset's units, such as "100.50", never floats, with at most the asset's decimals. Responses add amount_raw in the smallest unit.
- Withdrawals and deposit address creation need an Idempotency-Key header.
- Webhooks are checked over the raw body bytes; delivery is at least once and order is not guaranteed.
- Approval happens only in Romu's app. The API reads approval state and never approves.

## Start

- [اولین درخواست](https://docs.romu.io/fa/start/first-request/): در چند قدم یک کلید API بسازید، اولین درخواست را بفرستید و پاسخ را ببینید.
- [راه‌اندازی سازمان](https://docs.romu.io/fa/start/organisation-setup/): از ثبت‌نام تا اولین کیف پول: ورود، اپ رومو، دو تأیید، نودها، پشتیبان و اعضا.

## Concepts

- [رومو چطور کار می‌کند](https://docs.romu.io/fa/concepts/how-it-works/): مسیر یک برداشت و یک واریز، از سیستم شما تا شبکه.
- [گوشی مدیر](https://docs.romu.io/fa/concepts/manager-phone/): گوشی مدیر یکی از سه سهم کلید است. این کار برای سیستم شما چه فرقی دارد.
- [سازمان، کیف پول و آدرس](https://docs.romu.io/fa/concepts/organisation/): این چند کلمه در همه‌ی API تکرار می‌شوند. این‌جا یک بار برای همیشه.
- [قانون‌ها و تأییدها](https://docs.romu.io/fa/concepts/rules-and-approvals/): هر برداشت چطور تصمیم می‌گیرد و چه کسی تأیید می‌کند.
- [از sandbox تا تولید](https://docs.romu.io/fa/concepts/sandbox-to-production/): اول با پول آزمایشی بسازید. بعد با چند تغییر کوچک سراغ پول واقعی بروید.
- [امنیت](https://docs.romu.io/fa/concepts/security/): از چه چیزی و در برابر چه کسی محافظت می‌شود، هر نود چه می‌سنجد، و سهم شما چیست.
- [کلید دست کیست](https://docs.romu.io/fa/concepts/who-holds-the-key/): کلید هیچ‌وقت یک‌جا نیست. توضیح ساده، بی اصطلاح فنی.

## Guides

- [ساختن کلید API](https://docs.romu.io/fa/guides/api-keys/): یک جفت کلید Ed25519 روی سرور خودتان بسازید، نیمه‌ی عمومی را در کنسول بگذارید و کلید را تأیید کنید.
- [دارایی‌های پشتیبانی‌شده](https://docs.romu.io/fa/guides/assets/): فهرست دارایی‌ها را از کجا بخوانید، و اعشار و حداقل واریز یعنی چه.
- [گرفتن واریز](https://docs.romu.io/fa/guides/deposits/): ساخت آدرس واریز برای هر کاربر، تشخیص واریز، عمق تأیید، sweep و ایستگاه کارمزد.
- [خطاها و سقف نرخ](https://docs.romu.io/fa/guides/errors/): همه‌ی خطاها به تفکیک موضوع با کاری که باید کرد، و سقف‌های نرخ.
- [Idempotency](https://docs.romu.io/fa/guides/idempotency/): یک برداشت، نه دو تا. کلید یکتا، تکرار امن و خطای کلید تکراری.
- [قانون‌ها برای توسعه‌دهنده](https://docs.romu.io/fa/guides/policy/): آنچه API از قانون‌ها نشان می‌دهد، قفل اضطراری و قیمت دلاری.
- [امضای درخواست](https://docs.romu.io/fa/guides/signing/): رشته‌ی امضای دقیق، پنجره‌ی زمانی، بردار آزمون و کلاینت آماده در چهار زبان.
- [دریافت Webhook](https://docs.romu.io/fa/guides/webhooks/): تنظیم، سنجش امضا روی بدنه‌ی خام، جدول تلاش دوباره، تکرار و ترتیب، و آزمون.
- [آدرس‌های مجاز](https://docs.romu.io/fa/guides/whitelist/): دسته‌ی آدرس‌های مجاز، اثر آن روی برداشت و تأخیر فعال‌سازی.
- [فرستادن برداشت](https://docs.romu.io/fa/guides/withdrawals/): ثبت برداشت، موجودی ناکافی، لغو، تأیید و همه‌ی وضعیت‌ها با نمودار.

## API reference

- [OpenAPI 3.1 spec](https://docs.romu.io/openapi.yaml)
- [GET /v1/whoami](https://docs.romu.io/fa/reference/identity/whoami/): این کلید کیست
- [GET /v1/wallets](https://docs.romu.io/fa/reference/wallets/get-wallets/): یک کیف پول یا فهرست کیف پول‌ها
- [GET /v1/wallets/assets](https://docs.romu.io/fa/reference/wallets/wallet-assets/): دارایی‌های یک کیف پول
- [GET /v1/wallets/balance-summary](https://docs.romu.io/fa/reference/wallets/balance-summary/): خلاصه‌ی موجودی کیف پول
- [GET /v1/transactions](https://docs.romu.io/fa/reference/transactions/get-transactions/): یک تراکنش یا فهرست تراکنش‌ها
- [POST /v1/transactions](https://docs.romu.io/fa/reference/transactions/create-withdrawal/): ثبت برداشت
- [POST /v1/transactions/cancel](https://docs.romu.io/fa/reference/transactions/cancel-withdrawal/): لغو برداشت
- [GET /v1/transactions/approvals](https://docs.romu.io/fa/reference/approvals/transaction-approvals/): وضعیت تأیید یک تراکنش
- [GET /v1/addresses](https://docs.romu.io/fa/reference/addresses/get-addresses/): یک آدرس یا فهرست آدرس‌ها
- [POST /v1/addresses](https://docs.romu.io/fa/reference/addresses/create-address/): ساخت آدرس واریز
- [PATCH /v1/addresses](https://docs.romu.io/fa/reference/addresses/update-address/): تغییر برچسب یا بایگانی آدرس
- [POST /v1/addresses/batch](https://docs.romu.io/fa/reference/addresses/create-addresses-batch/): ساخت چند آدرس واریز با هم
- [GET /v1/addresses/balances](https://docs.romu.io/fa/reference/addresses/address-balances/): موجودی هر آدرس
- [GET /v1/addresses/export](https://docs.romu.io/fa/reference/addresses/export-addresses/): خروجی CSV آدرس‌ها
- [GET /v1/address-groups](https://docs.romu.io/fa/reference/addresses/get-address-groups/): گروه‌های آدرس
- [POST /v1/address-groups](https://docs.romu.io/fa/reference/addresses/create-address-group/): ساخت گروه آدرس
- [GET /v1/deposits](https://docs.romu.io/fa/reference/deposits/get-deposits/): یک واریز یا فهرست واریزها
- [GET /v1/sweep-rules](https://docs.romu.io/fa/reference/sweeps/get-sweep-rules/): قانون‌های sweep
- [PUT /v1/sweep-rules](https://docs.romu.io/fa/reference/sweeps/set-sweep-rule/): تنظیم قانون sweep
- [GET /v1/sweeps](https://docs.romu.io/fa/reference/sweeps/get-sweeps/): تاریخچه‌ی sweep
- [POST /v1/sweeps](https://docs.romu.io/fa/reference/sweeps/sweep-now/): sweep همین الان
- [GET /v1/fee-station](https://docs.romu.io/fa/reference/assets/fee-station/): ایستگاه کارمزد
- [GET /v1/assets](https://docs.romu.io/fa/reference/assets/registry-assets/): دارایی‌های پشتیبانی‌شده
- [GET /v1/policy](https://docs.romu.io/fa/reference/approvals/get-policy/): قانون‌های ثبت‌شده‌ی کیف پول
- [GET /v1/change-requests](https://docs.romu.io/fa/reference/approvals/get-change-requests/): درخواست‌های تغییر
- [GET /v1/webhooks/key](https://docs.romu.io/fa/reference/webhooks/webhook-key/): کلید عمومی Webhook
- [POST /v1/webhooks/replay](https://docs.romu.io/fa/reference/webhooks/webhook-replay/): ارسال دوباره‌ی یک رویداد
- [POST /v1/webhooks/replay-failed](https://docs.romu.io/fa/reference/webhooks/webhook-replay-failed/): ارسال دوباره‌ی رویدادهای ناموفق
- [GET /v1/usage](https://docs.romu.io/fa/reference/usage/usage/): مصرف ماهانه

## Optional

- [SDK و ابزار](https://docs.romu.io/fa/tools/): کتابخانه‌ی رومو برای TypeScript، Go و Python، و فایل OpenAPI.
- [تغییرات](https://docs.romu.io/fa/changelog/): تغییرهای API و مستندات رومو، تازه‌ترین اول.