Skip to content

JoAiHQ/warps-sdk-js

Repository files navigation

🧰 Warp Protocol SDK for Typescript

npm (scoped)

Warps are executable actions that enable cross-chain transactions, smart contract interactions, blockchain operations, off-chain API calls, and AI tool integrations through a standardized JSON format. This SDK provides TypeScript tools to create, execute, and manage Warps across multiple blockchain networks.

Documentation

For detailed documentation, including setup guides, API descriptions, and usage examples, please visit the docs.

Installation

To integrate the Warps JavaScript SDK into your project, run the following command:

npm install @joai/warps

Packages

This monorepo contains the following packages:

Core

  • core - Core Warps SDK functionality

Adapters

Wallets

Utilities

  • mcp - MCP (Model Context Protocol) integration
  • vm-browser - Browser VM runtime for output transformations
  • vm-node - Node.js VM runtime for output transformations
  • playground - Development playground

Warp Action Types

Warps support the following action types:

  • transfer - Transfer tokens or native currency to an address
  • contract - Execute a smart contract function with optional value and gas limit
  • query - Query contract state (read-only, no transaction)
  • collect - Collect data via HTTP requests to external endpoints
  • link - Navigate to a URL
  • mcp - Execute MCP (Model Context Protocol) tools
  • prompt - Display a prompt to the user for input

License

This project is released under the MIT License. See the LICENSE file for more details.

Packages

 
 
 

Contributors