Home / Documentation / API Smart Contracts

Execution Topology

UI / Portal Action
  -> API endpoint (intent)
  -> Blockchain op queue record (pending)
  -> Worker submits contract tx (submitted)
  -> Confirmation + tx hash persistence (confirmed/failed)
  -> Domain state update (offering/subscription/investor views)

Core contracts in write path:
  TokenFactory, FractalSecurityToken7518, AgentRegistry
Optional/adjacent path:
  FractalYieldDistributor, TransferAgent, Rule144

Operation Mapping

Blockchain Operation Status Lifecycle

API Response Shape for Contract Metadata

{
  "id": "off_abc123",
  "name": "Rental Yield Notes Series 1",
  "tokenDeployment": {
    "status": "deployed",
    "contractAddress": "0x...",
    "chainId": 137,
    "txHash": "0x..."
  },
  "blockchain": {
    "network": "Polygon Mainnet",
    "chain_id": 137,
    "token_address": "0x...",
    "standard": "ERC-7518"
  }
}

Read Verification Playbook (Integrator Side)

import { ethers } from "ethers";

const provider = new ethers.JsonRpcProvider(process.env.RPC_URL);
const token = new ethers.Contract(tokenAddress, erc7518Abi, provider);

// 1) Verify offering token metadata
const offeringId = await token.offeringId();
const symbol = await token.tokenSymbol();

// 2) Verify transferability before initiating UX action
const [allowed, reason] = await token.canTransfer(from, to, 1, amount, "0x");

// 3) Inspect lock state for user balance UX
const transferable = await token.transferableBalance(holder, 1);
const locked = await token.lockedBalanceOf(holder, 1);

// 4) Confirm freeze/restriction status
const frozen = await token.isFrozen(holder);
const restricted = await token.isRestricted(1);

Write Path Guardrails

• Agent permissions gate mutating token functions via AgentRegistry.isAgent.
• Token transfer path enforces lock, freeze, whitelist, and cap controls on-chain.
• Queue-based execution avoids blocking portal requests on chain finality.
• Domain state should update only after tx confirmation, never at submission time.
• Failed/dead-letter operations require explicit operator reconciliation.

Planned Public Developer Endpoints

The following public API reference pages describe future external access paths.

Illustrative Method Status