Tech debt: Add types for contracts by mmv08 · Pull Request #1118 · 5afe/safe-react

mmv08 · 2020-07-16T08:09:31Z

This PR:

Adds typechain for Gnosis Safe contracts
Adds typings/small refactor of Stepper component because I couldn't get it to compile because of type errors
Some more type improvements
Remove memoization of getGnosisSafeInstance because it doesn't really work how it should: when we call it the first time, it gets initialized with readonly web3.js which cannot be used for sending transactions, memoization should be also dependent on web3 object we have, not only safeAddress

TODO

remove truffle-contract dependency, currently we have a mix of web3 contracts/truffle contracts, we should go with only web3.js and remove truffle (should shave off ~1mb of bundle size)
think of a better solution for getGnosisSafeInstance
add types for other contracts (tokens, etc)

I will create issues for all the todos, the PR is quite large so I decided to leave it on this stage

ghost · 2020-07-16T08:23:23Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-16T12:41:27Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-16T13:57:13Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-16T15:02:14Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-16T16:25:31Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-17T11:43:12Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-17T11:59:21Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-17T12:15:22Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-17T14:04:36Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

github-actions · 2020-07-21T12:04:09Z

ESLint Summary View Full Report

Annotations are provided inline on the Files Changed tab. You can also see all annotations that were generated on the annotations page.

Type	Occurrences	Fixable
Errors	0	0
Warnings	52	0
Ignored	4	N/A

Result: ✅ success
Annotations: 52 total

[warning] @typescript-eslint/explicit-module-boundary-types

Require explicit return and argument types on exported functions' and classes' public class methods

src/logic/addressBook/store/reducer/addressBook.ts Line 17 - Missing return type on function.
src/logic/addressBook/store/reducer/addressBook.ts Line 17 - Argument 'storedAdbk' should be typed.
src/logic/safe/utils/upgradeSafe.ts Line 52 - Argument 'createTransaction' should be typed.
src/routes/load/components/DetailsForm/index.tsx Line 45 - Argument 'values' should be typed.
src/routes/load/components/OwnerList/index.tsx Line 159 - Object pattern argument should be typed.
src/routes/load/components/OwnerList/index.tsx Line 159 - Argument 'network' should be typed.
src/routes/load/components/OwnerList/index.tsx Line 159 - Missing return type on function.
src/routes/load/components/OwnerList/index.tsx Line 159 - Argument 'controls' should be typed.
src/routes/load/components/OwnerList/index.tsx Line 159 - Object pattern argument should be typed.
src/routes/open/components/Layout.tsx Line 69 - Missing return type on function.
src/routes/open/components/Layout.tsx Line 69 - Argument 'props' should be typed.
src/routes/open/container/Open.tsx Line 48 - Missing return type on function.
src/routes/open/container/Open.tsx Line 48 - Argument 'safeAddress' should be typed.
src/routes/open/container/Open.tsx Line 48 - Argument 'safeName' should be typed.
src/routes/open/container/Open.tsx Line 48 - Argument 'ownersNames' should be typed.
src/routes/open/container/Open.tsx Line 48 - Argument 'ownerAddresses' should be typed.
src/routes/open/container/Open.tsx Line 56 - Missing return type on function.
src/routes/open/container/Open.tsx Line 56 - Argument 'values' should be typed.
src/routes/open/container/Open.tsx Line 56 - Argument 'userAccount' should be typed.
src/routes/safe/components/Balances/SendModal/screens/SendFunds/index.tsx Line 51 - Missing return type on function.
src/routes/safe/components/Balances/SendModal/screens/SendFunds/index.tsx Line 51 - Object pattern argument should be typed.
src/routes/safe/components/Settings/ManageOwners/AddOwnerModal/index.tsx Line 28 - Missing return type on function.
src/routes/safe/components/Settings/ManageOwners/AddOwnerModal/index.tsx Line 28 - Argument 'values' should be typed.
src/routes/safe/components/Settings/ManageOwners/AddOwnerModal/index.tsx Line 28 - Argument 'safeAddress' should be typed.
src/routes/safe/components/Settings/ManageOwners/AddOwnerModal/index.tsx Line 28 - Argument 'ownersOld' should be typed.
src/routes/safe/components/Settings/ManageOwners/AddOwnerModal/index.tsx Line 28 - Argument 'enqueueSnackbar' should be typed.
src/routes/safe/components/Settings/ManageOwners/AddOwnerModal/index.tsx Line 28 - Argument 'closeSnackbar' should be typed.
src/routes/safe/components/Settings/ManageOwners/AddOwnerModal/index.tsx Line 28 - Argument 'dispatch' should be typed.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 30 - Missing return type on function.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 31 - Argument 'values' should be typed.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 32 - Argument 'safeAddress' should be typed.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 33 - Argument 'ownerAddressToRemove' should be typed.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 34 - Argument 'ownerNameToRemove' should be typed.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 35 - Argument 'ownersOld' should be typed.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 36 - Argument 'enqueueSnackbar' should be typed.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 37 - Argument 'closeSnackbar' should be typed.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 38 - Argument 'threshold' should be typed.
src/routes/safe/components/Settings/ManageOwners/RemoveOwnerModal/index.tsx Line 39 - Argument 'dispatch' should be typed.
src/routes/safe/components/Settings/ManageOwners/ReplaceOwnerModal/index.tsx Line 26 - Missing return type on function.
src/routes/safe/components/Settings/ManageOwners/ReplaceOwnerModal/index.tsx Line 27 - Argument 'values' should be typed.
src/routes/safe/components/Settings/ManageOwners/ReplaceOwnerModal/index.tsx Line 28 - Argument 'safeAddress' should be typed.
src/routes/safe/components/Settings/ManageOwners/ReplaceOwnerModal/index.tsx Line 29 - Argument 'ownerAddressToRemove' should be typed.
src/routes/safe/components/Settings/ManageOwners/ReplaceOwnerModal/index.tsx Line 30 - Argument 'enqueueSnackbar' should be typed.
src/routes/safe/components/Settings/ManageOwners/ReplaceOwnerModal/index.tsx Line 31 - Argument 'closeSnackbar' should be typed.
src/routes/safe/components/Settings/ManageOwners/ReplaceOwnerModal/index.tsx Line 32 - Argument 'threshold' should be typed.
src/routes/safe/components/Settings/ManageOwners/ReplaceOwnerModal/index.tsx Line 33 - Argument 'dispatch' should be typed.
src/routes/safe/store/actions/processTransaction.ts Line 25 - Object pattern argument should be typed.
src/routes/safe/store/actions/processTransaction.ts Line 33 - Missing return type on function.
src/routes/safe/store/actions/processTransaction.ts Line 33 - Argument 'dispatch' should be typed.
src/routes/safe/store/actions/processTransaction.ts Line 33 - Argument 'getState' should be typed.
src/store/index.ts Line 88 - Missing return type on function.
src/store/index.ts Line 88 - Argument 'localState' should be typed with a non-any type.

^{Report generated by eslint-plus-action}

…debt/add-typechain

…t into tech-debt/add-typechain

ghost · 2020-07-30T10:29:13Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-30T10:32:12Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-30T10:35:43Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-30T10:42:21Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

src/logic/safe/transactions/gasNew.ts

fernandomg · 2020-07-30T19:30:20Z

src/routes/safe/components/Balances/SendModal/screens/SendFunds/index.tsx

-        validation={(values) => {
-          const selectedTokenRecord = tokens.find((token) => token.address === values?.token)
-
-          return {
-            amount: maxValue(selectedTokenRecord?.balance)(values.amount),
-          }


what happened here?

this looked like code duplication https://github.com/gnosis/safe-react/blob/b28ad26af546cf4e5bb95fb88d7ebe59d6990d5a/src/routes/safe/components/Balances/SendModal/screens/SendFunds/index.tsx#L233

it's working fine without this double validation

src/test/getEncodedMultiSendCallData.ts

ghost · 2020-07-30T20:13:21Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-31T10:30:34Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-31T10:31:21Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-31T10:33:24Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-31T11:34:37Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

Agupane

Good Job!

ghost · 2020-07-31T22:17:04Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

ghost · 2020-07-31T22:24:24Z

Travis automatic deployment:
https://pr1118--safereact.review.gnosisdev.com/app

typechain wip

9a0cc02

mmv08 added the Tech-debt 🚧 Technical debt label Jul 16, 2020

add types for multisend

851e8d6

type definitions improvements

6145f14

type safe contract in estimateTxGasCosts

ebdd0dc

contract type definitions wip

c5460b6

SafeInstance truffle -> web3 migration

b558bb0

fix calls for version

c5bd48a

transactions/send enhancements

78b5fe9

fix safe recor owner type

f9738ec

mmv08 added 6 commits July 17, 2020 19:34

Stepper type definitions wip

a44a9c2

pull from dev

2029cd5

dep bump

c9fcd01

stepper types wip

b5e6251

refactoring stepper component to fix bug in load safe form

30ec40a

Merge branch 'development' into tech-debt/add-typechain

0a7e430

mmv08 added 2 commits July 21, 2020 18:50

stepper types wip, addressbook reducer types wip

c799b05

finally make it work

71b9841

mmv08 mentioned this pull request Jul 21, 2020

Fix - Owners list error #1127

Merged

Merge branch 'development' of github.com:gnosis/safe-react into tech-…

b1dcbda

…debt/add-typechain

mmv08 added 2 commits July 30, 2020 14:21

abiITem -> AbiItem[]

fccb517

Merge branch 'tech-debt/add-typechain' of github.com:gnosis/safe-reac…

22bfd0b

…t into tech-debt/add-typechain

fix safeVersion utils tests

b28ad26

fernandomg reviewed Jul 30, 2020

View reviewed changes

src/logic/safe/transactions/gasNew.ts Show resolved Hide resolved

fernandomg reviewed Jul 30, 2020

View reviewed changes

src/logic/safe/transactions/gasNew.ts Show resolved Hide resolved

fernandomg reviewed Jul 30, 2020

View reviewed changes

src/test/getEncodedMultiSendCallData.ts Outdated Show resolved Hide resolved

Merge branch 'development' into tech-debt/add-typechain

ced1961

mmv08 added 3 commits July 31, 2020 14:16

fix imports, put upgradeSafe test close to the actual code

4622d93

add comment about ts-ignore usage

9ed58e0

Merge branch 'development' into tech-debt/add-typechain

483facb

mmv08 requested a review from fernandomg July 31, 2020 10:22

Merge branch 'development' into tech-debt/add-typechain

6bf35d2

fernandomg approved these changes Jul 31, 2020

View reviewed changes

Merge branch 'development' into tech-debt/add-typechain

23cfa02

Agupane approved these changes Jul 31, 2020

View reviewed changes

downgrade web3 version

74dc33f

mmv08 merged commit 86cbd94 into development Jul 31, 2020

mmv08 deleted the tech-debt/add-typechain branch July 31, 2020 22:26

Conversation

mmv08 commented Jul 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Jul 16, 2020

Uh oh!

ghost commented Jul 16, 2020

Uh oh!

ghost commented Jul 16, 2020

Uh oh!

ghost commented Jul 16, 2020

Uh oh!

ghost commented Jul 16, 2020

Uh oh!

ghost commented Jul 17, 2020

Uh oh!

ghost commented Jul 17, 2020

Uh oh!

ghost commented Jul 17, 2020

Uh oh!

ghost commented Jul 17, 2020

Uh oh!

github-actions bot commented Jul 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ESLint Summary View Full Report

[warning] @typescript-eslint/explicit-module-boundary-types

Uh oh!

ghost commented Jul 30, 2020

Uh oh!

ghost commented Jul 30, 2020

Uh oh!

ghost commented Jul 30, 2020

Uh oh!

ghost commented Jul 30, 2020

Uh oh!

Uh oh!

Uh oh!

fernandomg Jul 30, 2020

Choose a reason for hiding this comment

Uh oh!

mmv08 Jul 30, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ghost commented Jul 30, 2020

Uh oh!

ghost commented Jul 31, 2020

Uh oh!

ghost commented Jul 31, 2020

Uh oh!

ghost commented Jul 31, 2020

Uh oh!

ghost commented Jul 31, 2020

Uh oh!

Agupane left a comment

Choose a reason for hiding this comment

Uh oh!

ghost commented Jul 31, 2020

Uh oh!

ghost commented Jul 31, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mmv08 commented Jul 16, 2020 •

edited

Loading

github-actions bot commented Jul 21, 2020 •

edited

Loading