Integration Overview

This guide provides a high-level understanding of the IP World API architecture and its components. Use this as your roadmap for integrating IP token creation into your application.

Core Components

1. Backend API (REST)

The IP World backend provides three main services:

IP Registration Endpoint

POST /ips

Purpose: Registers intellectual property metadata Authentication: JWT Token required Stores: Title, description, social links, category, licensing info Returns: Unique IP ID

Signature Service Endpoint

POST /signature/create

Purpose: Provides authorized signatures for token creation Authentication: JWT Token required Validates: Creator address, nonce, anti-snipe settings Returns: EIP-712 signature (v, r, s) + deadline

Remix Registration Endpoint

POST /remixes

Purpose: Links deployed tokens to IP metadata Authentication: JWT Token required Stores: Token address, description, image, social links Returns: Confirmation of token-IP linkage

---

2. Smart Contracts (Blockchain)

The Story blockchain hosts two primary contracts:

Operator Contract

Address (Mainnet): 0x3A923bF60869D30b2ae12107EFF846790466492D Address (Testnet): 0x4E279910d932AD34CE27cC45b992f7381031EFea

Key Functions:

function nonces(address creator) returns (uint256)

Returns the current nonce for a creator (used in signature generation)

function createIpTokenWithSig(
    string name,
    string symbol,
    address ipaId,
    int24[] startTickList,
    uint256[] allocationList,
    bool antiSnipe,
    uint256 deadline,
    Signature signature
) payable returns (address token, address pool)

Creates a new ERC-20 token and Uniswap V3 pool with signature authorization

Parameters Explained:

• name, symbol: Token metadata

• ipaId: IP Asset ID (0x0 if no IP claimed)

• startTickList, allocationList: Liquidity distribution configuration

• antiSnipe: Protection against front-running

• deadline: Signature expiration timestamp

• signature: Backend-provided authorization (v, r, s)

IPWorld Contract

Address (Mainnet): 0xd0EFb8Cd4c7a3Eefe823Fe963af9661D8F0CB745 Address (Testnet): 0x77475A8ca1AfE6a6dc9E82B32210709054937099

Key Events:

event TokenDeployed(
    address indexed pool,
    address indexed token,
    address indexed tokenCreator
)

Emitted when a new token is successfully deployed

Authentication & Security

JWT Token Authentication

How to Get JWT:

1. Visit http://developers.ip.world/

2. Connect wallet

JWT Token Usage:

headers: {
  "X-Authorization": `${jwtToken}`,
}

API Endpoints

Base URL: https://prod.api.ip.world/api/v1

Endpoint	Method	Purpose	Auth Required
/ips	POST	Register IP metadata	✅ JWT
/signature/create	POST	Get token creation signature	✅ JWT
/remixes	POST	Register token/remix	✅ JWT

More get endpoints at https://prod.api.ip.world/docs/api/index.html#/

---