@easy1staking/cip113-sdk-ts

TypeScript SDK for CIP-113 Programmable Tokens on Cardano.

Build, transfer, mint, burn, freeze, and seize programmable tokens with a clean, pluggable API.

Install

npm install @easy1staking/cip113-sdk-ts @evolution-sdk/evolution effect

Quick Start

import { CIP113, evoClient, preprodChain } from "@easy1staking/cip113-sdk-ts";
import { freezeAndSeizeSubstandard } from "@easy1staking/cip113-sdk-ts/freeze-and-seize";

// 1. Create a client
const client = evoClient(preprodChain)
  .withBlockfrost({ projectId: "your_key", baseUrl: "https://cardano-preprod.blockfrost.io/api/v0" })
  .withSeed({ mnemonic: "your 24 word seed phrase" });

// 2. Initialize the protocol with a substandard
const protocol = CIP113.init({
  client,
  standard: { blueprint: standardBlueprint, deployment: deploymentParams },
  substandards: [fes],
});

// 3. Transfer programmable tokens
const result = await protocol.transfer({
  senderAddress: "addr_test1...",
  recipientAddress: "addr_test1...",
  tokenPolicyId: "abcd1234...",
  assetName: "0014df1044454d4f",          // raw hex, CIP-68 prefix included
  quantity: 1000n,
  substandardId: "freeze-and-seize",      // always specify for direct routing
});

// 4. Sign and submit
const txHash = await result._signBuilder.signAndSubmit();
await client.awaitTx(txHash);

Substandards

| Substandard | Import | Capabilities | |-------------|--------|-------------| | Freeze-and-Seize | @easy1staking/cip113-sdk-ts/freeze-and-seize | Register, Transfer, Mint, Burn, Freeze, Unfreeze, Seize | | Dummy | @easy1staking/cip113-sdk-ts/dummy | Transfer (testing only) |

Exports

| Path | Description | |------|-------------| | @easy1staking/cip113-sdk-ts | Core SDK: CIP113, types, utilities | | @easy1staking/cip113-sdk-ts/freeze-and-seize | Freeze-and-Seize substandard | | @easy1staking/cip113-sdk-ts/dummy | Dummy substandard |

Examples

⚠ The examples do not currently run. Do not follow this section yet.

Two things are wrong with it, both known and neither hidden:

1. The scripts target a superseded protocol. They are written against a CIP-113 0.3.x deployment on preprod. This SDK now targets 0.5.0-alpha.2, in which programmable_logic_global no longer exists and DeploymentParams has a different shape. The scripts cannot work against that deployment, and the deployment cannot be represented by this SDK.
2. .env.example does not exist. The cp below has never worked.

Nothing here is covered by CI — examples/ is a separate package, outside the root typecheck and outside the test suite, so neither defect can fail a build.

Choosing a replacement target is an open decision (a local devnet, or a freshly deployed preprod instance); it is tracked in PLAN.md under workstream W-E, slice S-7. Until it is made, the working end-to-end reference is the devnet suite — npm run test:devnet — which exercises bootstrap, register, mint, transfer, third-party transfer and an in-place upgrade against a live chain. See docs/devnet.md.

The examples/ directory contains runnable scripts for the full token lifecycle:

cd examples
cp .env.example .env    # add your Blockfrost key + seed phrase
npm install
npm run fes:setup
npm run fes:init-compliance
npm run fes:register
npm run fes:transfer
npm run fes:mint
npm run fes:burn
npm run fes:freeze
npm run fes:transfer-blocked
npm run fes:seize
npm run fes:unfreeze
npm run fes:transfer-unfrozen

Each script is standalone — run them sequentially to walk through the complete Freeze-and-Seize lifecycle.

Documentation

• Provenance: CIP-171 and blueprint pins — what ships, how to build a record, and why compilerVersion must come from the artefact

• Getting Started — prerequisites, setup, first token

• API Reference — all types, methods, utilities

• Freeze-and-Seize — compliance substandard

• Dummy — minimal test substandard

Peer Dependencies

• @evolution-sdk/evolution ^0.5.2
• effect ^3.0.0

License

Apache-2.0