@bananalink-sdk/protocol 1.2.7

package/dist/index.d.ts

@@ -0,0 +1,379 @@
+import { D as DAppMetadata, S as SessionConfig } from './core-DMhuNfoz.js';
+export { C as CreateSessionRequest, e as CreateSessionResponse, a as SIWEFields, c as SecurityPolicy, d as SessionMetadata, b as SessionOptions } from './core-DMhuNfoz.js';
+export { C as CryptoParameters, b as CryptoPayload, E as Encryption, a as KeyDerivation, K as KeyExchange, P as PublicKeyJWK } from './crypto-BUS06Qz-.js';
+import { Q as QRPayload } from './client-session-claim-3QF3noOr.js';
+export { A as AuthenticateConnectionPayload, j as AuthenticationData, e as ClaimSessionPayload, F as ClientMessageEnvelope, B as ClientMessagePayload, y as ClientReconnectPayload, C as ClientSessionClaim, N as ClientSessionClaimManager, b as ClientSessionClaimStorage, z as CloseSessionPayload, n as ConnectionAuthenticatedMessage, m as ConnectionRejectedMessage, f as ConnectionRejectedPayload, D as DisplayInfo, E as EncryptedPayload, P as PrefetchMetadataPayload, o as PrefetchMetadataResponse, i as RejectionData, c as RelayMessage, R as RelayMessageType, p as RelayToDAppMessage, l as WalletHandshakeMessage, d as WalletMessageEnvelope, h as WalletMessagePayload, k as WalletMetadata, g as WalletReconnectPayload, W as WalletSessionClaim, I as WalletSessionClaimManager, a as WalletSessionClaimStorage, O as createClientMessageEnvelope, J as createWalletMessageEnvelope, t as isAuthenticateConnectionPayload, q as isClaimSessionPayload, G as isClientReconnectPayload, H as isCloseSessionPayload, x as isConnectionAuthenticatedMessage, w as isConnectionRejectedMessage, s as isConnectionRejectedPayload, r as isPrefetchMetadataPayload, v as isWalletHandshakeMessage, u as isWalletReconnectPayload, S as stripClientSessionClaim, K as stripWalletSessionClaim, L as validateClaimTimestamp, T as validateClientClaimTimestamp, U as validateClientMessageEnvelope, M as validateWalletMessageEnvelope } from './client-session-claim-3QF3noOr.js';
+export { SIWEMessageOptions } from './siwe-export.js';
+
+type ProviderType = 'uwebsockets' | 'websocket' | 'pusher' | 'ably';
+interface ProviderConfig {
+    providerId: string;
+    type: ProviderType;
+    enabled: boolean;
+    priority: number;
+    config: UWebSocketConfig | PusherConfig | AblyConfig;
+    features?: string[];
+}
+interface ProviderConfigResponse {
+    providers: ProviderConfig[];
+    ttl: number;
+    lastUpdated: string;
+}
+interface UWebSocketConfig {
+    relayUrl: string;
+    maxConnections?: number;
+    reconnectInterval?: number;
+    heartbeatInterval?: number;
+    maxPayloadLength?: number;
+    idleTimeout?: number;
+    fallbackUrl?: string;
+}
+interface PusherConfig {
+    appKey: string;
+    key?: string;
+    cluster: string;
+    encrypted?: boolean;
+    authEndpoint?: string;
+    useTLS?: boolean;
+    host?: string;
+    timeout?: number;
+}
+interface AblyConfig {
+    apiKey: string;
+    key?: string;
+    clientId?: string;
+    authUrl?: string;
+    environment?: string;
+    tls?: boolean;
+    timeout?: number;
+    clientOptions?: Record<string, unknown>;
+}
+
+interface SessionClosedAck {
+    type: 'session_closed_ack';
+    timestamp: number;
+}
+interface SessionClosedNotification {
+    type: 'session_closed_notification';
+    closedBy: 'client' | 'wallet';
+    reason?: string;
+    timestamp: number;
+}
+interface ReconnectedMessage {
+    type: 'reconnected';
+    queuedMessages: number;
+    timestamp: number;
+}
+type RelayNotificationMessage = SessionClosedAck | SessionClosedNotification | ReconnectedMessage;
+declare function isSessionClosedAck(message: RelayNotificationMessage): message is SessionClosedAck;
+declare function isSessionClosedNotification(message: RelayNotificationMessage): message is SessionClosedNotification;
+declare function isReconnectedMessage(message: RelayNotificationMessage): message is ReconnectedMessage;
+
+type BananaLinkErrorCode = 'SESSION_EXPIRED' | 'SESSION_NOT_FOUND' | 'SESSION_ALREADY_CLAIMED' | 'INVALID_SESSION_CLAIM' | 'INVALID_CLIENT_CLAIM' | 'SESSION_TOKEN_EXPIRED' | 'SESSION_CLOSED' | 'ENCRYPTION_FAILED' | 'DECRYPTION_FAILED' | 'INVALID_SIGNATURE' | 'NETWORK_ERROR' | 'RELAY_ERROR' | 'MESSAGE_QUEUE_FULL' | 'RATE_LIMIT_EXCEEDED' | 'ORIGIN_MISMATCH' | 'REQUEST_PENDING' | 'REQUEST_NOT_FOUND' | 'REQUEST_EXPIRED' | 'REQUEST_INVALID' | 'REQUEST_TIMEOUT' | 'SIGNING_FAILED' | 'SIGNING_REJECTED' | 'TRANSACTION_INVALID' | 'CHAIN_MISMATCH';
+interface ProtocolErrorResponse {
+    type: 'error';
+    code: string;
+    message: string;
+    details?: unknown;
+}
+type WalletRejectionReason = 'user_declined' | 'untrusted_dapp' | 'unsupported_chain' | 'insufficient_balance' | 'wallet_locked' | 'timeout' | 'security_warning' | 'rate_limited';
+type RelayRejectionReason = 'session_already_claimed' | 'invalid_credentials' | 'session_expired' | 'session_closed' | 'dapp_metadata_missing' | 'encryption_mismatch' | 'relay_overloaded';
+type RejectionReason = WalletRejectionReason | RelayRejectionReason;
+
+type SessionState = 'created' | 'claimed' | 'authenticated' | 'active' | 'disconnected' | 'closed' | 'expired' | 'rejected';
+interface SessionInfo {
+    sessionId: string;
+    state: SessionState;
+    address?: string;
+    dappId: string;
+    dappInfo: Pick<DAppMetadata, 'name' | 'url'>;
+    sessionConfig?: SessionConfig;
+    createdAt: string;
+    lastActivity: string;
+    expiresAt?: string;
+}
+interface SessionSecurity {
+    sharedSecret: CryptoKey;
+    sessionId: string;
+}
+interface OriginProof {
+    domain: string;
+    timestamp: number;
+    signature: string;
+}
+
+declare const PROTOCOL_VERSION = 1;
+declare const DEEPLINK_SCHEME = "bananalink";
+declare const DEFAULT_RELAY_URL = "wss://relay.banana.link/v1";
+declare const FRUITS: readonly ["🍌", "🍎", "🍊", "🍇", "🍓", "🍑", "🍒", "🍉", "🥝", "🍍", "🥭", "🥥", "🫐", "🍈", "🍋", "🥑"];
+declare const DEFAULT_TIMEOUTS: {
+    readonly sessionTimeout: number;
+    readonly requestTimeout: number;
+    readonly connectionTimeout: number;
+    readonly qrCodeTimeout: number;
+};
+declare const PROTOCOL_V2_TIMEOUTS: {
+    readonly sessionCreation: number;
+    readonly claimSession: number;
+    readonly prefetchMetadata: number;
+    readonly userApproval: number;
+    readonly authentication: number;
+    readonly sessionTTL: number;
+    readonly reconnectionWindow: number;
+    readonly messageQueueRetention: number;
+    readonly websocketHeartbeat: number;
+    readonly gracefulCloseTimeout: number;
+    readonly signMessage: number;
+    readonly signTypedData: number;
+    readonly signTransaction: number;
+};
+declare const MESSAGE_QUEUE_CONFIG: {
+    readonly maxQueueSize: 100;
+    readonly retentionTime: number;
+    readonly overflowStrategy: "drop_oldest";
+};
+declare const SECURITY_LIMITS: {
+    readonly maxConcurrentSessions: 5;
+    readonly maxSessionAge: number;
+    readonly minNonceLength: 8;
+    readonly maxMessageSize: number;
+    readonly maxResourcesCount: 10;
+    readonly rateLimit: {
+        readonly requestsPerMinute: 60;
+        readonly sessionsPerHour: 100;
+    };
+};
+declare const CRYPTO_CONSTANTS: {
+    readonly keyLength: 256;
+    readonly ivLength: 12;
+    readonly tagLength: 16;
+    readonly curve: "P-256";
+    readonly algorithm: "AES-GCM";
+    readonly hashAlgorithm: "SHA-256";
+};
+declare const MESSAGE_FORMAT: {
+    readonly version: "1";
+    readonly encoding: "utf8";
+    readonly lineBreak: "\n";
+    readonly resourcePrefix: "- ";
+};
+declare const WS_MESSAGE_TYPES: {
+    readonly subscribe: "sub";
+    readonly publish: "pub";
+    readonly acknowledge: "ack";
+    readonly error: "error";
+};
+declare const HTTP_ENDPOINTS: {
+    readonly messages: "/v1/messages";
+    readonly session: "/v1/session";
+    readonly health: "/v1/health";
+};
+declare const ERROR_MESSAGES: {
+    readonly SESSION_EXPIRED: "Session has expired";
+    readonly SESSION_NOT_FOUND: "Session ID invalid or expired";
+    readonly SESSION_ALREADY_CLAIMED: "Session already claimed by another wallet";
+    readonly INVALID_SESSION_CLAIM: "Wallet does not own this session";
+    readonly INVALID_CLIENT_CLAIM: "Client session claim does not match";
+    readonly SESSION_TOKEN_EXPIRED: "Session token TTL exceeded";
+    readonly SESSION_CLOSED: "Session has been closed";
+    readonly ENCRYPTION_FAILED: "Message encryption failed";
+    readonly DECRYPTION_FAILED: "Cannot decrypt message";
+    readonly INVALID_SIGNATURE: "Invalid signature";
+    readonly NETWORK_ERROR: "Network connection error";
+    readonly RELAY_ERROR: "Internal relay server error";
+    readonly MESSAGE_QUEUE_FULL: "Too many queued messages (>100)";
+    readonly RATE_LIMIT_EXCEEDED: "Rate limit exceeded";
+    readonly ORIGIN_MISMATCH: "Origin verification failed";
+    readonly REQUEST_PENDING: "Another signing request is already pending";
+    readonly REQUEST_NOT_FOUND: "Request ID not found or already processed";
+    readonly REQUEST_EXPIRED: "Request expired before completion";
+    readonly REQUEST_INVALID: "Request data is invalid or malformed";
+    readonly REQUEST_TIMEOUT: "Request timed out waiting for wallet response";
+    readonly SIGNING_FAILED: "Cryptographic signing operation failed";
+    readonly SIGNING_REJECTED: "User rejected the signing request";
+    readonly TRANSACTION_INVALID: "Transaction parameters validation failed";
+    readonly CHAIN_MISMATCH: "Requested chain ID does not match wallet chain";
+};
+declare const QR_CONFIG: {
+    readonly size: 256;
+    readonly margin: 4;
+    readonly errorCorrectionLevel: "M";
+    readonly type: "image/png";
+};
+declare const DEEP_LINK_CONFIG: {
+    readonly scheme: "bananalink";
+    readonly host: "connect";
+    readonly universal: "https://bananalink.app";
+};
+declare const NETWORK_CONFIG: {
+    readonly SUPPORTED_CHAINS: readonly [1, 5, 137, 80001, 42161, 421613, 10, 420];
+    readonly DEFAULT_CHAIN_ID: 1;
+    readonly CHAIN_NAMES: {
+        readonly 1: "Ethereum Mainnet";
+        readonly 5: "Goerli Testnet";
+        readonly 137: "Polygon Mainnet";
+        readonly 80001: "Polygon Mumbai";
+        readonly 42161: "Arbitrum One";
+        readonly 421613: "Arbitrum Goerli";
+        readonly 10: "Optimism";
+        readonly 420: "Optimism Goerli";
+    };
+};
+declare const DEV_CONFIG: {
+    readonly logLevel: "debug";
+    readonly enableMocks: false;
+    readonly skipValidation: false;
+    readonly allowLocalhost: true;
+};
+declare const BANANALINK_CONSTANTS: {
+    readonly PROTOCOL_VERSION: 1;
+    readonly PACKAGE_NAME: "@bananalink-sdk/protocol";
+    readonly DEEPLINK_SCHEME: "bananalink";
+    readonly DEFAULT_RELAY_URL: "wss://relay.banana.link/v1";
+    readonly FRUITS: readonly ["🍌", "🍎", "🍊", "🍇", "🍓", "🍑", "🍒", "🍉", "🥝", "🍍", "🥭", "🥥", "🫐", "🍈", "🍋", "🥑"];
+    readonly DEFAULT_TIMEOUTS: {
+        readonly sessionTimeout: number;
+        readonly requestTimeout: number;
+        readonly connectionTimeout: number;
+        readonly qrCodeTimeout: number;
+    };
+    readonly PROTOCOL_V2_TIMEOUTS: {
+        readonly sessionCreation: number;
+        readonly claimSession: number;
+        readonly prefetchMetadata: number;
+        readonly userApproval: number;
+        readonly authentication: number;
+        readonly sessionTTL: number;
+        readonly reconnectionWindow: number;
+        readonly messageQueueRetention: number;
+        readonly websocketHeartbeat: number;
+        readonly gracefulCloseTimeout: number;
+        readonly signMessage: number;
+        readonly signTypedData: number;
+        readonly signTransaction: number;
+    };
+    readonly MESSAGE_QUEUE_CONFIG: {
+        readonly maxQueueSize: 100;
+        readonly retentionTime: number;
+        readonly overflowStrategy: "drop_oldest";
+    };
+    readonly SECURITY_LIMITS: {
+        readonly maxConcurrentSessions: 5;
+        readonly maxSessionAge: number;
+        readonly minNonceLength: 8;
+        readonly maxMessageSize: number;
+        readonly maxResourcesCount: 10;
+        readonly rateLimit: {
+            readonly requestsPerMinute: 60;
+            readonly sessionsPerHour: 100;
+        };
+    };
+    readonly CRYPTO_CONSTANTS: {
+        readonly keyLength: 256;
+        readonly ivLength: 12;
+        readonly tagLength: 16;
+        readonly curve: "P-256";
+        readonly algorithm: "AES-GCM";
+        readonly hashAlgorithm: "SHA-256";
+    };
+    readonly MESSAGE_FORMAT: {
+        readonly version: "1";
+        readonly encoding: "utf8";
+        readonly lineBreak: "\n";
+        readonly resourcePrefix: "- ";
+    };
+    readonly WS_MESSAGE_TYPES: {
+        readonly subscribe: "sub";
+        readonly publish: "pub";
+        readonly acknowledge: "ack";
+        readonly error: "error";
+    };
+    readonly HTTP_ENDPOINTS: {
+        readonly messages: "/v1/messages";
+        readonly session: "/v1/session";
+        readonly health: "/v1/health";
+    };
+    readonly ERROR_MESSAGES: {
+        readonly SESSION_EXPIRED: "Session has expired";
+        readonly SESSION_NOT_FOUND: "Session ID invalid or expired";
+        readonly SESSION_ALREADY_CLAIMED: "Session already claimed by another wallet";
+        readonly INVALID_SESSION_CLAIM: "Wallet does not own this session";
+        readonly INVALID_CLIENT_CLAIM: "Client session claim does not match";
+        readonly SESSION_TOKEN_EXPIRED: "Session token TTL exceeded";
+        readonly SESSION_CLOSED: "Session has been closed";
+        readonly ENCRYPTION_FAILED: "Message encryption failed";
+        readonly DECRYPTION_FAILED: "Cannot decrypt message";
+        readonly INVALID_SIGNATURE: "Invalid signature";
+        readonly NETWORK_ERROR: "Network connection error";
+        readonly RELAY_ERROR: "Internal relay server error";
+        readonly MESSAGE_QUEUE_FULL: "Too many queued messages (>100)";
+        readonly RATE_LIMIT_EXCEEDED: "Rate limit exceeded";
+        readonly ORIGIN_MISMATCH: "Origin verification failed";
+        readonly REQUEST_PENDING: "Another signing request is already pending";
+        readonly REQUEST_NOT_FOUND: "Request ID not found or already processed";
+        readonly REQUEST_EXPIRED: "Request expired before completion";
+        readonly REQUEST_INVALID: "Request data is invalid or malformed";
+        readonly REQUEST_TIMEOUT: "Request timed out waiting for wallet response";
+        readonly SIGNING_FAILED: "Cryptographic signing operation failed";
+        readonly SIGNING_REJECTED: "User rejected the signing request";
+        readonly TRANSACTION_INVALID: "Transaction parameters validation failed";
+        readonly CHAIN_MISMATCH: "Requested chain ID does not match wallet chain";
+    };
+    readonly QR_CONFIG: {
+        readonly size: 256;
+        readonly margin: 4;
+        readonly errorCorrectionLevel: "M";
+        readonly type: "image/png";
+    };
+    readonly DEEP_LINK_CONFIG: {
+        readonly scheme: "bananalink";
+        readonly host: "connect";
+        readonly universal: "https://bananalink.app";
+    };
+    readonly NETWORK_CONFIG: {
+        readonly SUPPORTED_CHAINS: readonly [1, 5, 137, 80001, 42161, 421613, 10, 420];
+        readonly DEFAULT_CHAIN_ID: 1;
+        readonly CHAIN_NAMES: {
+            readonly 1: "Ethereum Mainnet";
+            readonly 5: "Goerli Testnet";
+            readonly 137: "Polygon Mainnet";
+            readonly 80001: "Polygon Mumbai";
+            readonly 42161: "Arbitrum One";
+            readonly 421613: "Arbitrum Goerli";
+            readonly 10: "Optimism";
+            readonly 420: "Optimism Goerli";
+        };
+    };
+    readonly DEV_CONFIG: {
+        readonly logLevel: "debug";
+        readonly enableMocks: false;
+        readonly skipValidation: false;
+        readonly allowLocalhost: true;
+    };
+};
+
+declare function compressPublicKey(publicKey: string): string;
+declare function decompressPublicKey(compressedKey: string): string;
+
+declare function encodeUrlParameter(value: string): string;
+declare function buildQueryString(params: Record<string, string | undefined>): string;
+declare function encodeCompactConnectionString(payload: QRPayload): string;
+declare function encodeConnectionString(payload: QRPayload): string;
+declare function encodeUniversalLink(payload: QRPayload, options?: {
+    baseUrl?: string;
+    fallbackUrl?: string;
+}): string;
+
+declare function decodeUrlParameter(value: string): string;
+declare function parseQueryString(query: string): Record<string, string>;
+declare function decodeConnectionString(connectionString: string): QRPayload;
+declare function isValidConnectionString(connectionString: string): boolean;
+
+declare function generateSessionId(): string;
+declare function isValidProtocolVersion(version: string): boolean;
+declare function isValidSessionId(sessionId: string): boolean;
+
+declare const VERSION: string;
+declare const PACKAGE_NAME = "@bananalink-sdk/protocol";
+
+export { type AblyConfig, BANANALINK_CONSTANTS, type BananaLinkErrorCode, CRYPTO_CONSTANTS, DAppMetadata, DEEPLINK_SCHEME, DEEP_LINK_CONFIG, DEFAULT_RELAY_URL, DEFAULT_TIMEOUTS, DEV_CONFIG, ERROR_MESSAGES, FRUITS, HTTP_ENDPOINTS, MESSAGE_FORMAT, MESSAGE_QUEUE_CONFIG, NETWORK_CONFIG, type OriginProof, PACKAGE_NAME, PROTOCOL_V2_TIMEOUTS, PROTOCOL_VERSION, type ProtocolErrorResponse, type ProviderConfig, type ProviderConfigResponse, type ProviderType, type PusherConfig, QRPayload, QR_CONFIG, type ReconnectedMessage, type RejectionReason, type RelayNotificationMessage, type RelayRejectionReason, SECURITY_LIMITS, type SessionClosedAck, type SessionClosedNotification, SessionConfig, type SessionInfo, type SessionSecurity, type SessionState, type UWebSocketConfig, VERSION, WS_MESSAGE_TYPES, type WalletRejectionReason, buildQueryString, compressPublicKey, decodeConnectionString, decodeUrlParameter, decompressPublicKey, encodeCompactConnectionString, encodeConnectionString, encodeUniversalLink, encodeUrlParameter, generateSessionId, isReconnectedMessage, isSessionClosedAck, isSessionClosedNotification, isValidConnectionString, isValidProtocolVersion, isValidSessionId, parseQueryString };