SDK Overview

@arbilink/sdk is the official TypeScript SDK for sending and tracking cross-chain messages via ArbiLink.

Installation

pnpm add @arbilink/sdk ethers

Exports

// Main class
export { ArbiLink } from '@arbilink/sdk';

// Types
export type {
  ChainId,
  ChainName,
  ChainConfig,
  Message,
  MessageStatus,
  RelayerInfo,
  SendMessageParams,
  WatchOptions,
} from '@arbilink/sdk';

// Errors
export { ArbiLinkError } from '@arbilink/sdk';

// Constants
export {
  ARBITRUM_SEPOLIA_CHAIN_ID,
  ARBITRUM_SEPOLIA_RPC,
  SUPPORTED_CHAINS,
  CHAIN_IDS,
  MESSAGE_HUB_ADDRESS,
  RECEIVER_ADDRESSES,
  DEFAULT_CHALLENGE_PERIOD_SECS,
} from '@arbilink/sdk';

// Utilities
export {
  encodeCall,
  formatMessageId,
  formatEth,
  statusLabel,
  resolveChainId,
  estimateDeliveryTime,
  parseStatusCode,
} from '@arbilink/sdk';

// ABIs (useful for integrators building their own wrappers)
export { default as MessageHubABI } from '@arbilink/sdk/abi/MessageHub.json';
export { default as ReceiverABI }   from '@arbilink/sdk/abi/Receiver.json';

Quick Reference

Method	Description
new ArbiLink(signerOrProvider)	Create an SDK instance
sendMessage(params)	Send a cross-chain message
getMessageStatus(id)	Get current status of a message
calculateFee(chainId)	Get the fee to send to a chain
watchMessage(id, cb)	Subscribe to message status updates
messageCount()	Total messages sent through the hub
owner()	Hub owner address
minStake()	Minimum relayer stake
challengePeriod()	Challenge window in seconds
getChainInfo(chainId)	Get registered chain configuration
getRelayerInfo(address)	Fetch relayer details (stake, deliveries)
isActiveRelayer(address)	Check if an address is a staked relayer
registerRelayer(stake?)	Register as a relayer
exitRelayer()	Deregister and withdraw stake
withdrawProtocolFees()	Withdraw protocol fees (owner only)

Supported Chains

Chain	Chain ID	Status
Arbitrum Sepolia (hub)	421614	Hub
Ethereum Sepolia	11155111	Supported
Base Sepolia	84532	Supported
Polygon Amoy	80002	Supported

Design Philosophy

The SDK is designed to be:

• Minimal — no extra dependencies beyond ethers
• Type-safe — all inputs and outputs are fully typed
• Composable — works with any ethers Signer or Provider
• Error-informative — descriptive errors with chain context

References

• ArbiLink Class
• Methods
• Types
• Errors