Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/shiny-suits-kneel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@thirdweb-dev/sdk": patch
"@thirdweb-dev/solana": patch
---

Update JSON schema in SDKs
9 changes: 0 additions & 9 deletions packages/sdk/src/core/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,3 @@ export interface GaslessTransaction {
functionArgs: any[];
callOverrides: CallOverrides;
}

type JsonLiteralOutput = boolean | null | number | string;
type JsonLiteralInput = JsonLiteralOutput | BigNumber | bigint;

export type JsonOutput = JsonLiteralOutput | JsonObjectOutput | JsonOutput[];
export type JsonObjectOutput = { [key: string]: JsonOutput };

export type JsonInput = JsonLiteralInput | JsonObjectInput | JsonInput[];
export type JsonObjectInput = { [key: string]: JsonInput };
3 changes: 1 addition & 2 deletions packages/sdk/src/schema/contracts/common/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import {
AddressSchema,
BasisPointsSchema,
FileOrBufferOrStringSchema,
JsonSchema,
} from "../../shared";
import { constants } from "ethers";
import { z } from "zod";
Expand All @@ -24,7 +23,7 @@ export type CommonContractSchemaInput = z.input<typeof CommonContractSchema>;
*/
export const CommonContractOutputSchema = CommonContractSchema.extend({
image: z.string().optional(),
}).catchall(z.lazy(() => JsonSchema));
}).catchall(z.unknown());

/**
* @internal
Expand Down
4 changes: 2 additions & 2 deletions packages/sdk/src/schema/contracts/custom.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { toSemver } from "../../common/index";
import {
AddressSchema,
BigNumberishSchema,
BigNumberTransformSchema,
FileOrBufferOrStringSchema,
JsonSchema,
} from "../shared";
import {
CommonContractOutputSchema,
Expand All @@ -22,7 +22,7 @@ import { z } from "zod";
* @internal
*/
export const BYOCContractMetadataSchema = CommonContractSchema.catchall(
z.lazy(() => JsonSchema),
z.union([BigNumberTransformSchema, z.unknown()]),
);

/**
Expand Down
74 changes: 36 additions & 38 deletions packages/sdk/src/schema/shared.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,29 @@
import { JsonOutput, JsonInput } from "../core/types";
import { BigNumber, CallOverrides, utils } from "ethers";
import { z, ZodTypeDef } from "zod";
import { z } from "zod";

const isBrowser = () => typeof window !== "undefined";
const FileOrBufferUnionSchema = isBrowser()
? (z.instanceof(File) as z.ZodType<InstanceType<typeof File>>)
: (z.instanceof(Buffer) as z.ZodTypeAny); // @fixme, this is a hack to make browser happy for now

/**
* @internal
*/
export const FileOrBufferSchema = z.union([
FileOrBufferUnionSchema,
z.object({
data: z.union([FileOrBufferUnionSchema, z.string()]),
name: z.string(),
}),
]);

/**
* @internal
*/
export const FileOrBufferOrStringSchema = z.union([
FileOrBufferSchema,
z.string(),
]);

export const MAX_BPS = 10000;

Expand All @@ -21,6 +44,17 @@ export const BigNumberishSchema = BigNumberSchema.transform((arg) =>
arg.toString(),
);

export const BigNumberTransformSchema = z
.union([
z.bigint(),
z.custom<BigNumber>((data) => {
return BigNumber.isBigNumber(data);
}),
])
.transform((arg) => {
return BigNumber.from(arg).toString();
});

export const BasisPointsSchema = z
.number()
.max(MAX_BPS, "Cannot exeed 100%")
Expand Down Expand Up @@ -48,18 +82,6 @@ export const AddressSchema = z.string().refine(
},
);

export const JsonLiteral = z.union([
z.string(),
z.number(),
z.boolean(),
z.null(),
BigNumberishSchema,
]);

export const JsonSchema: z.ZodSchema<JsonOutput, ZodTypeDef, JsonInput> =
z.lazy(() => z.union([JsonLiteral, JsonObjectSchema, z.array(JsonSchema)]));
export const JsonObjectSchema = z.record(JsonSchema);

export const AmountSchema = z
.union([
z.string().regex(/^([0-9]+\.?[0-9]*|\.[0-9]+)$/, "Invalid amount"),
Expand Down Expand Up @@ -96,27 +118,3 @@ export const CallOverrideSchema: z.ZodType<CallOverrides> = z
type: z.number().optional(),
})
.strict();

const isBrowser = () => typeof window !== "undefined";
const FileOrBufferUnionSchema = isBrowser()
? (z.instanceof(File) as z.ZodType<InstanceType<typeof File>>)
: (z.instanceof(Buffer) as z.ZodTypeAny); // @fixme, this is a hack to make browser happy for now

/**
* @internal
*/
export const FileOrBufferSchema = z.union([
FileOrBufferUnionSchema,
z.object({
data: z.union([FileOrBufferUnionSchema, z.string()]),
name: z.string(),
}),
]);

/**
* @internal
*/
export const FileOrBufferOrStringSchema = z.union([
FileOrBufferSchema,
z.string(),
]);
4 changes: 2 additions & 2 deletions packages/sdk/src/schema/tokens/common/index.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import {
BigNumberSchema,
BigNumberTransformSchema,
FileOrBufferOrStringSchema,
HexColor,
JsonSchema,
} from "../../shared";
import { OptionalPropertiesInput } from "./properties";
import { z } from "zod";
Expand All @@ -17,7 +17,7 @@ export const CommonTokenInput = z
image: FileOrBufferOrStringSchema.nullable().optional(),
external_url: FileOrBufferOrStringSchema.nullable().optional(),
})
.catchall(z.lazy(() => JsonSchema));
.catchall(z.union([BigNumberTransformSchema, z.unknown()]));

/**
* @internal
Expand Down
8 changes: 6 additions & 2 deletions packages/sdk/src/schema/tokens/common/properties.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
import { JsonObjectSchema } from "../../shared";
import { BigNumberTransformSchema } from "../../shared";
import { z } from "zod";

const PropertiesInput = z
.object({})
.catchall(z.union([BigNumberTransformSchema, z.unknown()]));

/**
* @internal
*/
export const OptionalPropertiesInput = z
.union([z.array(JsonObjectSchema), JsonObjectSchema])
.union([z.array(PropertiesInput), PropertiesInput])
.optional();
19 changes: 6 additions & 13 deletions packages/solana/src/types/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,6 @@ export const JsonLiteral = z.union([
z.null(),
]);

/**
* @internal
*/
export const JsonSchema: z.ZodType<Json> = z.lazy(() =>
z.union([JsonLiteral, JsonObjectSchema, z.array(JsonSchema)]),
);

/**
* @internal
*/
export const JsonObjectSchema = z.record(z.string(), JsonSchema);

/**
* @internal
*/
Expand All @@ -70,11 +58,16 @@ export const HexColor = z.union([
z.string().length(0),
]);

/**
* @internal
*/
const PropertiesInput = z.object({}).catchall(z.unknown());

/**
* @internal
*/
export const OptionalPropertiesInput = z
.union([z.array(JsonObjectSchema), JsonObjectSchema])
.union([z.array(PropertiesInput), PropertiesInput])
.optional();

/**
Expand Down
8 changes: 2 additions & 6 deletions packages/solana/src/types/contracts/index.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
import {
AmountSchema,
FileOrBufferOrStringSchema,
JsonSchema,
} from "../common";
import { AmountSchema, FileOrBufferOrStringSchema } from "../common";
import { z } from "zod";

/**
Expand All @@ -21,7 +17,7 @@ export const CommonContractSchema = z.object({
*/
export const CommonContractOutputSchema = CommonContractSchema.extend({
image: z.string().optional(),
}).catchall(z.lazy(() => JsonSchema));
}).catchall(z.unknown());

/// NFT ///

Expand Down
3 changes: 1 addition & 2 deletions packages/solana/src/types/nft.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import {
CurrencyValueSchema,
FileOrBufferOrStringSchema,
HexColor,
JsonSchema,
OptionalPropertiesInput,
} from "./common";
import { z } from "zod";
Expand All @@ -18,7 +17,7 @@ export const CommonTokenInput = z
image: FileOrBufferOrStringSchema.nullable().optional(),
external_url: FileOrBufferOrStringSchema.nullable().optional(),
})
.catchall(z.lazy(() => JsonSchema));
.catchall(z.unknown());

/**
* @internal
Expand Down