Skip to content

Add support for solidity structs #493

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
zemse merged 13 commits into from
Oct 21, 2021
Merged

Add support for solidity structs #493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1041120
[typechain] feat: parse structs
zemse Oct 6, 2021
994fc45
[typechain] test: struct parsing
zemse Oct 6, 2021
89aa1ee
fix: generation tests
zemse Oct 6, 2021
44a78f5
[ethers-v5] feat: export structs
zemse Oct 6, 2021
3c85868
[ethers-v5] chore: run ci
zemse Oct 6, 2021
178766f
test: add complex struct and struct array
zemse Oct 6, 2021
8f39d22
[ethers-v5] fix: input struct types
zemse Oct 6, 2021
d11512b
[ethers-v5] test: add test cases for struct types
zemse Oct 6, 2021
3b8c2c0
[ethers-v5] refactor: use struct postfix from common
zemse Oct 6, 2021
c69fa92
[typechain] refactor: insertStruct -> registerStruct
zemse Oct 7, 2021
a80965c
Add changeset
zemse Oct 13, 2021
174f593
Merge branch 'master' into ethers-v5-structs
hasparus Oct 18, 2021
a55e6c4
Bump target-ethers-v5 peerDependency on typechain to 5.2.0
hasparus Oct 18, 2021
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
16 changes: 16 additions & 0 deletions .changeset/fluffy-rats-sniff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
'@typechain/ethers-v5': minor
'typechain': minor
---

Add support for Solidity structs

```ts
// before
function deposit(amount: { token: string; value: BigNumberish }): Promise<ContractTransaction>

// after
export type AmountStruct = { token: string; value: BigNumberish }

function deposit(amount: AmountStruct): Promise<ContractTransaction>
```
10 changes: 10 additions & 0 deletions contracts/v0.6.4/DataTypesInput.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,14 @@ contract DataTypesInput {
function input_enum(Enum1 input1) public pure returns (Enum1) {
return input1;
}
struct Struct2 {
uint input1;
Struct1 input2;
}
function input_struct2(Struct2 memory input1) public pure returns (Struct2 memory) {
return input1;
}
function input_struct2_array(Struct2[] memory input1) public pure returns (Struct2[] memory) {
return input1;
}
}
202 changes: 202 additions & 0 deletions packages/target-ethers-v4-test/types/DataTypesInput.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,24 @@ interface DataTypesInputInterface extends Interface {
]): string;
}>;

input_struct2: TypedFunctionDescription<{
encode([input1]: [
{
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
}
]): string;
}>;

input_struct2_array: TypedFunctionDescription<{
encode([input1]: [
{
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
}[]
]): string;
}>;

input_tuple: TypedFunctionDescription<{
encode([input1, input2]: [BigNumberish, BigNumberish]): string;
}>;
Expand Down Expand Up @@ -189,6 +207,82 @@ export class DataTypesInput extends Contract {
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
>;

input_struct2(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
},
overrides?: UnsignedTransaction
): Promise<
[
BigNumber,
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
] & {
input1: BigNumber;
input2: [BigNumber, BigNumber] & {
uint256_0: BigNumber;
uint256_1: BigNumber;
};
}
>;

"input_struct2((uint256,(uint256,uint256)))"(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
},
overrides?: UnsignedTransaction
): Promise<
[
BigNumber,
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
] & {
input1: BigNumber;
input2: [BigNumber, BigNumber] & {
uint256_0: BigNumber;
uint256_1: BigNumber;
};
}
>;

input_struct2_array(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
}[],
overrides?: UnsignedTransaction
): Promise<
([
BigNumber,
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
] & {
input1: BigNumber;
input2: [BigNumber, BigNumber] & {
uint256_0: BigNumber;
uint256_1: BigNumber;
};
})[]
>;

"input_struct2_array(tuple[])"(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
}[],
overrides?: UnsignedTransaction
): Promise<
([
BigNumber,
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
] & {
input1: BigNumber;
input2: [BigNumber, BigNumber] & {
uint256_0: BigNumber;
uint256_1: BigNumber;
};
})[]
>;

input_tuple(
input1: BigNumberish,
input2: BigNumberish,
Expand Down Expand Up @@ -326,6 +420,82 @@ export class DataTypesInput extends Contract {
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
>;

input_struct2(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
},
overrides?: UnsignedTransaction
): Promise<
[
BigNumber,
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
] & {
input1: BigNumber;
input2: [BigNumber, BigNumber] & {
uint256_0: BigNumber;
uint256_1: BigNumber;
};
}
>;

"input_struct2((uint256,(uint256,uint256)))"(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
},
overrides?: UnsignedTransaction
): Promise<
[
BigNumber,
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
] & {
input1: BigNumber;
input2: [BigNumber, BigNumber] & {
uint256_0: BigNumber;
uint256_1: BigNumber;
};
}
>;

input_struct2_array(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
}[],
overrides?: UnsignedTransaction
): Promise<
([
BigNumber,
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
] & {
input1: BigNumber;
input2: [BigNumber, BigNumber] & {
uint256_0: BigNumber;
uint256_1: BigNumber;
};
})[]
>;

"input_struct2_array(tuple[])"(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
}[],
overrides?: UnsignedTransaction
): Promise<
([
BigNumber,
[BigNumber, BigNumber] & { uint256_0: BigNumber; uint256_1: BigNumber }
] & {
input1: BigNumber;
input2: [BigNumber, BigNumber] & {
uint256_0: BigNumber;
uint256_1: BigNumber;
};
})[]
>;

input_tuple(
input1: BigNumberish,
input2: BigNumberish,
Expand Down Expand Up @@ -461,6 +631,38 @@ export class DataTypesInput extends Contract {
overrides?: UnsignedTransaction
): Promise<BigNumber>;

input_struct2(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
},
overrides?: UnsignedTransaction
): Promise<BigNumber>;

"input_struct2((uint256,(uint256,uint256)))"(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
},
overrides?: UnsignedTransaction
): Promise<BigNumber>;

input_struct2_array(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
}[],
overrides?: UnsignedTransaction
): Promise<BigNumber>;

"input_struct2_array(tuple[])"(
input1: {
input1: BigNumberish;
input2: { uint256_0: BigNumberish; uint256_1: BigNumberish };
}[],
overrides?: UnsignedTransaction
): Promise<BigNumber>;

input_tuple(
input1: BigNumberish,
input2: BigNumberish,
Expand Down
Loading