@1shotapi/client-sdk 1.0.0

package/dist/validation/transaction.js

@@ -0,0 +1,206 @@
+import { z } from "zod";
+// Validation for log description
+export const logDescriptionSchema = z
+    .object({
+    name: z.string().describe("Name of the log event"),
+    signature: z.string().describe("Signature of the log event"),
+    topic: z.string().describe("Topic of the log event"),
+    args: z
+        .lazy(() => z.array(z.union([z.string(), logDescriptionArgsSchema])))
+        .describe("Arguments of the log event - can be strings or nested arrays of strings"),
+})
+    .describe("A description of a log event");
+// Recursive schema for log description args
+export const logDescriptionArgsSchema = z.lazy(() => z.union([z.string(), z.array(z.union([z.string(), logDescriptionArgsSchema]))]));
+// Validation for transaction status
+export const transactionStatusSchema = z
+    .enum(["Submitted", "Completed", "Retrying", "Failed", "Pending"])
+    .describe("The current status of a transaction. Tracks the lifecycle of a transaction from submission to completion or failure. Used for monitoring and error handling");
+// Validation for transaction
+export const transactionSchema = z
+    .object({
+    id: z
+        .string()
+        .uuid()
+        .describe("Internal ID of the transaction. Unique identifier for tracking the execution lifecycle"),
+    contractMethodIds: z
+        .array(z.string().uuid())
+        .describe("ID of the Contract Method being executed. Links to the Contract Method definition that was executed"),
+    apiCredentialId: z
+        .string()
+        .uuid()
+        .nullable()
+        .describe("ID of the API credential used for execution, if any. Identifies which API key was used to execute the transaction. Will be null if executed by a user"),
+    apiKey: z
+        .string()
+        .nullable()
+        .describe("API key used for execution, if any. The actual API key that was used. Will be null if executed by a user"),
+    userId: z
+        .string()
+        .uuid()
+        .nullable()
+        .describe("ID of the user who initiated the execution, if any. Identifies which user executed the transaction. Will be null if executed via API"),
+    status: transactionStatusSchema,
+    transactionHash: z
+        .string()
+        .nullable()
+        .describe("Hash of the transaction on the blockchain, if available. The actual blockchain transaction hash. Only available after status is Submitted"),
+    contractAddress: z
+        .string()
+        .describe("The address of the smart contract that was called in this transaction"),
+    name: z
+        .string()
+        .describe("Name of the transaction being executed. Included for convenience and display purposes"),
+    functionName: z
+        .string()
+        .describe("Name of the function being called. Included for convenience and display purposes"),
+    chainId: z
+        .number()
+        .int()
+        .positive()
+        .describe("ID of the blockchain network where the transaction is executed. Determines which blockchain the transaction was sent to"),
+    memo: z
+        .string()
+        .nullable()
+        .describe("Optional memo or note about the transaction. Can contain user-provided text or formatted data about why the execution was done"),
+    completed: z
+        .number()
+        .nullable()
+        .describe("Unix timestamp when the execution completed, if applicable. Used for tracking execution duration and timing"),
+    walletId: z.string().uuid().describe("ID of the wallet that executed the transaction"),
+    failureReason: z
+        .string()
+        .nullable()
+        .describe("The reason the transaction failed. This is only set if the transaction failed"),
+    from: z.string().describe("The address of the account that sent the transaction"),
+    to: z.string().nullable().describe("The address of the account that received the transaction"),
+    gasPrice: z.string().nullable().describe("The gas price of the transaction"),
+    gasLimit: z.string().nullable().describe("The gas limit of the transaction"),
+    maxFeePerGas: z.string().nullable().describe("The max fee per gas of the transaction"),
+    maxPriorityFeePerGas: z
+        .string()
+        .nullable()
+        .describe("The max priority fee per gas of the transaction"),
+    gasUsed: z.string().nullable().describe("The gas used by the transaction"),
+    logs: z
+        .array(logDescriptionSchema)
+        .nullable()
+        .describe("The logs, if any, emitted by the transaction"),
+    updated: z
+        .number()
+        .describe("Unix timestamp of the last update to this execution. Used for tracking changes"),
+    created: z
+        .number()
+        .describe("Unix timestamp when this execution was created. Used for tracking creation time"),
+    deleted: z
+        .boolean()
+        .describe("Whether this execution has been deleted. Used for soft deletion and filtering"),
+})
+    .describe("A record of a transaction attempt. Represents a single execution of a transaction on the blockchain, including its status, parameters, and results. Used for tracking and monitoring transaction lifecycle");
+// Validation for transaction list response
+export const transactionListSchema = z
+    .object({
+    response: z
+        .array(transactionSchema)
+        .describe("List of transaction executions matching the query parameters"),
+    page: z
+        .number()
+        .int()
+        .positive()
+        .describe("Current page number in the paginated results (1-indexed)"),
+    pageSize: z
+        .number()
+        .int()
+        .positive()
+        .describe("Number of items per page. Determines how many executions are returned"),
+    totalResults: z
+        .number()
+        .int()
+        .nonnegative()
+        .describe("Total number of results available across all pages"),
+})
+    .describe("Paginated list of transaction executions. Used for retrieving multiple transaction executions with pagination support");
+// Validation for get transaction parameters
+export const getTransactionSchema = z
+    .object({
+    transactionId: z
+        .string()
+        .uuid()
+        .describe("Execution ID of the specific transaction to retrieve. Identifies which execution to fetch"),
+})
+    .describe("Parameters for retrieving a specific transaction. Used to get detailed information about a single execution");
+// Validation for list transaction executions parameters
+export const listTransactionsSchema = z
+    .object({
+    businessId: z
+        .string()
+        .uuid()
+        .describe("ID of the business to list executions for. Used for access control and filtering"),
+    pageSize: z
+        .number()
+        .int()
+        .positive()
+        .optional()
+        .nullable()
+        .describe("Number of items per page. Optional parameter for pagination control"),
+    page: z
+        .number()
+        .int()
+        .positive()
+        .optional()
+        .nullable()
+        .describe("Page number to retrieve (1-indexed). Optional parameter for pagination control"),
+    chainId: z
+        .number()
+        .int()
+        .positive()
+        .optional()
+        .nullable()
+        .describe("Filter executions by blockchain network ID. Optional parameter to get executions for a specific chainId"),
+    status: z
+        .enum(["Pending", "Submitted", "Completed", "Retrying", "Failed"])
+        .optional()
+        .nullable()
+        .describe("Filter executions by status. Optional parameter to filter by execution state"),
+    walletId: z
+        .string()
+        .uuid()
+        .optional()
+        .nullable()
+        .describe("Filter executions by wallet ID. Optional parameter to get executions for a specific wallet"),
+    contractMethodId: z
+        .string()
+        .uuid()
+        .optional()
+        .nullable()
+        .describe("Filter executions by contract method ID. Optional parameter to get executions of a specific contract method"),
+    apiCredentialId: z
+        .string()
+        .uuid()
+        .optional()
+        .nullable()
+        .describe("Filter executions by API credential ID. Optional parameter to get executions made with a specific API key"),
+    userId: z
+        .string()
+        .uuid()
+        .optional()
+        .nullable()
+        .describe("Filter executions by user ID. Optional parameter to get executions made by a specific user"),
+    memo: z
+        .string()
+        .optional()
+        .nullable()
+        .describe("Filter executions by memo text. Optional parameter to search for specific memos"),
+    createdAfter: z
+        .number()
+        .optional()
+        .nullable()
+        .describe("Filter executions created after this timestamp. Optional parameter for time-based filtering"),
+    createdBefore: z
+        .number()
+        .optional()
+        .nullable()
+        .describe("Filter executions created before this timestamp. Optional parameter for time-based filtering"),
+})
+    .describe("Parameters for listing transaction executions. Used to filter and paginate execution lists with various criteria");
+//# sourceMappingURL=transaction.js.map

package/dist/validation/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../src/validation/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,iCAAiC;AACjC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IAClD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IAC5D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IACpD,IAAI,EAAE,CAAC;SACJ,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;SACpE,QAAQ,CAAC,yEAAyE,CAAC;CACvF,CAAC;KACD,QAAQ,CAAC,8BAA8B,CAAC,CAAC;AAE5C,4CAA4C;AAC5C,MAAM,CAAC,MAAM,wBAAwB,GAA4C,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAC3F,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,CAChF,CAAC;AAEF,oCAAoC;AACpC,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,IAAI,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;KACjE,QAAQ,CACP,6JAA6J,CAC9J,CAAC;AAEJ,6BAA6B;AAC7B,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,EAAE,EAAE,CAAC;SACF,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,wFAAwF,CACzF;IACH,iBAAiB,EAAE,CAAC;SACjB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;SACxB,QAAQ,CACP,qGAAqG,CACtG;IACH,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,EAAE;SACV,QAAQ,CACP,uJAAuJ,CACxJ;IACH,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,0GAA0G,CAC3G;IACH,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,EAAE;SACV,QAAQ,CACP,sIAAsI,CACvI;IACH,MAAM,EAAE,uBAAuB;IAC/B,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,2IAA2I,CAC5I;IACH,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,QAAQ,CAAC,uEAAuE,CAAC;IACpF,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,CACP,uFAAuF,CACxF;IACH,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,CAAC,kFAAkF,CAAC;IAC/F,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CACP,yHAAyH,CAC1H;IACH,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,gIAAgI,CACjI;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,6GAA6G,CAC9G;IACH,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,gDAAgD,CAAC;IACtF,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,+EAA+E,CAAC;IAC5F,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sDAAsD,CAAC;IACjF,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,0DAA0D,CAAC;IAC9F,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IAC5E,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IAC5E,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC;IACtF,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,iDAAiD,CAAC;IAC9D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC;IAC1E,IAAI,EAAE,CAAC;SACJ,KAAK,CAAC,oBAAoB,CAAC;SAC3B,QAAQ,EAAE;SACV,QAAQ,CAAC,8CAA8C,CAAC;IAC3D,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,CAAC,gFAAgF,CAAC;IAC7F,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,CAAC,iFAAiF,CAAC;IAC9F,OAAO,EAAE,CAAC;SACP,OAAO,EAAE;SACT,QAAQ,CAAC,+EAA+E,CAAC;CAC7F,CAAC;KACD,QAAQ,CACP,4MAA4M,CAC7M,CAAC;AAEJ,2CAA2C;AAC3C,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC;SACR,KAAK,CAAC,iBAAiB,CAAC;SACxB,QAAQ,CAAC,8DAA8D,CAAC;IAC3E,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CAAC,uEAAuE,CAAC;IACpF,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,GAAG,EAAE;SACL,WAAW,EAAE;SACb,QAAQ,CAAC,oDAAoD,CAAC;CAClE,CAAC;KACD,QAAQ,CACP,uHAAuH,CACxH,CAAC;AAEJ,4CAA4C;AAC5C,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,2FAA2F,CAC5F;CACJ,CAAC;KACD,QAAQ,CACP,6GAA6G,CAC9G,CAAC;AAEJ,wDAAwD;AACxD,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACpC,MAAM,CAAC;IACN,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CAAC,kFAAkF,CAAC;IAC/F,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,qEAAqE,CAAC;IAClF,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,gFAAgF,CAAC;IAC7F,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,yGAAyG,CAC1G;IACH,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;SACjE,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,8EAA8E,CAAC;IAC3F,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,4FAA4F,CAC7F;IACH,gBAAgB,EAAE,CAAC;SAChB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,6GAA6G,CAC9G;IACH,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,2GAA2G,CAC5G;IACH,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,4FAA4F,CAC7F;IACH,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,iFAAiF,CAAC;IAC9F,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,6FAA6F,CAC9F;IACH,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CACP,8FAA8F,CAC/F;CACJ,CAAC;KACD,QAAQ,CACP,kHAAkH,CACnH,CAAC"}