@sip-protocol/sdk 0.1.0

package/src/index.ts

@@ -0,0 +1,369 @@
+/**
+ * @sip-protocol/sdk
+ *
+ * Core SDK for Shielded Intents Protocol (SIP)
+ *
+ * @example
+ * ```typescript
+ * import { SIP, PrivacyLevel } from '@sip-protocol/sdk'
+ *
+ * const sip = new SIP({ network: 'testnet' })
+ *
+ * const intent = await sip.createIntent({
+ *   input: { chain: 'solana', token: 'SOL', amount: 10n },
+ *   output: { chain: 'ethereum', token: 'ETH' },
+ *   privacy: PrivacyLevel.SHIELDED,
+ * })
+ *
+ * const quotes = await sip.getQuotes(intent)
+ * const result = await sip.execute(intent, quotes[0])
+ * ```
+ */
+
+// Errors and Error Utilities
+export {
+  // Error codes
+  ErrorCode,
+  // Base error
+  SIPError,
+  // Specialized errors
+  ValidationError,
+  CryptoError,
+  ProofError,
+  IntentError,
+  NetworkError,
+  // Legacy errors (now extend proper parent classes)
+  ProofNotImplementedError,
+  EncryptionNotImplementedError,
+  // Utility functions
+  isSIPError,
+  hasErrorCode,
+  wrapError,
+  getErrorMessage,
+} from './errors'
+
+export type { SerializedError } from './errors'
+
+// Main client
+export { SIP, createSIP } from './sip'
+export type { SIPConfig, WalletAdapter } from './sip'
+
+// Intent creation
+export {
+  IntentBuilder,
+  createShieldedIntent,
+  attachProofs,
+  hasRequiredProofs,
+  trackIntent,
+  isExpired,
+  getTimeRemaining,
+  serializeIntent,
+  deserializeIntent,
+  getIntentSummary,
+} from './intent'
+export type { CreateIntentOptions } from './intent'
+
+// Stealth addresses
+export {
+  generateStealthMetaAddress,
+  generateStealthAddress,
+  deriveStealthPrivateKey,
+  checkStealthAddress,
+  encodeStealthMetaAddress,
+  decodeStealthMetaAddress,
+} from './stealth'
+
+// Privacy utilities
+export {
+  getPrivacyConfig,
+  generateViewingKey,
+  deriveViewingKey,
+  encryptForViewing,
+  decryptWithViewing,
+  getPrivacyDescription,
+} from './privacy'
+// Note: isValidPrivacyLevel is exported from validation.ts
+export type { PrivacyConfig, TransactionData } from './privacy'
+
+// Crypto utilities (legacy - use commitment module for new code)
+// For ZK proofs, use ProofProvider from './proofs'
+export {
+  createCommitment,
+  verifyCommitment,
+  generateIntentId,
+  hash,
+  generateRandomBytes,
+} from './crypto'
+
+// Pedersen Commitments (recommended for new code)
+export {
+  commit,
+  verifyOpening,
+  commitZero,
+  addCommitments,
+  subtractCommitments,
+  addBlindings,
+  subtractBlindings,
+  getGenerators,
+  generateBlinding,
+} from './commitment'
+
+export type {
+  PedersenCommitment,
+  CommitmentPoint,
+} from './commitment'
+
+// Validation utilities
+export {
+  isValidChainId,
+  isValidPrivacyLevel,
+  isValidHex,
+  isValidHexLength,
+  isValidAmount,
+  isNonNegativeAmount,
+  isValidSlippage,
+  isValidStealthMetaAddress,
+  isValidCompressedPublicKey,
+  isValidPrivateKey,
+  isValidScalar,
+  validateCreateIntentParams,
+  validateAsset,
+  validateIntentInput,
+  validateIntentOutput,
+  validateViewingKey,
+  validateScalar,
+} from './validation'
+
+// Proof providers
+export {
+  MockProofProvider,
+  NoirProofProvider,
+  ProofGenerationError,
+} from './proofs'
+
+export type {
+  ProofProvider,
+  ProofFramework,
+  FundingProofParams,
+  ValidityProofParams,
+  FulfillmentProofParams,
+  OracleAttestation,
+  ProofResult,
+  NoirProviderConfig,
+} from './proofs'
+
+// Re-export types for convenience
+export {
+  PrivacyLevel,
+  IntentStatus,
+  SIP_VERSION,
+  NATIVE_TOKENS,
+  isPrivate,
+  supportsViewingKey,
+} from '@sip-protocol/types'
+
+export type {
+  ShieldedIntent,
+  CreateIntentParams,
+  TrackedIntent,
+  Quote,
+  FulfillmentResult,
+  StealthMetaAddress,
+  StealthAddress,
+  StealthAddressRecovery,
+  Commitment,
+  ZKProof,
+  ViewingKey,
+  Asset,
+  ChainId,
+  HexString,
+  Hash,
+} from '@sip-protocol/types'
+
+// Network Adapters
+export {
+  OneClickClient,
+  NEARIntentsAdapter,
+  createNEARIntentsAdapter,
+} from './adapters'
+
+export type {
+  SwapRequest,
+  PreparedSwap,
+  SwapResult,
+  NEARIntentsAdapterConfig,
+} from './adapters'
+
+// Solver
+export { MockSolver, createMockSolver } from './solver'
+export type { MockSolverConfig } from './solver'
+
+// Re-export solver types
+export type {
+  Solver,
+  SolverCapabilities,
+  SolverVisibleIntent,
+  SolverQuote,
+  SIPSolver,
+  FulfillmentStatus,
+  FulfillmentRequest,
+  FulfillmentCommitment,
+  FulfillmentProof,
+  SwapRoute,
+  SwapRouteStep,
+  SolverEvent,
+  SolverEventListener,
+} from '@sip-protocol/types'
+
+// Re-export NEAR Intents types for convenience
+export {
+  OneClickSwapType,
+  OneClickSwapStatus,
+  OneClickDepositMode,
+  OneClickErrorCode,
+} from '@sip-protocol/types'
+
+export type {
+  OneClickConfig,
+  OneClickQuoteRequest,
+  OneClickQuoteResponse,
+  OneClickStatusResponse,
+  DefuseAssetId,
+} from '@sip-protocol/types'
+
+// Zcash
+export {
+  ZcashRPCClient,
+  ZcashRPCError,
+  createZcashClient,
+  ZcashShieldedService,
+  createZcashShieldedService,
+} from './zcash'
+export { ZcashErrorCode } from '@sip-protocol/types'
+
+export type {
+  ZcashShieldedServiceConfig,
+  ShieldedSendParams,
+  ShieldedSendResult,
+  ReceivedNote,
+  ShieldedBalance,
+  ExportedViewingKey,
+} from './zcash'
+
+export type {
+  ZcashConfig,
+  ZcashNetwork,
+  ZcashAddressType,
+  ZcashReceiverType,
+  ZcashAddressInfo,
+  ZcashNewAccount,
+  ZcashAccountAddress,
+  ZcashPoolBalance,
+  ZcashAccountBalance,
+  ZcashPool,
+  ZcashUnspentNote,
+  ZcashSendRecipient,
+  ZcashPrivacyPolicy,
+  ZcashShieldedSendParams,
+  ZcashOperationStatus,
+  ZcashOperationTxResult,
+  ZcashOperationError,
+  ZcashOperation,
+  ZcashBlockHeader,
+  ZcashBlock,
+  ZcashBlockchainInfo,
+  ZcashNetworkInfo,
+} from '@sip-protocol/types'
+
+// Wallet Adapters
+export {
+  BaseWalletAdapter,
+  MockWalletAdapter,
+  WalletError,
+  notConnectedError,
+  featureNotSupportedError,
+  walletRegistry,
+  registerWallet,
+  createWalletFactory,
+  isPrivateWalletAdapter,
+  WalletErrorCode,
+  // Solana
+  SolanaWalletAdapter,
+  createSolanaAdapter,
+  MockSolanaAdapter,
+  createMockSolanaAdapter,
+  createMockSolanaProvider,
+  createMockSolanaConnection,
+  getSolanaProvider,
+  detectSolanaWallets,
+  solanaPublicKeyToHex,
+  base58ToHex,
+  // Ethereum
+  EthereumWalletAdapter,
+  createEthereumAdapter,
+  MockEthereumAdapter,
+  createMockEthereumAdapter,
+  createMockEthereumProvider,
+  getEthereumProvider,
+  detectEthereumWallets,
+  toHex,
+  fromHex,
+  hexToNumber,
+  normalizeAddress,
+  getDefaultRpcEndpoint,
+  EthereumChainId,
+} from './wallet'
+
+export type {
+  WalletConnectionState,
+  Signature,
+  UnsignedTransaction,
+  SignedTransaction,
+  TransactionReceipt,
+  WalletEventType,
+  WalletEvent,
+  WalletEventHandler,
+  WalletConnectEvent,
+  WalletDisconnectEvent,
+  WalletAccountChangedEvent,
+  WalletChainChangedEvent,
+  WalletErrorEvent,
+  WalletAdapter as IWalletAdapter,
+  PrivateWalletAdapter,
+  WalletShieldedSendParams,
+  WalletShieldedSendResult,
+  WalletInfo,
+  WalletAdapterFactory,
+  WalletRegistryEntry,
+  // Solana types
+  SolanaPublicKey,
+  SolanaTransaction,
+  SolanaVersionedTransaction,
+  SolanaWalletProvider,
+  SolanaWalletName,
+  SolanaCluster,
+  SolanaAdapterConfig,
+  SolanaConnection,
+  SolanaSendOptions,
+  SolanaUnsignedTransaction,
+  SolanaSignature,
+  MockSolanaAdapterConfig,
+  // Ethereum types
+  EIP1193Provider,
+  EIP1193RequestArguments,
+  EIP1193Event,
+  EIP1193ConnectInfo,
+  EIP1193ProviderRpcError,
+  EIP712Domain,
+  EIP712TypeDefinition,
+  EIP712Types,
+  EIP712TypedData,
+  EthereumTransactionRequest,
+  EthereumTransactionReceipt,
+  EthereumTokenMetadata,
+  EthereumChainMetadata,
+  EthereumWalletName,
+  EthereumAdapterConfig,
+  EthereumChainIdType,
+  MockEthereumAdapterConfig,
+} from './wallet'