@highway1/core 0.1.48 → 0.1.51

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,5 +1,3 @@
1
- import { Libp2p } from 'libp2p';
2
- import { PrivateKey } from '@libp2p/interface';
3
1
  import { Level } from 'level';
4
2
 
5
3
  interface KeyPair {
@@ -61,32 +59,6 @@ declare function signMessage(payload: Uint8Array, privateKey: Uint8Array, public
61
59
  */
62
60
  declare function verifyMessage(signedMessage: SignedMessage, expectedPublicKey: Uint8Array): Promise<boolean>;
63
61
 
64
- interface TransportConfig {
65
- keyPair?: KeyPair;
66
- listenAddresses?: string[];
67
- bootstrapPeers?: string[];
68
- enableDHT?: boolean;
69
- /** Run as a relay server so NAT'd agents can receive messages through this node */
70
- enableRelay?: boolean;
71
- /** Reserve a relay slot on bootstrap nodes so others can reach us (only needed for hw1 join) */
72
- reserveRelaySlot?: boolean;
73
- /** Enable mDNS local peer discovery (default: false) */
74
- enableMDNS?: boolean;
75
- /** libp2p PrivateKey for persistent PeerID (from @libp2p/crypto) */
76
- privateKey?: PrivateKey;
77
- }
78
- interface ClawiverseNode {
79
- libp2p: Libp2p;
80
- start: () => Promise<void>;
81
- stop: () => Promise<void>;
82
- getMultiaddrs: () => string[];
83
- getPeerId: () => string;
84
- }
85
- /**
86
- * Create a Clawiverse transport node with libp2p
87
- */
88
- declare function createNode(config: TransportConfig): Promise<ClawiverseNode>;
89
-
90
62
  /**
91
63
  * Trust Score System
92
64
  *
@@ -224,6 +196,167 @@ declare function upgradeLegacyCard(legacy: LegacyAgentCard): AgentCard;
224
196
  */
225
197
  declare function downgradeToLegacyCard(card: AgentCard): LegacyAgentCard;
226
198
 
199
+ /**
200
+ * CVP-0011: Relay wire protocol types (shared between relay server and relay client)
201
+ */
202
+
203
+ declare const RELAY_PROTOCOL_VERSION = 1;
204
+ type RelayMessageType = 'HELLO' | 'WELCOME' | 'SEND' | 'DELIVER' | 'DISCOVER' | 'DISCOVERED' | 'PING' | 'PONG' | 'ACK' | 'DELIVERY_REPORT' | 'FETCH_CARD' | 'CARD' | 'GOODBYE' | 'INDEX_SYNC' | 'ROUTE' | 'SYNC_HELLO' | 'SYNC_REQUEST' | 'SYNC_RESPONSE' | 'SYNC_PUSH' | 'SYNC_RECONCILE';
205
+ interface HelloMessage {
206
+ type: 'HELLO';
207
+ protocolVersion: number;
208
+ did: string;
209
+ card: AgentCard;
210
+ timestamp: number;
211
+ signature: Uint8Array;
212
+ extensions?: string[];
213
+ }
214
+ interface WelcomeMessage {
215
+ type: 'WELCOME';
216
+ protocolVersion: number;
217
+ relayId: string;
218
+ peers: number;
219
+ federatedRelays: string[];
220
+ yourAddr: string;
221
+ }
222
+ interface SendMessage {
223
+ type: 'SEND';
224
+ to: string;
225
+ envelope: Uint8Array;
226
+ }
227
+ interface DeliverMessage {
228
+ type: 'DELIVER';
229
+ messageId: string;
230
+ from: string;
231
+ envelope: Uint8Array;
232
+ }
233
+ interface DiscoverMessage {
234
+ type: 'DISCOVER';
235
+ query: string;
236
+ minTrust?: number;
237
+ limit?: number;
238
+ }
239
+ interface DiscoveredAgent {
240
+ did: string;
241
+ card: AgentCard;
242
+ online: boolean;
243
+ homeRelay?: string;
244
+ }
245
+ interface DiscoveredMessage {
246
+ type: 'DISCOVERED';
247
+ agents: DiscoveredAgent[];
248
+ }
249
+ interface AckMessage {
250
+ type: 'ACK';
251
+ messageId: string;
252
+ }
253
+ interface DeliveryReportMessage {
254
+ type: 'DELIVERY_REPORT';
255
+ messageId: string;
256
+ status: 'delivered' | 'expired' | 'queue_full' | 'unknown_recipient';
257
+ timestamp: number;
258
+ }
259
+ interface PingMessage {
260
+ type: 'PING';
261
+ }
262
+ interface PongMessage {
263
+ type: 'PONG';
264
+ peers: number;
265
+ }
266
+ interface FetchCardMessage {
267
+ type: 'FETCH_CARD';
268
+ did: string;
269
+ }
270
+ interface CardMessage {
271
+ type: 'CARD';
272
+ did: string;
273
+ card: AgentCard | null;
274
+ }
275
+ interface GoodbyeMessage {
276
+ type: 'GOODBYE';
277
+ }
278
+ interface PresenceProof {
279
+ did: string;
280
+ homeRelay: string;
281
+ expiry: number;
282
+ signature: Uint8Array;
283
+ }
284
+ interface SyncEvent {
285
+ seq: number;
286
+ type: 'JOIN' | 'LEAVE' | 'UPDATE';
287
+ did: string;
288
+ homeRelay: string;
289
+ cardHash?: string;
290
+ capabilityKeys?: string[];
291
+ online: boolean;
292
+ ts: number;
293
+ presenceProof?: PresenceProof;
294
+ }
295
+ interface IndexSyncMessage {
296
+ type: 'INDEX_SYNC';
297
+ events: SyncEvent[];
298
+ }
299
+ interface RouteMessage {
300
+ type: 'ROUTE';
301
+ to: string;
302
+ envelope: Uint8Array;
303
+ ttl: number;
304
+ }
305
+ interface SyncHelloMessage {
306
+ type: 'SYNC_HELLO';
307
+ relayId: string;
308
+ seq: number;
309
+ }
310
+ interface SyncRequestMessage {
311
+ type: 'SYNC_REQUEST';
312
+ fromSeq: number;
313
+ }
314
+ interface SyncResponseMessage {
315
+ type: 'SYNC_RESPONSE';
316
+ events: SyncEvent[];
317
+ }
318
+ interface SyncPushMessage {
319
+ type: 'SYNC_PUSH';
320
+ event: SyncEvent;
321
+ }
322
+ interface SyncReconcileMessage {
323
+ type: 'SYNC_RECONCILE';
324
+ dids: string[];
325
+ }
326
+ type RelayMessage = HelloMessage | WelcomeMessage | SendMessage | DeliverMessage | DiscoverMessage | DiscoveredMessage | AckMessage | DeliveryReportMessage | PingMessage | PongMessage | FetchCardMessage | CardMessage | GoodbyeMessage | IndexSyncMessage | RouteMessage | SyncHelloMessage | SyncRequestMessage | SyncResponseMessage | SyncPushMessage | SyncReconcileMessage;
327
+
328
+ /**
329
+ * CVP-0011: WebSocket relay client with reconnection logic
330
+ */
331
+
332
+ interface RelayClientConfig {
333
+ relayUrls: string[];
334
+ did: string;
335
+ keyPair: KeyPair;
336
+ card: AgentCard;
337
+ reconnect?: {
338
+ baseMs?: number;
339
+ jitterMs?: number;
340
+ maxDelayMs?: number;
341
+ stableAfterMs?: number;
342
+ };
343
+ }
344
+ type MessageDeliveryHandler = (msg: DeliverMessage) => Promise<void>;
345
+ type DeliveryReportHandler = (msg: DeliveryReportMessage) => void;
346
+ interface RelayClient {
347
+ start(): Promise<void>;
348
+ stop(): Promise<void>;
349
+ sendEnvelope(toDid: string, envelopeBytes: Uint8Array): Promise<void>;
350
+ discover(query: string, minTrust?: number, limit?: number): Promise<DiscoveredAgent[]>;
351
+ fetchCard(did: string): Promise<AgentCard | null>;
352
+ onDeliver(handler: MessageDeliveryHandler): void;
353
+ onDeliveryReport(handler: DeliveryReportHandler): void;
354
+ isConnected(): boolean;
355
+ getConnectedRelays(): string[];
356
+ getPeerCount(): number;
357
+ }
358
+ declare function createRelayClient(config: RelayClientConfig): RelayClient;
359
+
227
360
  /**
228
361
  * Create a new Agent Card (Phase 2 format with structured capabilities)
229
362
  */
@@ -441,22 +574,25 @@ declare class SearchIndex {
441
574
  private applyFilters;
442
575
  }
443
576
 
444
- interface ResolvedDID {
445
- peerId: string;
446
- multiaddrs: string[];
447
- }
448
- interface DHTOperations {
577
+ /**
578
+ * CVP-0011: Relay-backed discovery operations
579
+ * Implements the same DHTOperations interface shape but backed by relay queries
580
+ */
581
+
582
+ interface RelayIndexOperations {
449
583
  publishAgentCard: (card: AgentCard) => Promise<void>;
450
584
  queryAgentCard: (did: string) => Promise<AgentCard | null>;
451
585
  queryByCapability: (capability: string) => Promise<AgentCard[]>;
452
586
  searchSemantic: (query: SemanticQuery) => Promise<AgentCard[]>;
453
- resolveDID: (did: string) => Promise<ResolvedDID | null>;
587
+ resolveDID: (did: string) => Promise<{
588
+ relayUrl: string;
589
+ } | null>;
454
590
  queryRelayPeers: () => Promise<string[]>;
455
591
  }
456
592
  /**
457
- * Create DHT operations for a libp2p node
593
+ * Create relay-backed discovery operations
458
594
  */
459
- declare function createDHTOperations(libp2p: Libp2p): DHTOperations;
595
+ declare function createRelayIndexOperations(client: RelayClient): RelayIndexOperations;
460
596
 
461
597
  /**
462
598
  * Capability Matcher
@@ -495,6 +631,19 @@ declare class CapabilityMatcher {
495
631
  private levenshteinDistance;
496
632
  }
497
633
 
634
+ interface ResolvedDID {
635
+ peerId: string;
636
+ multiaddrs: string[];
637
+ }
638
+ interface DHTOperations {
639
+ publishAgentCard: (card: AgentCard) => Promise<void>;
640
+ queryAgentCard: (did: string) => Promise<AgentCard | null>;
641
+ queryByCapability: (capability: string) => Promise<AgentCard[]>;
642
+ searchSemantic: (query: SemanticQuery) => Promise<AgentCard[]>;
643
+ resolveDID: (did: string) => Promise<ResolvedDID | null>;
644
+ queryRelayPeers: () => Promise<string[]>;
645
+ }
646
+
498
647
  /**
499
648
  * Semantic Search Engine
500
649
  *
@@ -603,24 +752,18 @@ declare function encodeMessageJSON(envelope: MessageEnvelope): string;
603
752
  declare function decodeMessageJSON(json: string): MessageEnvelope;
604
753
 
605
754
  type MessageHandler = (envelope: MessageEnvelope) => Promise<MessageEnvelope | void>;
606
- interface PeerHint {
607
- peerId: string;
608
- multiaddrs: string[];
609
- }
610
755
  interface MessageRouter {
611
756
  registerHandler: (protocol: string, handler: MessageHandler) => void;
612
757
  unregisterHandler: (protocol: string) => void;
613
758
  registerCatchAllHandler: (handler: MessageHandler) => void;
614
- sendMessage: (envelope: MessageEnvelope, peerHint?: PeerHint) => Promise<MessageEnvelope | void>;
759
+ sendMessage: (envelope: MessageEnvelope) => Promise<MessageEnvelope | void>;
615
760
  start: () => Promise<void>;
616
761
  stop: () => Promise<void>;
617
762
  }
618
763
  /**
619
- * Create a message router for a libp2p node.
620
- * When dht is provided, sendMessage can resolve DIDs to peer addresses via DHT lookup.
621
- * When relayPeers is provided, sendMessage will attempt relay fallback if direct dial fails.
764
+ * Create a message router using relay client (CVP-0011)
622
765
  */
623
- declare function createMessageRouter(libp2p: Libp2p, verifyFn: (signature: Uint8Array, data: Uint8Array) => Promise<boolean>, dht?: DHTOperations, relayPeers?: string[]): MessageRouter;
766
+ declare function createMessageRouter(relayClient: RelayClient, verifyFn: (signature: Uint8Array, data: Uint8Array) => Promise<boolean>): MessageRouter;
624
767
 
625
768
  /**
626
769
  * Message Queue Types
@@ -1229,4 +1372,4 @@ declare class MessagingError extends ClawiverseError {
1229
1372
  constructor(message: string, details?: unknown);
1230
1373
  }
1231
1374
 
1232
- export { type AgentCard, type AllowlistEntry, type BlocklistEntry, CLAWIVERSE_CONTEXT, type Capability, CapabilityMatcher, type CapabilityParameter, CapabilityTypes, type Challenge, type ChallengeSolution, ClawiverseError, type ClawiverseNode, DEFAULT_RATE_LIMIT_TIERS, type DHTOperations, type DefenseConfig, DefenseMiddleware, type DefenseResult, DiscoveryError, type Endorsement, EndorsementManager, IdentityError, type Interaction, InteractionHistory, type InteractionStats, type KeyPair, type LegacyAgentCard, LogLevel, Logger, type MessageCallback, type MessageDirection, type MessageEnvelope, type MessageFilter, type MessageHandler, type MessagePage, MessageQueue, type MessageQueueConfig, type MessageRouter, type MessageStatus, MessageStorage, MessagingError, type PaginationOptions, ParameterTypes, type PeerHint, type PeerTrustLevel, type QueueStats, type RateLimitResult, type RateLimitState, type RateLimitTiers, type ResolvedDID, SCHEMA_ORG_CONTEXT, SearchIndex, type SearchResult, type SeenEntry, type SemanticQuery, SemanticSearchEngine, type SignFunction, type SignedMessage, type StoredMessage, type SubscriptionFilter, SybilDefense, TokenBucket, type TokenBucketConfig, type TransportConfig, TransportError, TrustMetrics, type TrustScore, TrustSystem, type TrustSystemConfig, type VerifyFunction, clawiverseContext, createAgentCard, createDHTOperations, createDefaultTrustScore, createEnvelope, createLegacyAgentCard, createLogger, createMessageRouter, createNode, createSemanticSearch, createTrustSystem, decodeAgentCard, decodeFromCBOR, decodeFromJSON, decodeMessage, decodeMessageJSON, deriveDID, downgradeToLegacyCard, encodeForDHT, encodeForWeb, encodeMessage, encodeMessageJSON, exportKeyPair, extractPublicKey, generateKeyPair, getAgentCardContext, getEncodedSize, getTierConfig, importKeyPair, isLegacyCard, isValidContext, matchesCapability, sign, signAgentCard, signEnvelope, signMessage, upgradeLegacyCard, validateAgentCard, validateDID, validateEnvelope, verify, verifyAgentCard, verifyEnvelope, verifyMessage };
1375
+ export { type AckMessage, type AgentCard, type AllowlistEntry, type BlocklistEntry, CLAWIVERSE_CONTEXT, type Capability, CapabilityMatcher, type CapabilityParameter, CapabilityTypes, type CardMessage, type Challenge, type ChallengeSolution, ClawiverseError, DEFAULT_RATE_LIMIT_TIERS, type DefenseConfig, DefenseMiddleware, type DefenseResult, type DeliverMessage, type DeliveryReportHandler, type DeliveryReportMessage, type DiscoverMessage, type DiscoveredAgent, type DiscoveredMessage, DiscoveryError, type Endorsement, EndorsementManager, type FetchCardMessage, type GoodbyeMessage, type HelloMessage, IdentityError, type IndexSyncMessage, type Interaction, InteractionHistory, type InteractionStats, type KeyPair, type LegacyAgentCard, LogLevel, Logger, type MessageCallback, type MessageDeliveryHandler, type MessageDirection, type MessageEnvelope, type MessageFilter, type MessageHandler, type MessagePage, MessageQueue, type MessageQueueConfig, type MessageRouter, type MessageStatus, MessageStorage, MessagingError, type PaginationOptions, ParameterTypes, type PeerTrustLevel, type PingMessage, type PongMessage, type PresenceProof, type QueueStats, RELAY_PROTOCOL_VERSION, type RateLimitResult, type RateLimitState, type RateLimitTiers, type RelayClient, type RelayClientConfig, type RelayIndexOperations, type RelayMessage, type RelayMessageType, type RouteMessage, SCHEMA_ORG_CONTEXT, SearchIndex, type SearchResult, type SeenEntry, type SemanticQuery, SemanticSearchEngine, type SendMessage, type SignFunction, type SignedMessage, type StoredMessage, type SubscriptionFilter, SybilDefense, type SyncEvent, type SyncHelloMessage, type SyncPushMessage, type SyncReconcileMessage, type SyncRequestMessage, type SyncResponseMessage, TokenBucket, type TokenBucketConfig, TransportError, TrustMetrics, type TrustScore, TrustSystem, type TrustSystemConfig, type VerifyFunction, type WelcomeMessage, clawiverseContext, createAgentCard, createDefaultTrustScore, createEnvelope, createLegacyAgentCard, createLogger, createMessageRouter, createRelayClient, createRelayIndexOperations, createSemanticSearch, createTrustSystem, decodeAgentCard, decodeFromCBOR, decodeFromJSON, decodeMessage, decodeMessageJSON, deriveDID, downgradeToLegacyCard, encodeForDHT, encodeForWeb, encodeMessage, encodeMessageJSON, exportKeyPair, extractPublicKey, generateKeyPair, getAgentCardContext, getEncodedSize, getTierConfig, importKeyPair, isLegacyCard, isValidContext, matchesCapability, sign, signAgentCard, signEnvelope, signMessage, upgradeLegacyCard, validateAgentCard, validateDID, validateEnvelope, verify, verifyAgentCard, verifyEnvelope, verifyMessage };