Skip to content

Improve IDL typing #2482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
acheroncrypto merged 3 commits into from
May 8, 2023
Merged

Improve IDL typing #2482

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c1f52d
Improve IDL typing
Juici May 5, 2023
80f1ba3
Fix issues with infinite type recursion
Juici May 5, 2023
70ddab2
Fix linter issues
Juici May 7, 2023
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
48 changes: 25 additions & 23 deletions ts/packages/anchor/src/program/namespace/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,24 +124,20 @@ type TypeMap = {
[K in "u64" | "i64" | "u128" | "i128" | "u256" | "i256"]: BN;
};

export type DecodeType<T extends IdlType, Defined> = T extends keyof TypeMap
export type DecodeType<T extends IdlType, Defined> = IdlType extends T
? unknown
: T extends keyof TypeMap
? TypeMap[T]
: T extends { defined: keyof Defined }
? Defined[T["defined"]]
: T extends { option: { defined: keyof Defined } }
? Defined[T["option"]["defined"]] | null
: T extends { option: keyof TypeMap }
? TypeMap[T["option"]] | null
: T extends { coption: { defined: keyof Defined } }
? Defined[T["coption"]["defined"]] | null
: T extends { coption: keyof TypeMap }
? TypeMap[T["coption"]] | null
: T extends { vec: keyof TypeMap }
? TypeMap[T["vec"]][]
: T extends { vec: { defined: keyof Defined } }
? Defined[T["vec"]["defined"]][]
: T extends { array: [defined: keyof TypeMap, size: number] }
? TypeMap[T["array"][0]][]
: T extends { option: IdlType }
? DecodeType<T["option"], Defined> | null
: T extends { coption: IdlType }
? DecodeType<T["coption"], Defined> | null
: T extends { vec: IdlType }
? DecodeType<T["vec"], Defined>[]
: T extends { array: [defined: IdlType, size: number] }
? DecodeType<T["array"][0], Defined>[]
: unknown;

/**
Expand Down Expand Up @@ -196,18 +192,24 @@ declare type DecodeEnumFields<
}
: Record<string, never>;

/**
* Since TypeScript do not provide OneOf helper we can
* simply mark enum variants with +?
*/
declare type DecodeEnum<K extends IdlTypeDefTyEnum, Defined> = {
// X = IdlEnumVariant
[X in K["variants"][number] as Uncapitalize<X["name"]>]+?: DecodeEnumFields<
NonNullable<X["fields"]>,
type DecodeEnumVariants<I extends IdlTypeDefTyEnum, Defined> = {
[V in I["variants"][number] as Uncapitalize<V["name"]>]: DecodeEnumFields<
NonNullable<V["fields"]>,
Defined
>;
};

type ValueOf<T> = T[keyof T];
type XorEnumVariants<T extends Record<string, unknown>> = ValueOf<{
[K1 in keyof T]: {
[K2 in Exclude<keyof T, K1>]?: never;
} & { [K2 in K1]: T[K2] };
}>;

type DecodeEnum<I extends IdlTypeDefTyEnum, Defined> = XorEnumVariants<
DecodeEnumVariants<I, Defined>
>;

type DecodeStruct<I extends IdlTypeDefTyStruct, Defined> = {
[F in I["fields"][number] as F["name"]]: DecodeType<F["type"], Defined>;
};
Expand Down