Circle USYC 백서

Circle USYC

원문

bitpro가 원문에서 글자만 모은 내용이에요. 표·그림·수식은 빠지거나 깨질 수 있어요. 전체 75쪽 중 6쪽

"https://api.circle.com/v1/codegen/mcp" } } } ``` 2. Enable the Circle MCP server in your MCP settings. Start generating code for Circle Wallets, Contracts, CCTP, and Gateway. For more information on how to use MCP with Windsurf, see the [Windsurf MCP documentation](https://docs.windsurf.com/windsurf/cascade/mcp). </Tab> <Tab title="Kiro"> Download and install [Kiro](https://kiro.dev) if you haven't already. 1. Open Kiro and go to **Preferences/Settings** → search for "MCP" → enable MCP support. 2. Create or open the MCP config file: * **Workspace-level**: `./.kiro/settings/mcp.json` (recommended for project-specific) * **User-level**: `~/.kiro/settings/mcp.json` 3. Add a server configuration entry for Circle: ```json theme={null} { "mcpServers": { "circle": { "command": "npx", "args": ["-y", "@circle/mcp-server"], "env": { "CIRCLE_BASE_URL": "https://api.circle.com/v1/codegen/mcp" }, "disabled": false } } } ``` 4. Save and then restart Kiro (or reload the MCP server list) so the new server appears in the MCP tab. 5. In Kiro's side panel → **MCP Servers** tab → you should see "circle-mcp" listed. Start generating code for Circle Wallets, Contracts, CCTP, and Gateway. Kiro's general MCP setup: [Kiro Docs - MCP](https://kiro.dev/docs/mcp/). </Tab> </Tabs> ``` ``` # AI skills for building with Circle Source: https://developers.circle.com/ai/skills Use Circle's open source AI skills to accelerate development with AI-assisted IDEs. Skills provide specialized knowledge for building with Circle's products, including wallets, crosschain transfers, and smart contracts. Skills are available in the [circlefin/skills](https://github.com/circlefin/skills) repository. ## Installation Use the following commands to install Circle Skills with the command-line. <CodeGroup> ```shell Claude Code icon="https://mintcdn.com/circle-167b8d39/5X_H2DLmIxVDSWCs/images/claude-logo.png?fit=max&auto=format&n=5X_H2DLmIxVDSWCs&q=85&s=2711bd5dc795308c62570a011248ef2d" theme={null} /plugin marketplace add circlefin/skills /plugin install circle-skills@circle ``` ```shell Vercel Skills CLI icon="https://mintcdn.com/circle-167b8d39/kF52uen9TY9sspam/images/vercel_logo.png?fit=max&auto=format&n=kF52uen9TY9sspam&q=85&s=20d2a3e59acc98f14fe41854458cfcd5" theme={null} npx skills add circlefin/skills ``` </CodeGroup> ## Available skills The following skills are available to help you build with Circle's products. ### `accept-agent-payments` Monetize an API by charging AI agents per request in USDC over [x402](/x402-facilitators/x402). Scaffolds both payment rails (Gateway nanopayments and vanilla x402) and prepares your service for the [Agent Marketplace](/agent-stack/agent-marketplace). ### `bridge-stablecoin` Build apps that bridge USDC between chains using Circle's [Cross-Chain Transfer Protocol (CCTP)](/cctp). Includes UX patterns, progress tracking, destination chain linking, and [Bridge Kit](https://docs.arc.io/app-kit/bridge) SDK implementation patterns for EVM and Solana chains. ### `use-arc` Build on Arc, Circle's blockchain where USDC is the native gas token. Covers chain configuration, [smart contract](/contracts) deployment with Foundry or Hardhat, frontend integration with viem/wagmi, and bridging USDC to Arc via [CCTP](/cctp). ### `use-circle-wallets` Choose the right [Circle wallet](/wallets) type for your application. Compares [developer-controlled](/wallets/dev-controlled), [user-controlled](/wallets/user-controlled), and [modular](/wallets/modular) (passkey) wallets across custody model, key management, account types, and blockchain support. ### `use-developer-controlled-wallets` [Developer-controlled wallets](/wallets/dev-controlled) where developers manage wallet creation, storage, and key management. Use for custodial or operational flows like payouts, treasury movements, subscriptions, and automation. ### `use-gateway` Implement [Circle Gateway](/gateway) unified balance for crosschain USDC transfers. Supports instant transfers (under 500ms) across EVM and Solana chains with deposit, balance query, and transfer workflows. ### `use-modular-wallets` Build [modular wallets](/wallets/modular) with passkey authentication, gasless transactions, and modular architecture. Supports ERC-4337 account abstraction and ERC-6900 modular framework. ### `use-smart-contract-platform` Deploy, import, interact with, and monitor smart contracts using [Circle's Smart Contract Platform](/contracts). Supports bytecode deployment, template contracts (ERC-20/721/1155), ABI-based read/write calls, and event monitoring. ### `use-user-controlled-wallets` Build embedded [user-controlled wallets](/wallets/user-controlled) where users control their own assets. Supports Web2-like login experiences (Google, Facebook, Apple, email OTP, PIN) without seed phrases. # API reference Source: https://developers.circle.com/api-reference Overview of Circle's available APIs and endpoints. Circle provides a suite of REST APIs for building financial applications on blockchain infrastructure. Whether you're creating wallets, deploying smart contracts, moving USDC across blockchains, or building institutional payment flows, there is an API tailored to your use case. ## Before you begin Many Circle APIs require an API key to authenticate requests. Permissionless products like CCTP and Gateway are open and require no API key. <CardGroup> <Card title="API keys" icon="key" href="/api-reference/keys"> Learn about API keys and client keys, and how to authenticate requests to Circle's platform </Card> <Card title="Idempotent requests" icon="arrows-rotate" href="/api-reference/idempotent-requests"> Use idempotency keys to safely retry API calls without creating duplicate operations </Card> <Card title="OpenAPI specs" icon="file-code" href="/api-reference/openapi-specifications"> Find the machine-readable OpenAPI specification for every Circle API </Card> </CardGroup> ## Available APIs <CardGroup> <Card title="Wallets" icon="wallet" href="/api-reference/wallets/common/ping"> Create and manage developer-controlled and user-controlled wallets, execute transactions, and sign messages across EVM, Solana, and other supported blockchains </Card> <Card title="Contracts" icon="file-contract" href="/api-reference/contracts/common/ping"> Deploy and interact with smart contracts using Circle's managed infrastructure, including event monitoring and contract templates </Card> <Card title="CCTP" icon="bridge" href="/api-reference/cctp/all/get-public-keys-v2"> Fetch attestations and support crosschain transfers of USDC, EURC, and registered third-party assets using Cross-Chain Transfer Protocol </Card> <Card title="Gateway" icon="dungeon" href="/api-reference/gateway/all/get-token-balances"> Access and manage a unified USDC balance across multiple blockchains with instant transfers in under 500 ms </Card> <Card title="Circle Mint" icon="building-columns" href="/api-reference/circle-mint/account/list-business-balances"> Manage USDC and EURC balances, process crypto deposits and payouts, execute cross-currency trades, and manage reserves </Card> <Card title="Circle Payments Network" icon="chart-network" href="/api-reference/cpn/common/ping"> Route and settle stablecoin payments across Circle's network with support for quotes, payments, and transactions </Card> <Card title="StableFX" icon="swap" href="/api-reference/stablefx/all/create-quote"> Request quotes and execute institutional FX trades between USDC and EURC with onchain settlement on Arc </Card> <Card title="xReserve" icon="vault" href="/api-reference/xreserve/all/get-balances"> Deposit USDC into xReserve, retrieve attestations, and manage withdrawals for USDC-backed stablecoins </Card> </CardGroup> # Get an audit log by ID Source: https://developers.circle.com/api-reference/audit-logs/get-audit-log-by-id openapi/openapi-public.yaml get /v1/auditLogs/{id} Returns a single audit log entry by its unique identifier. # List audit logs Source: https://developers.circle.com/api-reference/audit-logs/list-audit-logs openapi/openapi-public.yaml get /v1/auditLogs Returns a paginated list of audit log entries for your account, ordered from newest to oldest. Use the query parameters to filter by time range, event type, actor, or outcome. Results are paginated using opaque cursors returned in the `Link` response header. # CCTP API Source: https://developers.circle.com/api-reference/cctp Fetch attestations and support crosschain transfers of USDC, EURC, and registered third-party assets using Cross-Chain Transfer Protocol. CCTP is permissionless and open to any wallet. It natively transfers USDC and EURC through burn-and-mint, and supports permissionless wrapping of third-party assets through lock-and-mint. All transfers use Circle's production attestation infrastructure. No API key required. ## Get started <CardGroup> <Card title="CCTP documentation" icon="book" href="/cctp"> Learn how Cross-Chain Transfer Protocol works. </Card> <Card title="Supported chains and domains" icon="link" href="/cctp/concepts/supported-chains-and-domains"> See which blockchains CCTP supports and the domain IDs you'll need. </Card> </CardGroup> ## Endpoint categories <CardGroup> <Card title="CCTP" icon="bridge" href="/api-reference/cctp/all/get-public-keys-v2"> Current endpoints for messages, attestations, and burn fees. </Card> <Card title="CCTP V1 (Legacy)" icon="clock-rotate-left" href="/api-reference/cctp/all/get-attestation"> Legacy endpoints for existing V1 integrations. </Card> </CardGroup> # Create a USDC transfer quote Source: https://developers.circle.com/api-reference/cctp/all/create-usdc-burn-quote openapi/cctp.yaml post /v2/quote/burn/usdc/{sourceDomainId}/{destDomainId} Returns a signed, time-bound fee quote for a native USDC transfer. A quote prices the fees a caller must pay and includes a `signedQuote` blob that the `TokenMessengerWithFees` contract verifies onchain. The `requests` array selects which fees to price: a `FORWARD` request prices destination-chain forwarding, while a `PRE_FINALITY` request prices faster-than-finality settlement. Include at most one request per type. # Get an attestation Source: https://developers.circle.com/api-reference/cctp/all/get-attestation openapi/cctp.yaml get /v1/attestations/{messageHash} Retrieves the signed attestation for a USDC burn event on the source chain. # Get USDC transfer fees Source: https://developers.circle.com/api-reference/cctp/all/get-burn-usdc-fees openapi/cctp.yaml get /v2/burn/USDC/fees/{sourceDomainId}/{destDomainId} Retrieves the applicable fees for a USDC transfer between the specified source and destination domains. The fee is returned in basis points (1 = 0.01%). # Get USDC Fast Transfer allowance Source: https://developers.circle.com/api-reference/cctp/all/get-fast-burn-usdc-allowance openapi/cctp.yaml get /v2/fastBurn/USDC/allowance Retrieves the available USDC Fast Transfer allowance remaining. # Get a list of messages Source: https://developers.circle.com/api-reference/cctp/all/get-messages openapi/cctp.yaml get /v1/messages/{sourceDomainId}/{transactionHash} Retrieves message and attestation details for CCTP V1 messages. # Get messages and attestations Source: https://developers.circle.com/api-reference/cctp/all/get-messages-v2 openapi/cctp.yaml get /v2/messages/{sourceDomainId} Retrieves messages and attestations for a given transaction hash or nonce. Each message for a given transaction hash is ordered by ascending log index. # List attestation public keys Source: https://developers.circle.com/api-reference/cctp/all/get-public-keys openapi/cctp.yaml get /v1/publicKeys Retrieves a list of the currently active public keys for verifying attestation signatures. # Get public keys Source: https://developers.circle.com/api-reference/cctp/all/get-public-keys-v2 openapi/cctp.yaml get /v2/publicKeys Returns the public keys for validating attestations across all supported versions of CCTP. # Re-attest a pre-finality message Source: https://developers.circle.com/api-reference/cctp/all/reattest-message openapi/cctp.yaml post /v2/reattest/{nonce} The re-attestation flow allows the relayer to obtain a higher level of finality than was originally requested on the source chain, while still being forced to pay the fee since allowance was reserved. This flow resolves the case where a sender specifies a finality threshold lower than the destination chain recipient requires. # Cancel all orders Source: https://developers.circle.com/api-reference/circle-match/all/cancel-all-orders openapi/match.yaml post /v1/match/orders/cancel-all Cancels every resting order you hold in the current auction cycle. No request body is required. Returns 200 with an empty `orderIds` array if you have no resting orders. Blocked during the lock window (error 136001). # Cancel an order Source: https://developers.circle.com/api-reference/circle-match/all/cancel-order openapi/match.yaml post /v1/match/orders/cancel Cancels a single resting order. Cancellations are blocked during the lock window (error 136001) and while the previous auction is settling (error 136002). If the order has already cleared, it cannot be cancelled. # Withdraw funds Source: https://developers.circle.com/api-reference/circle-match/all/create-withdrawal openapi/match.yaml post /v1/match/withdrawals Converts your Circle-Match-only USDC balance to USD and wires it to the specified fiat account. This exit path is for mint-side participants only; burn-side USDC releases automatically when orders fill or are cancelled. No Circle Mint burn fee applies. # Create a WebSocket ticket Source: https://developers.circle.com/api-reference/circle-match/all/create-ws-ticket openapi/match.yaml post /v1/match/ws/ticket Issues a short-lived JWT for authenticating a WebSocket connection. The token is validated on signature, issuer, audience, and expiry. Obtain it immediately before opening the socket — it expires at `expiresAt`. Connect to the WebSocket endpoint using two `Sec-WebSocket-Protocol` values: - `circle-match.v1` — identifies the protocol version - `ticket.<jwt>` — the ticket value from this response, prefixed with `ticket.` The server rejects the upgrade with HTTP 401 if the ticket is missing, expired, or has an invalid signature. # Get account summary Source: https://developers.circle.com/api-reference/circle-match/all/get-account openapi/match.yaml get /v1/match/account Returns a best-effort snapshot of your Circle Match USDC balance, open-order exposure, and windowed activity totals. Use this for pre-order balance checks and dashboard display. For exact reconciliation, use your order and settlement records instead. # Get an order Source: https://developers.circle.com/api-reference/circle-match/all/get-order openapi/match.yaml get /v1/match/orders/{id} Returns full detail for a single order, including lineage fields for tracing rolled orders and a fill object that is populated after matching. Follow `lineage.parentOrderId` backward or `lineage.childOrderId` forward to reconstruct the full chain for a rolled order. # List orders Source: https://developers.circle.com/api-reference/circle-match/all/list-orders openapi/match.yaml get /v1/match/orders Returns a paginated list of your orders. All query parameters are optional. An unrecognised `status` or `orderType` value returns 400. Passing `from` after `to` returns 400. # Modify an order Source: https://developers.circle.com/api-reference/circle-match/all/modify-order openapi/match.yaml post /v1/match/orders/modify Changes the fee limit on a resting order. Only the fee changes; the order remains in `pending` status with its original size and side. Outside the lock window, the fee can move in either direction. During the lock window, the new value must be more competitive than the current value (lower for BURN orders, higher for MINT orders); a less competitive value returns error 137005. Setting `feeBps` to null converts the order to a market order. # Place an order Source: https://developers.circle.com/api-reference/circle-match/all/place-order openapi/match.yaml post /v1/match/orders Submits a BURN or MINT order to the current auction cycle. Returns 202 Accepted with the orderId and initial `pending` status. The order rests until the auction clears. The `idempotencyKey` you supply becomes the `orderId` for all subsequent lookups. Use a unique UUID v4 per order. Reusing a key with different parameters returns error 137004 (HTTP 409). BURN orders require `sourceWalletId` and `fiatAccountId`. MINT orders must omit those fields. Use the `orderType` discriminator to select the correct variant. # Circle Mint API Source: https://developers.circle.com/api-reference/circle-mint Manage USDC and EURC balances, process crypto deposits and payouts, execute cross-currency trades, and manage reserves. Use Circle Mint if you're an institutional customer—typically an exchange, fintech, bank, or trading firm—working directly with Circle to mint and redeem stablecoins. ## Get started <CardGroup> <Card title="API keys" icon="key" href="/api-reference/keys"> Authenticate your requests with an API key. </Card> <Card title="Postman collection" icon="rocket" href="/api-reference/circle-mint/postman"> Try the Circle Mint API with Circle's Postman collection. </Card> <Card title="Webhooks" icon="bell" href="/api-reference/circle-mint/general/list-subscriptions"> Set up webhook subscriptions for Circle Mint events. </Card> </CardGroup> ## Endpoint categories <CardGroup> <Card title="Core API" icon="building-columns" href="/api-reference/circle-mint/account/list-business-balances"> Manage balances, wires, transfers, payouts, deposits, and addresses. </Card> <Card title="Crypto Deposits" icon="arrow-down-to-line" href="/api-reference/circle-mint/payments/list-payments"> Receive stablecoin payments and manage payment intents. </Card> <Card title="Crypto Payouts" icon="arrow-up-from-line" href="/api-reference/circle-mint/payouts/list-payouts"> Send stablecoin payouts and manage the address book. </Card> <Card title="Cross-Currency" icon="right-left" href="/api-reference/circle-mint/cross-currency/get-quote"> Quote, trade, and settle between currencies. </Card> <Card title="Credit" icon="credit-card" href="/api-reference/circle-mint/credit/get-credit-line"> Access credit lines, transfers, fees, and repayments. </Card> <Card title="Reserve Management" icon="vault" href="/api-reference/circle-mint/reserve-management/report-daily-custody-balances"> Report daily custody balances for reserve management. </Card> </CardGroup> ## OpenAPI specifications The Circle Mint API reference is generated from these OpenAPI specifications: * `https://developers.circle.com/openapi/account.yaml` * `https://developers.circle.com/openapi/general.yaml` * `https://developers.circle.com/openapi/institutional.yaml` * `https://developers.circle.com/openapi/payments.yaml` * `https://developers.circle.com/openapi/payouts.yaml` * `https://developers.circle.com/openapi/cross-currency.yaml` * `https://developers.circle.com/openapi/reserve-management.yaml` * `https://developers.circle.com/openapi/credit.yaml` * `https://developers.circle.com/openapi/partner-openapi.yaml` See [OpenAPI Specifications](/api-reference/openapi-specifications) for the full catalog of Circle's API specs. # Create a CUBIX bank account Source: https://developers.circle.com/api-reference/circle-mint/account/create-business-cubix-account openapi/account.yaml post /v1/businessAccount/banks/cubix # Create a deposit address Source: https://developers.circle.com/api-reference/circle-mint/account/create-business-deposit-address openapi/account.yaml post /v1/businessAccount/wallets/addresses/deposit Generates a new blockchain address for a wallet for a given currency/chain pair.
프로젝트로 돌아가기