Skip to content

README.md

Latest commit

 

History

History
72 lines (54 loc) · 1.42 KB

README.md

File metadata and controls

72 lines (54 loc) · 1.42 KB
Raw

Bridge Watch Contract Integration SDK

TypeScript SDK for integrating external apps with BridgeWatch Soroban contracts.

Features

  • Contract method wrappers
  • Connection management
  • Transaction build/simulate/send flow
  • Query helpers
  • Event subscription polling
  • Strong TypeScript type definitions
  • Structured SDK errors
  • Testing utilities
  • NPM publication-ready package metadata

Install

npm install @bridge-watch/contract-sdk

Quick start

import { Networks, xdr } from "@stellar/stellar-sdk";
import { BridgeWatchContractSdk } from "@bridge-watch/contract-sdk";

const sdk = new BridgeWatchContractSdk({
  rpcUrl: "https://soroban-testnet.stellar.org",
  contractId: "CCONTRACTID",
  networkPassphrase: Networks.TESTNET,
});

await sdk.connect();

const result = await sdk.queryMethod({
  method: "get_health",
  args: [xdr.ScVal.scvString("USDC")],
});

API surface

  • BridgeWatchContractSdk
    • connect()
    • disconnect()
    • getHealth()
    • buildInvokeTransaction()
    • simulateTransaction()
    • sendTransaction()
    • invokeAndSend()
    • queryMethod()
    • subscribeToEvents()

Errors

  • BridgeWatchSdkError
  • BridgeWatchConnectionError
  • BridgeWatchTransactionError
  • BridgeWatchQueryError

Testing utilities

  • createMockScValString()
  • createMockScValU64()
  • createMockEvent()
  • createMockWatchSubscription()

Example

See sdk/examples/basic-usage.ts.