icpmcp

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *icpmcp* API.

[!IMPORTANT]

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Rosetta: Build Once. Integrate Your Blockchain Everywhere.

Table of Contents

• icpmcp
• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• Retries
• Error Handling
• Custom HTTP Client
• Debugging
• Development
• Maturity
• Contributions

SDK Installation

[!TIP]

To finish publishing your SDK to npm and others you must run your first generation action.

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add

PNPM

pnpm add

Bun

bun add

Yarn

yarn add  zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE]

This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are

exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "icpmcp-rosetta-api": {
      "command": "npx",
      "args": [
        "-y", "--package", "icpmcp-rosetta-api",
        "--",
        "mcp", "start",
        "--server-url", "..."
      ]
    }
  }
}

Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "icpmcp-rosetta-api": {
      "command": "npx",
      "args": [
        "-y", "--package", "icpmcp-rosetta-api",
        "--",
        "mcp", "start",
        "--server-url", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package icpmcp -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Icpmcp } from "icpmcp-rosetta-api";

const icpmcp = new Icpmcp({
  serverURL: "https://api.example.com",
});

async function run() {
  const result = await icpmcp.network.networkList({});

  console.log(result);
}

run();

Available Resources and Operations

Available methods

account

• accountBalance - Get an Account's Balance
• accountCoins - Get an Account's Unspent Coins

block

• block - Get a Block
• blockTransaction - Get a Block Transaction

call

• call - Make a Network-Specific Procedure Call

construction

• constructionDerive - Derive an AccountIdentifier from a PublicKey
• constructionPreprocess - Create a Request to Fetch Metadata
• constructionMetadata - Get Metadata for Transaction Construction
• constructionPayloads - Generate an Unsigned Transaction and Signing Payloads
• constructionCombine - Create Network Transaction from Signatures
• constructionParse - Parse a Transaction
• constructionHash - Get the Hash of a Signed Transaction
• constructionSubmit - Submit a Signed Transaction

events

• eventsBlocks - [INDEXER] Get a range of BlockEvents

mempool

• mempool - Get All Mempool Transactions
• mempoolTransaction - Get a Mempool Transaction

network

• networkList - Get List of Available Networks
• networkStatus - Get Network Status
• networkOptions - Get Network Options

search

• searchTransactions - [INDEXER] Search for Transactions

Standalone functions

All the methods listed above are available as standalone functions. These

functions are ideal for use in applications running in the browser, serverless

runtimes or other environments where application bundle size is a primary

concern. When using a bundler to build your application, all unused

functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

• [accountAccountBalance](docs/sdks/account/README.md#accountbalance) - Get an Account's Balance
• [accountAccountCoins](docs/sdks/account/README.md#accountcoins) - Get an Account's Unspent Coins
• [blockBlock](docs/sdks/block/README.md#block) - Get a Block
• [blockBlockTransaction](docs/sdks/block/README.md#blocktransaction) - Get a Block Transaction
• [callCall](docs/sdks/call/README.md#call) - Make a Network-Specific Procedure Call
• [constructionConstructionCombine](docs/sdks/construction/README.md#constructioncombine) - Create Network Transaction from Signatures
• [constructionConstructionDerive](docs/sdks/construction/README.md#constructionderive) - Derive an AccountIdentifier from a PublicKey
• [constructionConstructionHash](docs/sdks/construction/README.md#constructionhash) - Get the Hash of a Signed Transaction
• [constructionConstructionMetadata](docs/sdks/construction/README.md#constructionmetadata) - Get Metadata for Transaction Construction
• [constructionConstructionParse](docs/sdks/construction/README.md#constructionparse) - Parse a Transaction
• [constructionConstructionPayloads](docs/sdks/construction/README.md#constructionpayloads) - Generate an Unsigned Transaction and Signing Payloads
• [constructionConstructionPreprocess](docs/sdks/construction/README.md#constructionpreprocess) - Create a Request to Fetch Metadata
• [constructionConstructionSubmit](docs/sdks/construction/README.md#constructionsubmit) - Submit a Signed Transaction
• [eventsEventsBlocks](docs/sdks/events/README.md#eventsblocks) - [INDEXER] Get a range of BlockEvents
• [mempoolMempool](docs/sdks/mempool/README.md#mempool) - Get All Mempool Transactions
• [mempoolMempoolTransaction](docs/sdks/mempool/README.md#mempooltransaction) - Get a Mempool Transaction
• [networkNetworkList](docs/sdks/network/README.md#networklist) - Get List of Available Networks
• [networkNetworkOptions](docs/sdks/network/README.md#networkoptions) - Get Network Options
• [networkNetworkStatus](docs/sdks/network/README.md#networkstatus) - Get Network Status
• [searchSearchTransactions](docs/sdks/search/README.md#searchtransactions) - [INDEXER] Search for Transactions

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Icpmcp } from "icpmcp-rosetta-api";

const icpmcp = new Icpmcp({
  serverURL: "https://api.example.com",
});

async function run() {
  const result = await icpmcp.network.networkList({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Icpmcp } from "icpmcp-rosetta-api";

const icpmcp = new Icpmcp({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await icpmcp.network.networkList({});

  console.log(result);
}

run();

Error Handling

[IcpmcpError](./src/models/errors/icpmcperror.ts) is the base class for all HTTP error responses. It has the following properties:

Example

import { Icpmcp } from "icpmcp-rosetta-api";
import * as errors from "icpmcp/models/errors";

const icpmcp = new Icpmcp({
  serverURL: "https://api.example.com",
});

async function run() {
  try {
    const result = await icpmcp.network.networkList({});

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.IcpmcpError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorT) {
        console.log(error.data$.code); // number
        console.log(error.data$.message); // string
        console.log(error.data$.description); // string
        console.log(error.data$.retriable); // boolean
        console.log(error.data$.details); // models.Details
      }
    }
  }
}

run();

Error Classes

Primary errors:

• [IcpmcpError](./src/models/errors/icpmcperror.ts): The base class for HTTP error responses.
• [ErrorT](docs/models/errors/errort.md): Instead of utilizing HTTP status codes to describe node errors (which often do not have a good analog), rich errors are returned using this object. Both the code and message fields can be individually used to correctly identify an error. Implementations MUST use unique values for both fields. Status code 500.

Less common errors (6)

Network errors:

• [ConnectionError](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
• [RequestTimeoutError](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
• [RequestAbortedError](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
• [InvalidRequestError](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
• [UnexpectedClientError](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.

**Inherit from [IcpmcpError](./src/models/errors/icpmcperror.ts)**:

• [ResponseValidationError](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native

Fetch API. This

client is a thin wrapper around fetch and provides the ability to attach hooks

around the request lifecycle that can be used to modify the request or handle

errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be

used to integrate a third-party HTTP client or when writing tests to mock out

the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a

custom header and a timeout to requests and how to use the "requestError" hook

to log errors:

import { Icpmcp } from "icpmcp-rosetta-api";
import { HTTPClient } from "icpmcp/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Icpmcp({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING]

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Icpmcp } from "icpmcp-rosetta-api";

const sdk = new Icpmcp({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable ICPMCP_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage

to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally

looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.

We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy