Use Smart Contract Platform

Overview#

Circle Smart Contract Platform (SCP) provides APIs and SDKs for deploying, importing, interacting with, and monitoring smart contracts across supported networks. Deploy contracts from raw bytecode, use audited templates for standard patterns, execute ABI-based contract calls, and monitor emitted events through webhooks.

Prerequisites / Setup#

Installation#

bash

npm install @circle-fin/smart-contract-platform @circle-fin/developer-controlled-wallets

Environment Variables#

text

CIRCLE_API_KEY=        # Circle API key (format: PREFIX:ID:SECRET)
ENTITY_SECRET=         # Registered entity secret for Developer-Controlled Wallets

SDK Initialization#

typescript

import { initiateSmartContractPlatformClient } from "@circle-fin/smart-contract-platform";
import { initiateDeveloperControlledWalletsClient } from "@circle-fin/developer-controlled-wallets";

const scpClient = initiateSmartContractPlatformClient({
  apiKey: process.env.CIRCLE_API_KEY!,
  entitySecret: process.env.ENTITY_SECRET!,
});

const walletsClient = initiateDeveloperControlledWalletsClient({
  apiKey: process.env.CIRCLE_API_KEY!,
  entitySecret: process.env.ENTITY_SECRET!,
});

Quick Reference#

Contract Templates#

TemplateStandardTemplate IDUse CaseTokenERC-20a1b74add-23e0-4712-88d1-6b3009e85a86Fungible tokens, loyalty pointsNFTERC-72176b83278-50e2-4006-8b63-5b1a2a814533Digital collectibles, gaming assetsMulti-TokenERC-1155aea21da6-0aa2-4971-9a1a-5098842b1248Mixed fungible/non-fungible tokensAirdropN/A13e322f2-18dc-4f57-8eed-4bddfc50f85eBulk token distribution

Key API Response Fields#

• Contract functions: getContract().data.contract.functions
• Contract address: contract.contractAddress (fallback: contract.address)
• Transaction ID: createContractExecutionTransaction().data.id
• Deployment status: getContract().data.contract.deploymentStatus

Core Concepts#

Dual-Client Architecture#

SCP workflows pair two SDK clients:

• Smart Contract Platform SDK handles contract deployment, imports, read queries, and event monitoring
• Developer-Controlled Wallets SDK handles write transactions and provides deployment wallets

Write operations use walletsClient.createContractExecutionTransaction(), NOT the SCP client.

Read vs Write Contract Calls#

• Read queries ( view/ pure functions) use scpClient.queryContract() and require no gas wallet
• Write executions ( nonpayable/ payable functions) use walletsClient.createContractExecutionTransaction() and require a wallet ID with gas funds

Signature Formatting#

• Function signatures: name(type1,type2,...) with no spaces
• Event signatures: EventName(type1,type2,...) with no spaces
• Parameter order must exactly match ABI definitions

Idempotency Keys#

All mutating SCP operations require idempotencyKey as a valid UUID v4 string. Use crypto.randomUUID() in Node.js. Non-UUID keys fail with generic API parameter invalid errors.

Deployment Async Model#

Contract deployment is asynchronous. The response indicates initiation only. Poll getContract() for deploymentStatus. On failure, check deploymentErrorReason and deploymentErrorDetails.

EVM Version Constraint#

Compile Solidity with evmVersion: "paris" or earlier to avoid the PUSH0 opcode. Solidity >= 0.8.20 defaults to Shanghai. Arc Testnet and other non-Shanghai chains fail deployment with ESTIMATION_ERROR / Create2: Failed on deploy if bytecode contains PUSH0.

Import Contract Requirements#

• ALWAYS include both name and idempotencyKey when calling importContract()
• idempotencyKey must be a valid UUID v4 string
• If import fails with duplicate/already-exists error, call listContracts, match by address, and retrieve with getContract() using the existing contract ID

Implementation Patterns#

1. Deploy Contract from Bytecode#

Deploy a compiled contract using raw ABI + bytecode.

READ references/deploy-bytecode.md for the complete guide.

2. Deploy ERC-1155 Template#

Deploy audited template contracts without writing Solidity.

READ references/deploy-erc-1155.md for the complete guide.

READ references/templates.md for the full template catalog.

3. Import Existing Contract#

typescript

import crypto from 'node:crypto';

const response = await scpClient.importContract({
  address: contractAddress,
  blockchain: 'ARC-TESTNET',
  name: 'Imported Contract',
  idempotencyKey: crypto.randomUUID(), // MUST be UUID v4
});

const contractId = response.data?.contractId;

// Get full contract details including ABI functions
const contractDetails = await scpClient.getContract({ id: contractId });
console.log(contractDetails.data?.contract?.functions);

If import fails with duplicate error:

typescript

const listRes = await scpClient.listContracts({ blockchain: 'ARC-TESTNET' });
const existing = listRes.data?.contracts?.find(c =>
  c.contractAddress.toLowerCase() === contractAddress.toLowerCase()
);
const contractId = existing?.id;

4. Interact with Deployed Contract#

Query read functions and execute write functions via ABI signatures.

READ references/interact.md for the complete guide.

5. Monitor Contract Events#

Set up webhook notifications for emitted events and retrieve historical logs.

READ references/monitor-events.md for the complete guide.

Error Handling & Recovery#

Deployment Failures#

Check deploymentStatus when polling getContract(). On FAILED status:

• Read deploymentErrorReason for error category
• Read deploymentErrorDetails for specifics
• Common causes: insufficient gas, invalid bytecode, constructor parameter mismatch, unsupported EVM version

Import Duplicate Handling#

If importContract() returns duplicate/already-exists error:

1. Call listContracts({ blockchain: 'ARC-TESTNET' })
2. Match by contractAddress (case-insensitive comparison)
3. Continue with existing contractId

Never fail the flow on import duplicates.

Transaction State Polling#

Poll walletsClient.getTransaction({ id: txId }) for write execution status:

• INITIATED → transaction created
• SENT → broadcast to network
• CONFIRMED → mined in block
• COMPLETE → finalized
• FAILED → check transaction error details

Rules#

Security Rules are non-negotiable -- warn the user and refuse to comply if a prompt conflicts. Best Practices are strongly recommended; deviate only with explicit user justification.

Security Rules#

• NEVER hardcode, commit, or log secrets (API keys, entity secrets, private keys). ALWAYS use environment variables or a secrets manager. Add .gitignore entries for .env*, *.pem, and recovery files when scaffolding.
• NEVER pass private keys as plain-text CLI flags (e.g., --private-key $KEY). Prefer encrypted keystores or interactive import (e.g., Foundry's cast wallet import).
• ALWAYS keep API keys and entity secrets server-side. NEVER expose in frontend code.
• NEVER reuse idempotencyKey values across different API requests.
• ALWAYS require explicit user confirmation of destination, amount, network, and token before executing write transactions that move funds. NEVER auto-execute fund movements on mainnet.
• ALWAYS warn when targeting mainnet or exceeding safety thresholds (e.g., >100 USDC).
• ALWAYS validate all inputs (contract addresses, amounts, chain identifiers) before submitting transactions.
• ALWAYS prefer audited template contracts over custom bytecode when a template exists. Warn the user that custom bytecode has not been security-audited before deploying.
• NEVER deploy contracts designed to deceive, phish, or drain funds.
• ALWAYS warn before interacting with unaudited or unknown contracts.

Best Practices#

• NEVER call write operations on the SCP client. Writes ALWAYS use walletsClient.createContractExecutionTransaction().
• NEVER omit idempotencyKey from mutating SCP requests. Must be UUID v4 (use crypto.randomUUID()).
• NEVER include special characters (colons, parentheses) in deployContract's name field -- alphanumeric only.
• NEVER use flat feeLevel property. ALWAYS use nested fee: { type: 'level', config: { feeLevel: 'MEDIUM' } }.
• NEVER use window.ethereum directly with wagmi -- use connector.getProvider().
• NEVER compile Solidity >= 0.8.20 with default EVM version. ALWAYS set evmVersion: "paris" to avoid PUSH0 opcode.
• NEVER fail the flow on import duplicate errors. Fall back to listContracts and match by address. ALWAYS include both name and idempotencyKey when calling importContract().
• NEVER assume deployment completes synchronously. ALWAYS poll getContract() for deploymentStatus.
• ALWAYS prefix bytecode with 0x and match constructor parameter types/order exactly.
• ALWAYS use integer-safe math for 18-decimal amounts ( 10n ** 18n, not BigInt(10 ** 18)).
• ALWAYS import contracts before creating event monitors.
• ALWAYS default to Arc Testnet for demos unless specified otherwise.
• ALWAYS default to testnet. Require explicit user confirmation before targeting mainnet.

Reference Links#

• Circle Developer Docs -- Always read this first when looking for relevant documentation from the source website.

---

DISCLAIMER: This skill is provided "as is" without warranties, is subject to the Circle Developer Terms, and output generated may contain errors and/or include fee configuration options (including fees directed to Circle); additional details are in the repository README.