@ottochain/sdk 0.2.0

package/dist/cjs/apps/oracles/types.js

@@ -0,0 +1,282 @@
+"use strict";
+/**
+ * Oracles Application Types
+ *
+ * Constants, types, and utilities for the Oracle system on OttoChain.
+ * Oracles provide truth resolution for markets and disputes.
+ *
+ * Core types (OracleState, Oracle, etc.) are exported from proto-generated
+ * types in index.ts.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isResolutionType = exports.isSlashingReason = exports.isOracleState = exports.calculateOracleReward = exports.calculateSelectionScore = exports.calculateStakeAfterSlash = exports.calculateSlashAmount = exports.SLASHING_CONDITIONS = exports.qualifiesForHighValue = exports.calculateWeightedReputation = exports.calculateReputation = exports.REPUTATION_DELTAS = exports.canAcceptAssignment = exports.isTerminalOracleState = exports.ORACLE_TRANSITIONS = exports.SLASHING_PERCENTAGES = exports.DEFAULT_ORACLE_CONFIG = exports.SlashingReason = exports.ResolutionType = void 0;
+const oracle_pb_js_1 = require("../../generated/ottochain/apps/oracles/v1/oracle_pb.js");
+/**
+ * Types of oracle resolutions
+ */
+var ResolutionType;
+(function (ResolutionType) {
+    ResolutionType[ResolutionType["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+    /** Binary yes/no outcome */
+    ResolutionType[ResolutionType["BINARY"] = 1] = "BINARY";
+    /** One of multiple predefined outcomes */
+    ResolutionType[ResolutionType["MULTI_CHOICE"] = 2] = "MULTI_CHOICE";
+    /** Numeric value (e.g., price) */
+    ResolutionType[ResolutionType["NUMERIC"] = 3] = "NUMERIC";
+    /** Free-form attestation */
+    ResolutionType[ResolutionType["ATTESTATION"] = 4] = "ATTESTATION";
+})(ResolutionType || (exports.ResolutionType = ResolutionType = {}));
+/**
+ * Reasons for slashing oracle stake
+ */
+var SlashingReason;
+(function (SlashingReason) {
+    SlashingReason[SlashingReason["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+    /** Failed to submit resolution in time */
+    SlashingReason[SlashingReason["TIMEOUT"] = 1] = "TIMEOUT";
+    /** Resolution overturned by dispute */
+    SlashingReason[SlashingReason["INCORRECT_RESOLUTION"] = 2] = "INCORRECT_RESOLUTION";
+    /** Evidence of collusion or manipulation */
+    SlashingReason[SlashingReason["COLLUSION"] = 3] = "COLLUSION";
+    /** Violation of oracle protocol */
+    SlashingReason[SlashingReason["PROTOCOL_VIOLATION"] = 4] = "PROTOCOL_VIOLATION";
+})(SlashingReason || (exports.SlashingReason = SlashingReason = {}));
+/**
+ * Default oracle configuration
+ */
+exports.DEFAULT_ORACLE_CONFIG = {
+    minStake: 10000n,
+    timeoutSlashPercent: 0.05,
+    incorrectSlashPercent: 0.25,
+    collusionSlashPercent: 1.0,
+    violationSlashPercent: 0.10,
+    cooldownEpochs: 48,
+    baseReputation: 50,
+    highValueThreshold: 100,
+    resolutionWindowEpochs: 12,
+    challengeWindowEpochs: 6,
+    oracleRewardPercent: 0.01,
+};
+/**
+ * Slashing percentages by reason
+ */
+exports.SLASHING_PERCENTAGES = {
+    [SlashingReason.UNSPECIFIED]: 0,
+    [SlashingReason.TIMEOUT]: exports.DEFAULT_ORACLE_CONFIG.timeoutSlashPercent,
+    [SlashingReason.INCORRECT_RESOLUTION]: exports.DEFAULT_ORACLE_CONFIG.incorrectSlashPercent,
+    [SlashingReason.COLLUSION]: exports.DEFAULT_ORACLE_CONFIG.collusionSlashPercent,
+    [SlashingReason.PROTOCOL_VIOLATION]: exports.DEFAULT_ORACLE_CONFIG.violationSlashPercent,
+};
+// ---------------------------------------------------------------------------
+// State Machine Transitions
+// ---------------------------------------------------------------------------
+/**
+ * Valid transitions for each oracle state (aligned with proto OracleState enum)
+ */
+exports.ORACLE_TRANSITIONS = {
+    [oracle_pb_js_1.OracleState.UNSPECIFIED]: [],
+    [oracle_pb_js_1.OracleState.UNREGISTERED]: ['register'],
+    [oracle_pb_js_1.OracleState.REGISTERED]: ['activate', 'withdraw'],
+    [oracle_pb_js_1.OracleState.ACTIVE]: ['add_stake', 'record_resolution', 'slash', 'withdraw'],
+    [oracle_pb_js_1.OracleState.SLASHED]: ['reactivate', 'withdraw'],
+    [oracle_pb_js_1.OracleState.WITHDRAWN]: [], // Terminal state
+};
+/**
+ * Check if an oracle state is terminal
+ */
+function isTerminalOracleState(state) {
+    return state === oracle_pb_js_1.OracleState.WITHDRAWN;
+}
+exports.isTerminalOracleState = isTerminalOracleState;
+/**
+ * Check if an oracle can accept new assignments
+ */
+function canAcceptAssignment(state) {
+    return state === oracle_pb_js_1.OracleState.ACTIVE;
+}
+exports.canAcceptAssignment = canAcceptAssignment;
+// ---------------------------------------------------------------------------
+// Reputation Calculations
+// ---------------------------------------------------------------------------
+/**
+ * Reputation update factors
+ */
+exports.REPUTATION_DELTAS = {
+    /** Successfully resolved market without challenge */
+    successfulResolution: 5,
+    /** Resolution upheld after challenge */
+    upheldChallenge: 10,
+    /** Resolution overturned (negative) */
+    overturnedResolution: -25,
+    /** Timeout on assigned market (negative) */
+    timeout: -15,
+    /** Collusion detected (negative) */
+    collusion: -100,
+    /** Protocol violation (negative) */
+    violation: -20,
+    /** Bonus for high-value market resolution */
+    highValueBonus: 3,
+};
+/**
+ * Calculate new reputation after an event
+ *
+ * @param currentReputation - Current reputation score
+ * @param delta - Reputation change (positive or negative)
+ * @param minReputation - Minimum reputation floor (default 0)
+ * @returns New reputation score
+ */
+function calculateReputation(currentReputation, delta, minReputation = 0) {
+    return Math.max(minReputation, currentReputation + delta);
+}
+exports.calculateReputation = calculateReputation;
+/**
+ * Calculate weighted reputation considering history
+ *
+ * @param baseReputation - Current base reputation
+ * @param successCount - Number of successful resolutions
+ * @param failureCount - Number of failed/overturned resolutions
+ * @returns Weighted reputation score
+ */
+function calculateWeightedReputation(baseReputation, successCount, failureCount) {
+    const totalAttempts = successCount + failureCount;
+    if (totalAttempts === 0)
+        return baseReputation;
+    const successRate = successCount / totalAttempts;
+    const experienceMultiplier = Math.min(1 + Math.log10(totalAttempts + 1) * 0.2, 1.5);
+    return Math.round(baseReputation * successRate * experienceMultiplier);
+}
+exports.calculateWeightedReputation = calculateWeightedReputation;
+/**
+ * Check if oracle qualifies for high-value markets
+ */
+function qualifiesForHighValue(reputation, stake, threshold = exports.DEFAULT_ORACLE_CONFIG.highValueThreshold, minStakeMultiplier = 5) {
+    return (reputation >= threshold &&
+        stake >= exports.DEFAULT_ORACLE_CONFIG.minStake * BigInt(minStakeMultiplier));
+}
+exports.qualifiesForHighValue = qualifiesForHighValue;
+/**
+ * Predefined slashing conditions
+ */
+exports.SLASHING_CONDITIONS = {
+    [SlashingReason.UNSPECIFIED]: {
+        reason: SlashingReason.UNSPECIFIED,
+        slashPercent: 0,
+        description: 'No slashing',
+        appealable: false,
+        suspensionEpochs: 0,
+    },
+    [SlashingReason.TIMEOUT]: {
+        reason: SlashingReason.TIMEOUT,
+        slashPercent: exports.DEFAULT_ORACLE_CONFIG.timeoutSlashPercent,
+        description: 'Failed to submit resolution within deadline',
+        appealable: true,
+        suspensionEpochs: 12,
+    },
+    [SlashingReason.INCORRECT_RESOLUTION]: {
+        reason: SlashingReason.INCORRECT_RESOLUTION,
+        slashPercent: exports.DEFAULT_ORACLE_CONFIG.incorrectSlashPercent,
+        description: 'Resolution overturned by dispute process',
+        appealable: true,
+        suspensionEpochs: 48,
+    },
+    [SlashingReason.COLLUSION]: {
+        reason: SlashingReason.COLLUSION,
+        slashPercent: exports.DEFAULT_ORACLE_CONFIG.collusionSlashPercent,
+        description: 'Evidence of collusion or market manipulation',
+        appealable: false,
+        suspensionEpochs: -1, // Permanent
+    },
+    [SlashingReason.PROTOCOL_VIOLATION]: {
+        reason: SlashingReason.PROTOCOL_VIOLATION,
+        slashPercent: exports.DEFAULT_ORACLE_CONFIG.violationSlashPercent,
+        description: 'Violation of oracle operating protocol',
+        appealable: true,
+        suspensionEpochs: 24,
+    },
+};
+/**
+ * Calculate slash amount for a given stake and reason
+ *
+ * @param stake - Oracle's current stake
+ * @param reason - Reason for slashing
+ * @returns Amount to be slashed
+ */
+function calculateSlashAmount(stake, reason) {
+    const condition = exports.SLASHING_CONDITIONS[reason];
+    return (stake * BigInt(Math.floor(condition.slashPercent * 10000))) / 10000n;
+}
+exports.calculateSlashAmount = calculateSlashAmount;
+/**
+ * Calculate remaining stake after slashing
+ */
+function calculateStakeAfterSlash(stake, reason) {
+    return stake - calculateSlashAmount(stake, reason);
+}
+exports.calculateStakeAfterSlash = calculateStakeAfterSlash;
+/**
+ * Calculate oracle selection score
+ * Higher score = more likely to be selected
+ *
+ * @param candidate - Oracle candidate details
+ * @param marketValue - Value of market to resolve (affects weight for high-value markets)
+ * @returns Selection score
+ */
+function calculateSelectionScore(candidate, marketValue = 0n) {
+    const reputationWeight = 0.4;
+    const stakeWeight = 0.3;
+    const successWeight = 0.2;
+    const loadWeight = 0.1;
+    // Normalize stake to 0-100 range (assuming 1M max)
+    const normalizedStake = Math.min(Number(candidate.stake / 10000n), 100);
+    // Load penalty (fewer active = better)
+    const loadScore = Math.max(0, 100 - candidate.activeAssignments * 20);
+    // High-value market bonus for qualified oracles
+    const highValueBonus = marketValue > 100000n &&
+        qualifiesForHighValue(candidate.reputation, candidate.stake) ? 10 : 0;
+    return (candidate.reputation * reputationWeight +
+        normalizedStake * stakeWeight +
+        candidate.successRate * 100 * successWeight +
+        loadScore * loadWeight +
+        highValueBonus);
+}
+exports.calculateSelectionScore = calculateSelectionScore;
+// ---------------------------------------------------------------------------
+// Reward Calculations
+// ---------------------------------------------------------------------------
+/**
+ * Calculate oracle reward for successful resolution
+ *
+ * @param marketFees - Total fees collected from market
+ * @param rewardPercent - Oracle's reward percentage (default from config)
+ * @returns Oracle reward amount
+ */
+function calculateOracleReward(marketFees, rewardPercent = exports.DEFAULT_ORACLE_CONFIG.oracleRewardPercent) {
+    return (marketFees * BigInt(Math.floor(rewardPercent * 10000))) / 10000n;
+}
+exports.calculateOracleReward = calculateOracleReward;
+// ---------------------------------------------------------------------------
+// Type Guards
+// ---------------------------------------------------------------------------
+/**
+ * Check if a value is a valid OracleState
+ */
+function isOracleState(value) {
+    return typeof value === 'number' && value in oracle_pb_js_1.OracleState;
+}
+exports.isOracleState = isOracleState;
+/**
+ * Check if a value is a valid SlashingReason
+ */
+function isSlashingReason(value) {
+    return typeof value === 'number' && value in SlashingReason;
+}
+exports.isSlashingReason = isSlashingReason;
+/**
+ * Check if a value is a valid ResolutionType
+ */
+function isResolutionType(value) {
+    return typeof value === 'number' && value in ResolutionType;
+}
+exports.isResolutionType = isResolutionType;

package/dist/cjs/errors.js

@@ -0,0 +1,293 @@
+"use strict";
+/**
+ * Custom Error Classes for OttoChain SDK
+ *
+ * Provides structured error handling with error codes and causes.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapError = exports.isErrorCode = exports.TransactionError = exports.SigningError = exports.ValidationError = exports.NetworkError = exports.OttoChainError = exports.ErrorCode = void 0;
+/**
+ * Error codes for OttoChain SDK errors
+ */
+var ErrorCode;
+(function (ErrorCode) {
+    /** Unknown or unclassified error */
+    ErrorCode["UNKNOWN"] = "UNKNOWN";
+    /** Network/HTTP connection failure */
+    ErrorCode["NETWORK_ERROR"] = "NETWORK_ERROR";
+    /** Request timeout */
+    ErrorCode["NETWORK_TIMEOUT"] = "NETWORK_TIMEOUT";
+    /** Input validation failed */
+    ErrorCode["VALIDATION_ERROR"] = "VALIDATION_ERROR";
+    /** Invalid private key format */
+    ErrorCode["INVALID_PRIVATE_KEY"] = "INVALID_PRIVATE_KEY";
+    /** Invalid public key format */
+    ErrorCode["INVALID_PUBLIC_KEY"] = "INVALID_PUBLIC_KEY";
+    /** Invalid DAG address format */
+    ErrorCode["INVALID_ADDRESS"] = "INVALID_ADDRESS";
+    /** Signature creation failed */
+    ErrorCode["SIGNING_ERROR"] = "SIGNING_ERROR";
+    /** Signature verification failed */
+    ErrorCode["VERIFICATION_ERROR"] = "VERIFICATION_ERROR";
+    /** Transaction rejected by network */
+    ErrorCode["TRANSACTION_REJECTED"] = "TRANSACTION_REJECTED";
+    /** Transaction not found */
+    ErrorCode["TRANSACTION_NOT_FOUND"] = "TRANSACTION_NOT_FOUND";
+    /** Invalid transaction format */
+    ErrorCode["INVALID_TRANSACTION"] = "INVALID_TRANSACTION";
+})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
+/**
+ * Base error class for all OttoChain SDK errors
+ *
+ * Provides consistent error structure with:
+ * - Error code for programmatic handling
+ * - Human-readable message
+ * - Optional cause for error chaining
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await signTransaction(data, invalidKey);
+ * } catch (error) {
+ *   if (error instanceof OttoChainError) {
+ *     console.log(error.code);    // 'INVALID_PRIVATE_KEY'
+ *     console.log(error.message); // 'Invalid private key format'
+ *   }
+ * }
+ * ```
+ */
+class OttoChainError extends Error {
+    constructor(code, message, cause) {
+        super(message);
+        this.name = 'OttoChainError';
+        this.code = code;
+        this.cause = cause;
+        // Maintains proper stack trace for where error was thrown (V8 engines)
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+    }
+    /**
+     * Create a string representation of the error
+     */
+    toString() {
+        let result = `${this.name} [${this.code}]: ${this.message}`;
+        if (this.cause) {
+            result += `\nCaused by: ${this.cause.message}`;
+        }
+        return result;
+    }
+    /**
+     * Convert error to a plain object for logging/serialization
+     */
+    toJSON() {
+        return {
+            name: this.name,
+            code: this.code,
+            message: this.message,
+            cause: this.cause?.message,
+            stack: this.stack,
+        };
+    }
+}
+exports.OttoChainError = OttoChainError;
+/**
+ * Error thrown when network operations fail
+ *
+ * Covers HTTP failures, connection errors, and timeouts.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.postTransaction(signed);
+ * } catch (error) {
+ *   if (error instanceof NetworkError) {
+ *     console.log(error.statusCode); // 503
+ *     console.log(error.responseBody); // '{"error": "Service unavailable"}'
+ *   }
+ * }
+ * ```
+ */
+class NetworkError extends OttoChainError {
+    constructor(message, statusCode, responseBody, cause) {
+        const code = statusCode === undefined ? ErrorCode.NETWORK_ERROR : ErrorCode.NETWORK_ERROR;
+        super(code, message, cause);
+        this.name = 'NetworkError';
+        this.statusCode = statusCode;
+        this.responseBody = responseBody;
+    }
+    /**
+     * Create a timeout error
+     */
+    static timeout(timeoutMs) {
+        const error = new NetworkError(`Request timed out after ${timeoutMs}ms`);
+        error.code = ErrorCode.NETWORK_TIMEOUT;
+        return error;
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            statusCode: this.statusCode,
+            responseBody: this.responseBody,
+        };
+    }
+}
+exports.NetworkError = NetworkError;
+/**
+ * Error thrown when input validation fails
+ *
+ * Used when function parameters don't meet expected format or constraints.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const keyPair = keyPairFromPrivateKey('invalid');
+ * } catch (error) {
+ *   if (error instanceof ValidationError) {
+ *     console.log(error.field); // 'privateKey'
+ *     console.log(error.value); // 'invalid'
+ *   }
+ * }
+ * ```
+ */
+class ValidationError extends OttoChainError {
+    constructor(message, options) {
+        super(ErrorCode.VALIDATION_ERROR, message, options?.cause);
+        this.name = 'ValidationError';
+        this.field = options?.field;
+        this.value = options?.value;
+        this.details = options?.details;
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            field: this.field,
+            value: this.value,
+            details: this.details,
+        };
+    }
+}
+exports.ValidationError = ValidationError;
+/**
+ * Error thrown when cryptographic signing operations fail
+ *
+ * Covers key derivation, signature creation, and related crypto operations.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const signature = await signHash(hash, privateKey);
+ * } catch (error) {
+ *   if (error instanceof SigningError) {
+ *     console.log(error.operation); // 'sign'
+ *   }
+ * }
+ * ```
+ */
+class SigningError extends OttoChainError {
+    constructor(message, options) {
+        super(ErrorCode.SIGNING_ERROR, message, options?.cause);
+        this.name = 'SigningError';
+        this.operation = options?.operation;
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            operation: this.operation,
+        };
+    }
+}
+exports.SigningError = SigningError;
+/**
+ * Error thrown when transaction operations fail
+ *
+ * Used when transactions are rejected, not found, or invalid.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.postTransaction(signed);
+ * } catch (error) {
+ *   if (error instanceof TransactionError) {
+ *     console.log(error.transactionHash); // 'abc123...'
+ *     console.log(error.rejectionReason); // 'Insufficient balance'
+ *   }
+ * }
+ * ```
+ */
+class TransactionError extends OttoChainError {
+    constructor(code, message, options) {
+        super(code, message, options?.cause);
+        this.name = 'TransactionError';
+        this.transactionHash = options?.transactionHash;
+        this.rejectionReason = options?.rejectionReason;
+    }
+    /**
+     * Create a transaction rejected error
+     */
+    static rejected(reason, transactionHash) {
+        return new TransactionError(ErrorCode.TRANSACTION_REJECTED, `Transaction rejected: ${reason}`, {
+            transactionHash,
+            rejectionReason: reason,
+        });
+    }
+    /**
+     * Create a transaction not found error
+     */
+    static notFound(transactionHash) {
+        return new TransactionError(ErrorCode.TRANSACTION_NOT_FOUND, `Transaction not found: ${transactionHash}`, {
+            transactionHash,
+        });
+    }
+    /**
+     * Create an invalid transaction error
+     */
+    static invalid(message, cause) {
+        return new TransactionError(ErrorCode.INVALID_TRANSACTION, message, { cause });
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            transactionHash: this.transactionHash,
+            rejectionReason: this.rejectionReason,
+        };
+    }
+}
+exports.TransactionError = TransactionError;
+/**
+ * Check if an error is an OttoChain error with a specific code
+ *
+ * @param error - Error to check
+ * @param code - Error code to match
+ * @returns True if error matches the code
+ *
+ * @example
+ * ```typescript
+ * if (isErrorCode(error, ErrorCode.NETWORK_TIMEOUT)) {
+ *   // Retry the request
+ * }
+ * ```
+ */
+function isErrorCode(error, code) {
+    return error instanceof OttoChainError && error.code === code;
+}
+exports.isErrorCode = isErrorCode;
+/**
+ * Wrap an unknown error in an OttoChainError
+ *
+ * @param error - Error to wrap
+ * @param defaultMessage - Default message if error has no message
+ * @returns OttoChainError wrapping the original error
+ */
+function wrapError(error, defaultMessage = 'An error occurred') {
+    if (error instanceof OttoChainError) {
+        return error;
+    }
+    if (error instanceof Error) {
+        return new OttoChainError(ErrorCode.UNKNOWN, error.message || defaultMessage, error);
+    }
+    return new OttoChainError(ErrorCode.UNKNOWN, String(error) || defaultMessage);
+}
+exports.wrapError = wrapError;