Skip to content
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

Add struct parsing to @typechain/web3-v1 (#779) #801

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add struct parsing to @typechain/web3-v1 (#779) #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a97695
Add struct parsing to @typechain/web3-v1 (#779)
mihai9-lab Jan 23, 2023
a2e307c
Fix formatting, update saved files
krzkaczor Jan 23, 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
5 changes: 5 additions & 0 deletions .changeset/pink-ads-rhyme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@typechain/web3-v1': minor
---

Add struct parsing and typing for web3 library
278 changes: 233 additions & 45 deletions packages/target-web3-v1-test/types/v0.6.4/DataTypesInput.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,62 @@ export interface EventOptions {
topics?: string[];
}

export declare namespace StructsLib1 {
export type InfoStruct =
| [number | string | BN, number | string | BN]
| { a: number | string | BN; b: number | string | BN };

export type InfoStructOutputArray = [string, string];
export type InfoStructOutputStruct = { a: string; b: string };
export type InfoStructOutput = InfoStructOutputArray & InfoStructOutputStruct;
}

export declare namespace StructsLib2 {
export type InfoStruct = [string, string] | { a: string; b: string };

export type InfoStructOutputArray = [string, string];
export type InfoStructOutputStruct = { a: string; b: string };
export type InfoStructOutput = InfoStructOutputArray & InfoStructOutputStruct;
}

export declare namespace DataTypesInput {
export type Struct1Struct =
| [number | string | BN, number | string | BN]
| { uint256_0: number | string | BN; uint256_1: number | string | BN };

export type Struct1StructOutputArray = [string, string];
export type Struct1StructOutputStruct = {
uint256_0: string;
uint256_1: string;
};
export type Struct1StructOutput = Struct1StructOutputArray &
Struct1StructOutputStruct;

export type Struct2Struct =
| [number | string | BN, DataTypesInput.Struct1Struct]
| { input1: number | string | BN; input2: DataTypesInput.Struct1Struct };

export type Struct2StructOutputArray = [
string,
DataTypesInput.Struct1StructOutput
];
export type Struct2StructOutputStruct = {
input1: string;
input2: DataTypesInput.Struct1StructOutput;
};
export type Struct2StructOutput = Struct2StructOutputArray &
Struct2StructOutputStruct;

export type Struct3Struct =
| [number | string | BN[]]
| { input1: number | string | BN[] };

export type Struct3StructOutputArray = [string[]];
export type Struct3StructOutputStruct = { input1: string[] };
export type Struct3StructOutput = Struct3StructOutputArray &
Struct3StructOutputStruct;
}

export interface DataTypesInput extends BaseContract {
constructor(
jsonInterface: any[],
Expand All @@ -44,8 +100,20 @@ export interface DataTypesInput extends BaseContract {
): NonPayableTransactionObject<string>;

input_fixedarray_array_fixedarray(
input1: (number | string | BN)[][][]
): NonPayableTransactionObject<string[][][]>;
input1: [
[number | string | BN, number | string | BN, number | string | BN][],
[number | string | BN, number | string | BN, number | string | BN][],
[number | string | BN, number | string | BN, number | string | BN][],
[number | string | BN, number | string | BN, number | string | BN][]
]
): NonPayableTransactionObject<
[
[string, string, string][],
[string, string, string][],
[string, string, string][],
[string, string, string][]
]
>;

input_int256(
input1: number | string | BN
Expand All @@ -56,83 +124,203 @@ export interface DataTypesInput extends BaseContract {
): NonPayableTransactionObject<string>;

input_multiple_structs_with_same_name(
info1: [number | string | BN, number | string | BN]
): NonPayableTransactionObject<[string, string]>;
info1: StructsLib1.InfoStruct
): NonPayableTransactionObject<StructsLib2.InfoStructOutput>;

input_stat_array(
input1: (number | string | BN)[]
): NonPayableTransactionObject<string[]>;
input1: [number | string | BN, number | string | BN, number | string | BN]
): NonPayableTransactionObject<[string, string, string]>;

input_string(input1: string): NonPayableTransactionObject<string>;

input_struct(
input1: [number | string | BN, number | string | BN]
): NonPayableTransactionObject<[string, string]>;
input1: DataTypesInput.Struct1Struct
): NonPayableTransactionObject<DataTypesInput.Struct1StructOutput>;

input_struct2(
input1: [
number | string | BN,
[number | string | BN, number | string | BN]
]
): NonPayableTransactionObject<[string, [string, string]]>;
input1: DataTypesInput.Struct2Struct
): NonPayableTransactionObject<DataTypesInput.Struct2StructOutput>;

input_struct2_array(
input1: [
number | string | BN,
[number | string | BN, number | string | BN]
][]
): NonPayableTransactionObject<[string, [string, string]][]>;
input1: DataTypesInput.Struct2Struct[]
): NonPayableTransactionObject<DataTypesInput.Struct2StructOutput[]>;

input_struct2_tuple(
input: [
number | string | BN,
[number | string | BN, number | string | BN]
][]
): NonPayableTransactionObject<[string, [string, string]][]>;
DataTypesInput.Struct2Struct,
DataTypesInput.Struct2Struct,
DataTypesInput.Struct2Struct
]
): NonPayableTransactionObject<
[
DataTypesInput.Struct2StructOutput,
DataTypesInput.Struct2StructOutput,
DataTypesInput.Struct2StructOutput
]
>;

input_struct3_array(
input1: [(number | string | BN)[]][]
): NonPayableTransactionObject<[string[]][]>;
input1: DataTypesInput.Struct3Struct[]
): NonPayableTransactionObject<DataTypesInput.Struct3StructOutput[]>;

input_struct_array(
input1: [number | string | BN, number | string | BN][]
): NonPayableTransactionObject<[string, string][]>;
input1: DataTypesInput.Struct1Struct[]
): NonPayableTransactionObject<DataTypesInput.Struct1StructOutput[]>;

input_struct_array_array(
input1: [number | string | BN, number | string | BN][][]
): NonPayableTransactionObject<[string, string][][]>;
input1: DataTypesInput.Struct1Struct[][]
): NonPayableTransactionObject<DataTypesInput.Struct1StructOutput[][]>;

input_struct_array_array_array(
input1: [number | string | BN, number | string | BN][][][]
): NonPayableTransactionObject<[string, string][][][]>;
input1: DataTypesInput.Struct1Struct[][][]
): NonPayableTransactionObject<DataTypesInput.Struct1StructOutput[][][]>;

input_struct_array_fixedarray(
input1: [number | string | BN, number | string | BN][][]
): NonPayableTransactionObject<[string, string][][]>;
input1: [DataTypesInput.Struct1Struct[], DataTypesInput.Struct1Struct[]]
): NonPayableTransactionObject<
[
DataTypesInput.Struct1StructOutput[],
DataTypesInput.Struct1StructOutput[]
]
>;

input_struct_fixedarray_array(
input1: [number | string | BN, number | string | BN][][]
): NonPayableTransactionObject<[string, string][][]>;
input1: [DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][]
): NonPayableTransactionObject<
[DataTypesInput.Struct1StructOutput, DataTypesInput.Struct1StructOutput][]
>;

input_struct_fixedarray_array_fixedarray(
input1: [number | string | BN, number | string | BN][][][]
): NonPayableTransactionObject<[string, string][][][]>;
input1: [
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][]
]
): NonPayableTransactionObject<
[
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][]
]
>;

input_struct_fixedarray_array_fixedarray_array_fixedarray(
input1: [number | string | BN, number | string | BN][][][][][]
): NonPayableTransactionObject<[string, string][][][][][]>;
input1: [
[
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][]
][],
[
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][]
][],
[
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][]
][],
[
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct][]
][]
]
): NonPayableTransactionObject<
[
[
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][]
][],
[
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][]
][],
[
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][]
][],
[
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
][]
][]
]
>;

input_struct_fixedarray_fixedarray(
input1: [number | string | BN, number | string | BN][][]
): NonPayableTransactionObject<[string, string][][]>;
input1: [
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct],
[DataTypesInput.Struct1Struct, DataTypesInput.Struct1Struct]
]
): NonPayableTransactionObject<
[
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
],
[
DataTypesInput.Struct1StructOutput,
DataTypesInput.Struct1StructOutput
],
[DataTypesInput.Struct1StructOutput, DataTypesInput.Struct1StructOutput]
]
>;

input_tuple(
input1: number | string | BN,
input2: number | string | BN
): NonPayableTransactionObject<{
0: string;
1: string;
}>;
): NonPayableTransactionObject<[string, string]>;

input_uint256(
input1: number | string | BN
Expand All @@ -143,7 +331,7 @@ export interface DataTypesInput extends BaseContract {
): NonPayableTransactionObject<string>;

input_uint_array(
input1: (number | string | BN)[]
input1: number | string | BN[]
): NonPayableTransactionObject<string[]>;
};
events: {
Expand Down
32 changes: 20 additions & 12 deletions packages/target-web3-v1-test/types/v0.6.4/DataTypesPure.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,20 @@ export interface EventOptions {
topics?: string[];
}

export declare namespace DataTypesPure {
export type Struct1Struct =
| [number | string | BN, number | string | BN]
| { uint256_0: number | string | BN; uint256_1: number | string | BN };

export type Struct1StructOutputArray = [string, string];
export type Struct1StructOutputStruct = {
uint256_0: string;
uint256_1: string;
};
export type Struct1StructOutput = Struct1StructOutputArray &
Struct1StructOutputStruct;
}

export interface DataTypesPure extends BaseContract {
constructor(
jsonInterface: any[],
Expand All @@ -43,23 +57,17 @@ export interface DataTypesPure extends BaseContract {

pure_int8(): NonPayableTransactionObject<string>;

pure_named(): NonPayableTransactionObject<{
uint256_1: string;
uint256_2: string;
0: string;
1: string;
}>;
pure_named(): NonPayableTransactionObject<
[string, string] & { uint256_1: string; uint256_2: string }
>;

pure_stat_array(): NonPayableTransactionObject<string[]>;
pure_stat_array(): NonPayableTransactionObject<[string, string, string]>;

pure_string(): NonPayableTransactionObject<string>;

pure_struct(): NonPayableTransactionObject<[string, string]>;
pure_struct(): NonPayableTransactionObject<DataTypesPure.Struct1StructOutput>;

pure_tuple(): NonPayableTransactionObject<{
0: string;
1: string;
}>;
pure_tuple(): NonPayableTransactionObject<[string, string]>;

pure_uint256(): NonPayableTransactionObject<string>;

Expand Down
Loading