shogun-relay-sdk 1.1.3 → 1.1.5

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { DealsModule } from './modules/deals';
 import { RegistryModule } from './modules/registry';
 import { UploadsModule } from './modules/uploads';
 import { BridgeModule } from './modules/bridge';
+export * from './types';
 export declare class ShogunRelaySDK {
     private client;
     system: SystemModule;

package/dist/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShogunRelaySDK = void 0;
 const client_1 = require("./client");
@@ -10,6 +24,8 @@ const deals_1 = require("./modules/deals");
 const registry_1 = require("./modules/registry");
 const uploads_1 = require("./modules/uploads");
 const bridge_1 = require("./modules/bridge");
+// Export types
+__exportStar(require("./types"), exports);
 class ShogunRelaySDK {
     constructor(config) {
         this.client = new client_1.ApiClient(config);

package/dist/modules/bridge.d.ts

@@ -214,4 +214,56 @@ export declare class BridgeModule {
         message: string;
         error?: string;
     }>;
+    /**
+     * Get all transactions (deposits, withdrawals, transfers) for a user
+     * Returns a unified list of all transaction types sorted by timestamp
+     * @param userAddress User's Ethereum address
+     * @returns Transaction history
+     */
+    getTransactions(userAddress: string): Promise<{
+        success: boolean;
+        user: string;
+        transactions: Array<{
+            type: 'deposit' | 'withdrawal' | 'transfer';
+            txHash: string;
+            from?: string;
+            to?: string;
+            amount: string;
+            amountEth: string;
+            timestamp: number;
+            blockNumber?: number;
+            nonce?: string;
+            batchId?: string;
+            status: 'pending' | 'completed' | 'batched';
+        }>;
+        count: number;
+        summary: {
+            deposits: number;
+            withdrawals: number;
+            transfers: number;
+        };
+    }>;
+    /**
+     * Get detailed information about a specific transaction by hash
+     * Searches across deposits, withdrawals, and transfers
+     * @param txHash Transaction hash
+     * @returns Transaction details
+     */
+    getTransaction(txHash: string): Promise<{
+        success: boolean;
+        transaction?: {
+            type: 'deposit' | 'withdrawal' | 'transfer';
+            txHash: string;
+            from?: string;
+            to?: string;
+            amount: string;
+            amountEth: string;
+            timestamp: number;
+            blockNumber?: number;
+            nonce?: string;
+            status: 'pending' | 'completed' | 'batched';
+        };
+        source?: 'deposit' | 'withdrawal' | 'transfer';
+        error?: string;
+    }>;
 }

package/dist/modules/bridge.js

@@ -106,5 +106,23 @@ class BridgeModule {
     async reconcileBalance(userAddress) {
         return this.client.post('/api/v1/bridge/reconcile-balance', { user: userAddress });
     }
+    /**
+     * Get all transactions (deposits, withdrawals, transfers) for a user
+     * Returns a unified list of all transaction types sorted by timestamp
+     * @param userAddress User's Ethereum address
+     * @returns Transaction history
+     */
+    async getTransactions(userAddress) {
+        return this.client.get(`/api/v1/bridge/transactions/${userAddress}`);
+    }
+    /**
+     * Get detailed information about a specific transaction by hash
+     * Searches across deposits, withdrawals, and transfers
+     * @param txHash Transaction hash
+     * @returns Transaction details
+     */
+    async getTransaction(txHash) {
+        return this.client.get(`/api/v1/bridge/transaction/${txHash}`);
+    }
 }
 exports.BridgeModule = BridgeModule;

package/dist/modules/network.d.ts

@@ -1,15 +1,16 @@
 import { ApiClient } from '../client';
+import { ReputationResponse, ReputationLeaderboardResponse, BestRelaysResponse, NetworkStatsResponse, RelayInfoResponse, RelaysListResponse } from '../types';
 export declare class NetworkModule {
     private client;
     constructor(client: ApiClient);
-    getRelays(timeout?: number, maxAge?: number): Promise<any>;
-    getRelay(host: string): Promise<any>;
-    getStats(): Promise<any>;
+    getRelays(timeout?: number, maxAge?: number): Promise<RelaysListResponse>;
+    getRelay(host: string): Promise<RelayInfoResponse>;
+    getStats(): Promise<NetworkStatsResponse>;
     getProof(cid: string, challenge?: string): Promise<any>;
     verifyProof(proof: any): Promise<any>;
-    getReputation(host: string): Promise<any>;
-    getReputationLeaderboard(minScore?: number, limit?: number): Promise<any>;
-    getBestRelays(count?: number, minScore?: number, excludeHost?: string): Promise<any>;
+    getReputation(host: string): Promise<ReputationResponse>;
+    getReputationLeaderboard(minScore?: number, limit?: number): Promise<ReputationLeaderboardResponse>;
+    getBestRelays(count?: number, minScore?: number, excludeHost?: string): Promise<BestRelaysResponse>;
     getOnChainRelays(chainId?: number): Promise<any>;
     getOnChainRelay(address: string, chainId?: number): Promise<any>;
     getOnChainParams(chainId?: number): Promise<any>;

package/dist/types.d.ts

@@ -0,0 +1,243 @@
+/**
+ * Type definitions for Shogun Relay SDK
+ */
+/**
+ * Reputation Score Breakdown
+ */
+export interface ReputationScoreBreakdown {
+    uptime: number;
+    proofSuccess: number;
+    responseTime: number;
+    pinFulfillment: number;
+    longevity: number;
+    resourceEfficiency?: number;
+    storageCapacity?: number;
+    dataQuality?: number;
+    reliability?: number;
+    dealPerformance?: number;
+    networkHealth?: number;
+}
+/**
+ * Reputation Weights
+ */
+export interface ReputationWeights {
+    uptime: number;
+    proofSuccess: number;
+    responseTime: number;
+    pinFulfillment: number;
+    longevity: number;
+}
+/**
+ * Calculated Reputation Score
+ */
+export interface ReputationScore {
+    total: number;
+    tier: 'excellent' | 'good' | 'average' | 'poor' | 'unreliable';
+    breakdown: ReputationScoreBreakdown;
+    weights: ReputationWeights;
+    hasEnoughData: boolean;
+}
+/**
+ * Reputation Metrics
+ */
+export interface ReputationMetrics {
+    host?: string;
+    firstSeenTimestamp?: number;
+    lastSeenTimestamp?: number;
+    dataPoints?: number;
+    proofsTotal?: number;
+    proofsSuccessful?: number;
+    proofsFailed?: number;
+    avgResponseTimeMs?: number;
+    responseTimeSamples?: number;
+    pinRequestsReceived?: number;
+    pinRequestsFulfilled?: number;
+    expectedPulses?: number;
+    receivedPulses?: number;
+    uptimePercent?: number;
+    bridgeBatchSubmissionsTotal?: number;
+    bridgeBatchSubmissionsSuccessful?: number;
+    bridgeBatchSubmissionsFailed?: number;
+    bridgeProofsTotal?: number;
+    bridgeProofsSuccessful?: number;
+    bridgeProofsFailed?: number;
+    bridgeAvgProofResponseTimeMs?: number;
+    bridgeProofResponseTimeSamples?: number;
+    avgConnections?: number;
+    maxConnections?: number;
+    avgMemoryUsageMB?: number;
+    maxMemoryUsageMB?: number;
+    storageCapacityMB?: number;
+    storageUsedMB?: number;
+    storageUtilizationPercent?: number;
+    ipfsRepoSizeMB?: number;
+    ipfsPinsCount?: number;
+    avgLatencyMs?: number;
+    latencySamples?: number;
+    throughputMBps?: number;
+    errorRate?: number;
+    meanTimeBetweenFailures?: number;
+    meanTimeToRecovery?: number;
+    downtimeEvents?: number;
+    totalDowntimeMs?: number;
+    dataIntegrityChecks?: number;
+    dataIntegrityFailures?: number;
+    dataFreshnessMs?: number;
+    peerConnections?: number;
+    networkReachability?: number;
+    dealsTotal?: number;
+    dealsActive?: number;
+    dealsCompleted?: number;
+    dealsFailed?: number;
+    dealFulfillmentRate?: number;
+    subscriptionsTotal?: number;
+    subscriptionsActive?: number;
+    subscriptionRetentionRate?: number;
+    apiRequestsTotal?: number;
+    apiRequestsSuccessful?: number;
+    apiRequestsFailed?: number;
+    apiUptimePercent?: number;
+    securityIncidents?: number;
+    lastSecurityIncident?: number;
+    score?: number;
+    tier?: string;
+    lastScoreUpdate?: number;
+    proofSuccessRate?: number;
+}
+/**
+ * Leaderboard Entry with calculated score
+ */
+export interface ReputationLeaderboardEntry extends ReputationMetrics {
+    calculatedScore: ReputationScore;
+}
+/**
+ * Reputation API Response
+ */
+export interface ReputationResponse {
+    success: boolean;
+    host?: string;
+    reputation?: ReputationLeaderboardEntry;
+    error?: string;
+}
+/**
+ * Reputation Leaderboard Response
+ */
+export interface ReputationLeaderboardResponse {
+    success: boolean;
+    count: number;
+    leaderboard: ReputationLeaderboardEntry[];
+    filters?: {
+        minScore?: number;
+        tier?: string;
+        limit?: number;
+    };
+    error?: string;
+}
+/**
+ * Best Relays Response
+ */
+export interface BestRelaysResponse {
+    success: boolean;
+    count: number;
+    relays: Array<{
+        host: string;
+        score: number;
+        tier: string;
+        uptime: number;
+        lastSeen: number;
+    }>;
+    error?: string;
+}
+/**
+ * Network Stats Response
+ */
+export interface NetworkStatsResponse {
+    success: boolean;
+    stats: {
+        totalRelays: number;
+        activeRelays: number;
+        totalConnections: number;
+        totalStorageBytes: number;
+        totalStorageMB: number;
+        totalStorageGB: string;
+        totalPins: number;
+        totalActiveDeals: number;
+        totalActiveSubscriptions: number;
+        totalDealStorageMB: number;
+        totalSubscriptionStorageMB: number;
+    };
+    timestamp: number;
+    debug?: {
+        relaysFound: number;
+        relaysWithPulse: number;
+        sources: {
+            pulse: string;
+            deals: string;
+            subscriptions: string;
+            ipfsDirect: string;
+        };
+    };
+    error?: string;
+}
+/**
+ * Relay Info Response
+ */
+export interface RelayInfoResponse {
+    success: boolean;
+    host: string;
+    endpoint?: string;
+    lastSeen?: number;
+    uptime?: number;
+    connections?: {
+        active?: number;
+        total?: number;
+    };
+    memory?: {
+        heapUsed?: number;
+        heapTotal?: number;
+        rss?: number;
+    };
+    ipfs?: {
+        connected: boolean;
+        repoSize?: number;
+        repoSizeMB?: number;
+        numPins?: number;
+        numObjects?: number;
+    };
+    storage?: {
+        used?: number;
+        capacity?: number;
+    };
+    error?: string;
+}
+/**
+ * Relays List Response
+ */
+export interface RelaysListResponse {
+    success: boolean;
+    count: number;
+    relays: Array<{
+        host: string;
+        endpoint: string | null;
+        lastSeen: number;
+        uptime?: number;
+        connections?: {
+            active?: number;
+            total?: number;
+        };
+        memory?: {
+            heapUsed?: number;
+            heapTotal?: number;
+        };
+        ipfs?: {
+            connected: boolean;
+            repoSize?: number;
+            numPins?: number;
+        };
+        storage?: {
+            used?: number;
+            capacity?: number;
+        };
+    }>;
+    error?: string;
+}

package/dist/types.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Type definitions for Shogun Relay SDK
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shogun-relay-sdk",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "SDK for interacting with Shogun Relay API - HTTP client for IPFS, deals, registry, and network operations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",