@net-protocol/score 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,188 @@
+import { S as ScoreClientOptions, G as GetUpvotesOptions, a as GetUpvotesForItemsOptions, b as GetStrategyKeyScoresOptions, c as GetAppKeyScoresOptions, D as DecodedStrategyMetadata, P as PoolKey } from './scoreKeyUtils-DIjbizO-.mjs';
+export { n as DecodedUpvoteBlob, F as FeedMessage, m as PoolStrategyMetadata, l as PureAlphaMetadata, k as ScoreItem, p as UseTokenUpvotesOptions, o as UseUpvotesBatchOptions, U as UseUpvotesOptions, h as extractTokenAddressFromScoreKey, e as getFeedContentKey, f as getScoreKey, d as getStorageScoreKey, j as getStorageUpvoteContext, g as getTokenScoreKey, i as isTokenScoreKey } from './scoreKeyUtils-DIjbizO-.mjs';
+import { Address, Abi } from 'viem';
+
+/**
+ * ScoreClient - Client for interacting with Net protocol scoring/upvote system
+ *
+ * **Pattern for client methods:**
+ * - Client methods never require `chainId` in their parameters
+ * - All methods use `this.client` internally (created during construction)
+ * - This ensures consistency: the client's chain is the single source of truth
+ */
+declare class ScoreClient {
+    private client;
+    private scoreAddress;
+    private upvoteAppAddress;
+    constructor(params: ScoreClientOptions);
+    /**
+     * Get upvote counts for score keys via UpvoteApp.getUpvotesWithLegacy.
+     * Returns an array of counts, one per score key.
+     */
+    getUpvotesWithLegacy({ scoreKeys, strategies, }: GetUpvotesOptions): Promise<number[]>;
+    /**
+     * Get upvote counts for ScoreItem array.
+     * Converts items to score keys, then calls getUpvotesWithLegacy.
+     */
+    getUpvotesForItems({ items, strategies, }: GetUpvotesForItemsOptions): Promise<number[]>;
+    /**
+     * Read scores for keys from a specific strategy on the Score contract.
+     * Uses the batch getAppStrategyKeyScores function for efficiency.
+     */
+    getStrategyKeyScores({ strategy, scoreKeys, }: GetStrategyKeyScoresOptions): Promise<number[]>;
+    /**
+     * Read scores for keys from a specific app on the Score contract.
+     * Uses the batch getAppKeyScores function for efficiency.
+     */
+    getAppKeyScores({ app, scoreKeys, }: GetAppKeyScoresOptions): Promise<number[]>;
+}
+
+/**
+ * Convert token address to bytes32 upvote key.
+ */
+declare const encodeUpvoteKey: (tokenAddress: string) => `0x${string}`;
+/**
+ * Convert token address to upvote key string format.
+ * Strips leading zeros to match Solidity's Strings.toHexString(uint256(scoreKey)).
+ */
+declare function tokenAddressToUpvoteKeyString(tokenAddress: string): string;
+/**
+ * Check if a topic string represents a strategy message.
+ */
+declare function isStrategyMessage(topic: string): boolean;
+/**
+ * Check if a topic string represents a user upvote message.
+ */
+declare function isUserUpvoteMessage(topic: string): boolean;
+/**
+ * Extracts strategy address from topic string.
+ * Handles both new format and legacy format.
+ */
+declare function extractStrategyAddress(topic: string): string;
+declare function isPureAlphaStrategy(strategyAddress: string): boolean;
+declare function isUniv234PoolsStrategy(strategyAddress: string): boolean;
+declare function isDynamicSplitStrategy(strategyAddress: string): boolean;
+/**
+ * Decode strategy-specific metadata from ABI-encoded bytes.
+ */
+declare const decodeStrategyMetadata: (metadata: `0x${string}`, strategyAddress: string) => DecodedStrategyMetadata;
+/**
+ * Decode the full Score storage blob.
+ */
+declare const decodeUpvoteStorageBlob: (value: `0x${string}`) => {
+    scoreKey: `0x${string}`;
+    scoreDelta: number;
+    originalSender: Address;
+    appAddress: Address;
+    strategyAddress: Address;
+    timestamp: number;
+    scoreStoredContext: `0x${string}`;
+    scoreUnstoredContext: `0x${string}`;
+    decodedMetadata: DecodedStrategyMetadata;
+} | null;
+/**
+ * Select the appropriate strategy based on pool key validity.
+ * Returns PURE_ALPHA if no valid pool key; DYNAMIC_SPLIT otherwise.
+ */
+declare const selectStrategy: (poolKey?: PoolKey | null) => Address;
+/**
+ * Decode an upvote message from Net protocol into a consistent format.
+ * Handles both legacy and strategy message formats.
+ */
+declare function decodeUpvoteMessage(msg: {
+    topic: string;
+    data: `0x${string}`;
+    text: string;
+}): {
+    scoreDelta: number;
+    tokenWethPrice: number;
+    wethUsdcPrice: number;
+    alphaWethPrice: number;
+    userTokenBalance: number;
+    tokenAddress: string;
+    messageType: "legacy";
+    appAddress?: undefined;
+    strategyAddress?: undefined;
+    userAddress?: undefined;
+} | {
+    appAddress: string;
+    messageType: "app-first";
+    scoreDelta?: undefined;
+    tokenWethPrice?: undefined;
+    wethUsdcPrice?: undefined;
+    alphaWethPrice?: undefined;
+    userTokenBalance?: undefined;
+    tokenAddress?: undefined;
+    strategyAddress?: undefined;
+    userAddress?: undefined;
+} | {
+    appAddress: string;
+    strategyAddress: string;
+    messageType: "app-strategy-first";
+    scoreDelta?: undefined;
+    tokenWethPrice?: undefined;
+    wethUsdcPrice?: undefined;
+    alphaWethPrice?: undefined;
+    userTokenBalance?: undefined;
+    tokenAddress?: undefined;
+    userAddress?: undefined;
+} | {
+    appAddress: string;
+    userAddress: string;
+    tokenAddress: string;
+    messageType: "app-user-first";
+    scoreDelta?: undefined;
+    tokenWethPrice?: undefined;
+    wethUsdcPrice?: undefined;
+    alphaWethPrice?: undefined;
+    userTokenBalance?: undefined;
+    strategyAddress?: undefined;
+} | {
+    appAddress: string;
+    strategyAddress: string;
+    userAddress: string;
+    tokenAddress: string;
+    messageType: "app-strategy-user-first";
+    scoreDelta?: undefined;
+    tokenWethPrice?: undefined;
+    wethUsdcPrice?: undefined;
+    alphaWethPrice?: undefined;
+    userTokenBalance?: undefined;
+} | null;
+
+/**
+ * Encode a PoolKey struct to bytes for scoreStoredContext.
+ * Returns "0x" for invalid or missing pool keys.
+ */
+declare const encodePoolKey: (poolKey?: PoolKey | null) => `0x${string}`;
+
+declare const SCORE_CONTRACT: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const UPVOTE_APP: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const UPVOTE_STORAGE_APP: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const PURE_ALPHA_STRATEGY: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const UNIV234_POOLS_STRATEGY: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const DYNAMIC_SPLIT_STRATEGY: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const ALL_STRATEGY_ADDRESSES: Address[];
+declare const LEGACY_UPVOTE_V1_ADDRESS: Address;
+declare const LEGACY_UPVOTE_V2_ADDRESS: Address;
+declare const SUPPORTED_SCORE_CHAINS: readonly [8453];
+
+export { ALL_STRATEGY_ADDRESSES, DYNAMIC_SPLIT_STRATEGY, DecodedStrategyMetadata, GetAppKeyScoresOptions, GetStrategyKeyScoresOptions, GetUpvotesForItemsOptions, GetUpvotesOptions, LEGACY_UPVOTE_V1_ADDRESS, LEGACY_UPVOTE_V2_ADDRESS, PURE_ALPHA_STRATEGY, PoolKey, SCORE_CONTRACT, SUPPORTED_SCORE_CHAINS, ScoreClient, ScoreClientOptions, UNIV234_POOLS_STRATEGY, UPVOTE_APP, UPVOTE_STORAGE_APP, decodeStrategyMetadata, decodeUpvoteMessage, decodeUpvoteStorageBlob, encodePoolKey, encodeUpvoteKey, extractStrategyAddress, isDynamicSplitStrategy, isPureAlphaStrategy, isStrategyMessage, isUniv234PoolsStrategy, isUserUpvoteMessage, selectStrategy, tokenAddressToUpvoteKeyString };

package/dist/index.d.ts

@@ -0,0 +1,188 @@
+import { S as ScoreClientOptions, G as GetUpvotesOptions, a as GetUpvotesForItemsOptions, b as GetStrategyKeyScoresOptions, c as GetAppKeyScoresOptions, D as DecodedStrategyMetadata, P as PoolKey } from './scoreKeyUtils-DIjbizO-.js';
+export { n as DecodedUpvoteBlob, F as FeedMessage, m as PoolStrategyMetadata, l as PureAlphaMetadata, k as ScoreItem, p as UseTokenUpvotesOptions, o as UseUpvotesBatchOptions, U as UseUpvotesOptions, h as extractTokenAddressFromScoreKey, e as getFeedContentKey, f as getScoreKey, d as getStorageScoreKey, j as getStorageUpvoteContext, g as getTokenScoreKey, i as isTokenScoreKey } from './scoreKeyUtils-DIjbizO-.js';
+import { Address, Abi } from 'viem';
+
+/**
+ * ScoreClient - Client for interacting with Net protocol scoring/upvote system
+ *
+ * **Pattern for client methods:**
+ * - Client methods never require `chainId` in their parameters
+ * - All methods use `this.client` internally (created during construction)
+ * - This ensures consistency: the client's chain is the single source of truth
+ */
+declare class ScoreClient {
+    private client;
+    private scoreAddress;
+    private upvoteAppAddress;
+    constructor(params: ScoreClientOptions);
+    /**
+     * Get upvote counts for score keys via UpvoteApp.getUpvotesWithLegacy.
+     * Returns an array of counts, one per score key.
+     */
+    getUpvotesWithLegacy({ scoreKeys, strategies, }: GetUpvotesOptions): Promise<number[]>;
+    /**
+     * Get upvote counts for ScoreItem array.
+     * Converts items to score keys, then calls getUpvotesWithLegacy.
+     */
+    getUpvotesForItems({ items, strategies, }: GetUpvotesForItemsOptions): Promise<number[]>;
+    /**
+     * Read scores for keys from a specific strategy on the Score contract.
+     * Uses the batch getAppStrategyKeyScores function for efficiency.
+     */
+    getStrategyKeyScores({ strategy, scoreKeys, }: GetStrategyKeyScoresOptions): Promise<number[]>;
+    /**
+     * Read scores for keys from a specific app on the Score contract.
+     * Uses the batch getAppKeyScores function for efficiency.
+     */
+    getAppKeyScores({ app, scoreKeys, }: GetAppKeyScoresOptions): Promise<number[]>;
+}
+
+/**
+ * Convert token address to bytes32 upvote key.
+ */
+declare const encodeUpvoteKey: (tokenAddress: string) => `0x${string}`;
+/**
+ * Convert token address to upvote key string format.
+ * Strips leading zeros to match Solidity's Strings.toHexString(uint256(scoreKey)).
+ */
+declare function tokenAddressToUpvoteKeyString(tokenAddress: string): string;
+/**
+ * Check if a topic string represents a strategy message.
+ */
+declare function isStrategyMessage(topic: string): boolean;
+/**
+ * Check if a topic string represents a user upvote message.
+ */
+declare function isUserUpvoteMessage(topic: string): boolean;
+/**
+ * Extracts strategy address from topic string.
+ * Handles both new format and legacy format.
+ */
+declare function extractStrategyAddress(topic: string): string;
+declare function isPureAlphaStrategy(strategyAddress: string): boolean;
+declare function isUniv234PoolsStrategy(strategyAddress: string): boolean;
+declare function isDynamicSplitStrategy(strategyAddress: string): boolean;
+/**
+ * Decode strategy-specific metadata from ABI-encoded bytes.
+ */
+declare const decodeStrategyMetadata: (metadata: `0x${string}`, strategyAddress: string) => DecodedStrategyMetadata;
+/**
+ * Decode the full Score storage blob.
+ */
+declare const decodeUpvoteStorageBlob: (value: `0x${string}`) => {
+    scoreKey: `0x${string}`;
+    scoreDelta: number;
+    originalSender: Address;
+    appAddress: Address;
+    strategyAddress: Address;
+    timestamp: number;
+    scoreStoredContext: `0x${string}`;
+    scoreUnstoredContext: `0x${string}`;
+    decodedMetadata: DecodedStrategyMetadata;
+} | null;
+/**
+ * Select the appropriate strategy based on pool key validity.
+ * Returns PURE_ALPHA if no valid pool key; DYNAMIC_SPLIT otherwise.
+ */
+declare const selectStrategy: (poolKey?: PoolKey | null) => Address;
+/**
+ * Decode an upvote message from Net protocol into a consistent format.
+ * Handles both legacy and strategy message formats.
+ */
+declare function decodeUpvoteMessage(msg: {
+    topic: string;
+    data: `0x${string}`;
+    text: string;
+}): {
+    scoreDelta: number;
+    tokenWethPrice: number;
+    wethUsdcPrice: number;
+    alphaWethPrice: number;
+    userTokenBalance: number;
+    tokenAddress: string;
+    messageType: "legacy";
+    appAddress?: undefined;
+    strategyAddress?: undefined;
+    userAddress?: undefined;
+} | {
+    appAddress: string;
+    messageType: "app-first";
+    scoreDelta?: undefined;
+    tokenWethPrice?: undefined;
+    wethUsdcPrice?: undefined;
+    alphaWethPrice?: undefined;
+    userTokenBalance?: undefined;
+    tokenAddress?: undefined;
+    strategyAddress?: undefined;
+    userAddress?: undefined;
+} | {
+    appAddress: string;
+    strategyAddress: string;
+    messageType: "app-strategy-first";
+    scoreDelta?: undefined;
+    tokenWethPrice?: undefined;
+    wethUsdcPrice?: undefined;
+    alphaWethPrice?: undefined;
+    userTokenBalance?: undefined;
+    tokenAddress?: undefined;
+    userAddress?: undefined;
+} | {
+    appAddress: string;
+    userAddress: string;
+    tokenAddress: string;
+    messageType: "app-user-first";
+    scoreDelta?: undefined;
+    tokenWethPrice?: undefined;
+    wethUsdcPrice?: undefined;
+    alphaWethPrice?: undefined;
+    userTokenBalance?: undefined;
+    strategyAddress?: undefined;
+} | {
+    appAddress: string;
+    strategyAddress: string;
+    userAddress: string;
+    tokenAddress: string;
+    messageType: "app-strategy-user-first";
+    scoreDelta?: undefined;
+    tokenWethPrice?: undefined;
+    wethUsdcPrice?: undefined;
+    alphaWethPrice?: undefined;
+    userTokenBalance?: undefined;
+} | null;
+
+/**
+ * Encode a PoolKey struct to bytes for scoreStoredContext.
+ * Returns "0x" for invalid or missing pool keys.
+ */
+declare const encodePoolKey: (poolKey?: PoolKey | null) => `0x${string}`;
+
+declare const SCORE_CONTRACT: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const UPVOTE_APP: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const UPVOTE_STORAGE_APP: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const PURE_ALPHA_STRATEGY: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const UNIV234_POOLS_STRATEGY: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const DYNAMIC_SPLIT_STRATEGY: {
+    readonly address: Address;
+    readonly abi: Abi;
+};
+declare const ALL_STRATEGY_ADDRESSES: Address[];
+declare const LEGACY_UPVOTE_V1_ADDRESS: Address;
+declare const LEGACY_UPVOTE_V2_ADDRESS: Address;
+declare const SUPPORTED_SCORE_CHAINS: readonly [8453];
+
+export { ALL_STRATEGY_ADDRESSES, DYNAMIC_SPLIT_STRATEGY, DecodedStrategyMetadata, GetAppKeyScoresOptions, GetStrategyKeyScoresOptions, GetUpvotesForItemsOptions, GetUpvotesOptions, LEGACY_UPVOTE_V1_ADDRESS, LEGACY_UPVOTE_V2_ADDRESS, PURE_ALPHA_STRATEGY, PoolKey, SCORE_CONTRACT, SUPPORTED_SCORE_CHAINS, ScoreClient, ScoreClientOptions, UNIV234_POOLS_STRATEGY, UPVOTE_APP, UPVOTE_STORAGE_APP, decodeStrategyMetadata, decodeUpvoteMessage, decodeUpvoteStorageBlob, encodePoolKey, encodeUpvoteKey, extractStrategyAddress, isDynamicSplitStrategy, isPureAlphaStrategy, isStrategyMessage, isUniv234PoolsStrategy, isUserUpvoteMessage, selectStrategy, tokenAddressToUpvoteKeyString };