feat: batching for reads and smart-account writes #773
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| import { Type, type Static } from "@sinclair/typebox"; | ||
| import type { FastifyInstance } from "fastify"; | ||
| import { StatusCodes } from "http-status-codes"; | ||
| import SuperJSON from "superjson"; | ||
| import { | ||
| encode, | ||
| getContract, | ||
| prepareContractCall, | ||
| readContract, | ||
| resolveMethod, | ||
| } from "thirdweb"; | ||
| import { prepareMethod } from "thirdweb/contract"; | ||
| import { decodeAbiParameters } from "viem/utils"; | ||
| import type { AbiFunction } from "viem"; | ||
| import { createCustomError } from "../../../middleware/error"; | ||
| import { getChainIdFromChain } from "../../../utils/chain"; | ||
| import { standardResponseSchema } from "../../../schemas/shared-api-schemas"; | ||
| import { getChain } from "../../../../shared/utils/chain"; | ||
| import { thirdwebClient } from "../../../../shared/utils/sdk"; | ||
| import { prettifyError } from "../../../../shared/utils/error"; | ||
|
|
||
| const MULTICALL3_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11"; | ||
|
|
||
| const MULTICALL3_AGGREGATE_ABI = | ||
| "function aggregate3((address target, bool allowFailure, bytes callData)[] calls) external payable returns ((bool success, bytes returnData)[])"; | ||
|
|
||
| const readCallRequestItemSchema = Type.Object({ | ||
| contractAddress: Type.String(), | ||
| functionName: Type.String(), | ||
| functionAbi: Type.Optional(Type.String()), | ||
| args: Type.Optional(Type.Array(Type.Any())), | ||
| }); | ||
|
|
||
| const readMulticallRequestSchema = Type.Object({ | ||
| calls: Type.Array(readCallRequestItemSchema), | ||
| multicallAddress: Type.Optional( | ||
| Type.String({ | ||
| description: `Address of the multicall contract to use. If omitted, multicall3 contract will be used (${MULTICALL3_ADDRESS}).`, | ||
| }), | ||
| ), | ||
| }); | ||
|
|
||
| const responseSchema = Type.Object({ | ||
| results: Type.Array( | ||
| Type.Object({ | ||
| success: Type.Boolean(), | ||
| result: Type.Any(), | ||
| }), | ||
| ), | ||
| }); | ||
|
|
||
| const paramsSchema = Type.Object({ | ||
| chain: Type.String(), | ||
| }); | ||
|
|
||
| type RouteGeneric = { | ||
| Params: { chain: string }; | ||
| Body: Static<typeof readMulticallRequestSchema>; | ||
| Reply: Static<typeof responseSchema>; | ||
| }; | ||
|
|
||
| export async function readMulticallRoute(fastify: FastifyInstance) { | ||
| fastify.route<RouteGeneric>({ | ||
| method: "POST", | ||
| url: "/contract/:chain/read-batch", | ||
| schema: { | ||
| summary: "Batch read from multiple contracts", | ||
| description: | ||
| "Execute multiple contract read operations in a single call using Multicall", | ||
| tags: ["Contract"], | ||
| operationId: "readBatch", | ||
| params: paramsSchema, | ||
| body: readMulticallRequestSchema, | ||
| response: { | ||
| ...standardResponseSchema, | ||
| [StatusCodes.OK]: responseSchema, | ||
| }, | ||
| }, | ||
| handler: async (request, reply) => { | ||
| const { chain: chainSlug } = request.params; | ||
| const { calls, multicallAddress = MULTICALL3_ADDRESS } = request.body; | ||
|
|
||
| const chainId = await getChainIdFromChain(chainSlug); | ||
| const chain = await getChain(chainId); | ||
|
|
||
| try { | ||
| // Encode each read call | ||
| const encodedCalls = await Promise.all( | ||
| calls.map(async (call) => { | ||
| const contract = getContract({ | ||
| client: thirdwebClient, | ||
| chain, | ||
| address: call.contractAddress, | ||
| }); | ||
|
|
||
| const method = | ||
| (call.functionAbi as unknown as AbiFunction) ?? | ||
| (await resolveMethod(call.functionName)(contract)); | ||
|
|
||
| const transaction = prepareContractCall({ | ||
| contract, | ||
| method, | ||
| params: call.args || [], | ||
| }); | ||
|
|
||
| const calldata = await encode(transaction); | ||
| if (!calldata) { | ||
| throw new Error("Failed to encode call data"); | ||
| } | ||
|
|
||
| return { | ||
| target: call.contractAddress, | ||
| abiFunction: method, | ||
| allowFailure: true, | ||
| callData: calldata, | ||
| }; | ||
| }), | ||
| ); | ||
|
|
||
| // Get Multicall3 contract | ||
| const multicall = await getContract({ | ||
| chain, | ||
| address: multicallAddress, | ||
| client: thirdwebClient, | ||
| }); | ||
|
|
||
| // Execute batch read | ||
| const results = await readContract({ | ||
| contract: multicall, | ||
| method: MULTICALL3_AGGREGATE_ABI, | ||
| params: [encodedCalls], | ||
|
There was a problem hiding this comment. i think there was a limit to how much data you can pack in here, did you try a very large read? There was a problem hiding this comment. There's definitely a limit, but failing and forwarding the error should be fine, no? |
||
| }); | ||
|
|
||
| // Process results | ||
| const processedResults = results.map((result: unknown, i) => { | ||
| const { success, returnData } = result as { | ||
| success: boolean; | ||
| returnData: unknown; | ||
| }; | ||
|
|
||
| const [_sig, _inputs, outputs] = prepareMethod( | ||
| encodedCalls[i].abiFunction, | ||
| ); | ||
|
|
||
| const decoded = decodeAbiParameters( | ||
| outputs, | ||
| returnData as `0x${string}`, | ||
| ); | ||
|
|
||
| return { | ||
| success, | ||
| result: success ? decoded : null, | ||
| }; | ||
| }); | ||
|
|
||
| reply.status(StatusCodes.OK).send({ | ||
| results: SuperJSON.serialize(processedResults).json as Static< | ||
| typeof responseSchema | ||
| >["results"], | ||
| }); | ||
| } catch (e) { | ||
| throw createCustomError( | ||
| prettifyError(e), | ||
| StatusCodes.BAD_REQUEST, | ||
| "BAD_REQUEST", | ||
| ); | ||
| } | ||
| }, | ||
| }); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: I consider multicall the implementation, and any interface higher than this method shouldn't need to know about it. So var/fn names (even if not user facing) don't need to have multicall in them. Maybe
batchReadRouteorreadBatchRoute?