feat(solana): cached solana provider #905
Conversation
Signed-off-by: Reinis Martinsons <[email protected]>
Signed-off-by: Reinis Martinsons <[email protected]>
Signed-off-by: Reinis Martinsons <[email protected]>
There was a problem hiding this comment.
currently this is used in tests only
| @@ -13,7 +13,7 @@ export class RateLimitedSolanaRpcFactory extends SolanaClusterRpcFactory { | |||
| private queue: QueueObject<SolanaRateLimitTask>; | |||
|
|
|||
| // Holds the underlying transport that the rate limiter wraps. | |||
| private readonly defaultTransport: RpcTransport; | |||
| protected defaultTransport: RpcTransport; | |||
There was a problem hiding this comment.
had to change these for being able to use in mocks
| */ | ||
| export function jsonReplacerWithBigInts(_key: string, value: unknown): unknown { | ||
| if (typeof value === "bigint") { | ||
| return { type: "BigInt", value: value.toString() }; |
There was a problem hiding this comment.
Alternative would be to encode this as decimal strings followed by n character which would take bit less space.
There was a problem hiding this comment.
I favour storing them as strings 👍. Ultimately I wonder if we'll just use BigInt everywhere, in which case we could unconditionally convert strings as numbers back to BigInt.
| const getSignatureStatusesResponse = await this.rateLimitedRpcClient | ||
| .getSignatureStatuses([params[0]], { | ||
| searchTransactionHistory: true, | ||
| }) | ||
| .send(); | ||
|
|
||
| const getTransactionResponse = await this.rateLimitedTransport<TResponse>(...args); |
There was a problem hiding this comment.
Can we run getSignatureStatuses and this.rateLimitedTransport in parallel using Promise.all(...) to reduce sequential waits?
| // Cache the transaction only if it is finalized. | ||
| if (getSignatureStatusesResponse.value[0]?.confirmationStatus === "finalized") { | ||
| const redisKey = this.buildRedisKey(method, params); | ||
| await this.redisClient?.set( |
There was a problem hiding this comment.
I think there is no need to await here since it won't affect the returned value
| const { method, params } = args[0].payload as { method: string; params?: unknown[] }; | ||
|
|
||
| // Only handles getTransaction right now. | ||
| if (method === "getTransaction") { |
There was a problem hiding this comment.
Nit: You could use an early return if (method !== "getTransaction") return this.rateLimitedTransport<TResponse>(...args);
So we don't need the else at the end and improve readability
| if (cacheType !== CacheType.NONE) { | ||
| const redisKey = this.buildRedisKey(method, params); | ||
|
|
||
| // Attempt to pull the result from the cache. | ||
| const redisResult = await this.redisClient?.get<string>(redisKey); | ||
|
|
||
| // If cache has the result, parse the json and return it. | ||
| if (redisResult) { | ||
| return JSON.parse(redisResult, jsonReviverWithBigInts); | ||
| } | ||
|
|
||
| // Cache does not have the result. Query it directly and cache it if finalized. | ||
| return this.requestAndCacheFinalized<TResponse>(...args); | ||
| } | ||
|
|
||
| return this.rateLimitedTransport<TResponse>(...args); |
There was a problem hiding this comment.
Minor refactor that Nick figured out with the EVM implementation:
| if (cacheType !== CacheType.NONE) { | |
| const redisKey = this.buildRedisKey(method, params); | |
| // Attempt to pull the result from the cache. | |
| const redisResult = await this.redisClient?.get<string>(redisKey); | |
| // If cache has the result, parse the json and return it. | |
| if (redisResult) { | |
| return JSON.parse(redisResult, jsonReviverWithBigInts); | |
| } | |
| // Cache does not have the result. Query it directly and cache it if finalized. | |
| return this.requestAndCacheFinalized<TResponse>(...args); | |
| } | |
| return this.rateLimitedTransport<TResponse>(...args); | |
| if (cacheType === CacheType.NONE) { | |
| return this.rateLimitedTransport<TResponse>(...args); | |
| } | |
| const redisKey = this.buildRedisKey(method, params); | |
| // Attempt to pull the result from the cache. | |
| const redisResult = await this.redisClient?.get<string>(redisKey); | |
| // If cache has the result, parse the json and return it. | |
| if (redisResult) { | |
| return JSON.parse(redisResult, jsonReviverWithBigInts); | |
| } | |
| // Cache does not have the result. Query it directly and cache it if finalized. | |
| return this.requestAndCacheFinalized<TResponse>(...args); |
| typeof value === "object" && | ||
| value !== null && | ||
| "type" in value && | ||
| "value" in value && | ||
| value.type === "BigInt" && | ||
| typeof value.value === "string" && | ||
| /^-?\d+$/.test(value.value) // Ensure it's a valid BigInt value |
There was a problem hiding this comment.
ooc, could superstruct help here ?
This implements similar cached provider logic as
src/providers/cachedProvider.ts, but for Solana.Also adds missing tests for the rate limited Solana provider
Fixes: https://linear.app/uma/issue/ACX-3741/solana-cached-provider