[C-313] Refactor EthContracts to typescript

[dylanjeffers]

Description

Refactors EthContracts to typescript

Tests

Test pass as before

[jowlee]

Generally not sure between the different of type Wallet from ethereumjs-wallet and type string and when to differentiate the two.
A lot of places don't match the ABIs for type BN vs number - but I'm not sure if that's an issue or if the method should accept both.
Looks great otherwise!

[jowlee]

what is this file?

[dylanjeffers]

oh good call, will uncomment!

[jowlee]

I think this amount is type BN instead of number

[jowlee]

Not sure what the type Wallet exactly is, but I believe this should be able to accept type string for all of these params

[jowlee]

Not sure what BinaryData is, but I believe this is of type Uint8Array or Buffer

[jowlee]

I think string also works here

[jowlee]

I believe value should be BN

[jowlee]

I think owner can be string and value is BN

[jowlee]

Technically, I believe proposalId should be a type BN throughout, but I don't think it'll ever get that big to cause an issue, so int should be fine

[jowlee]

If you want to know how I check these things, you can look at the ABI (Application Binary Interface) that's outputted by the contract compliation step.
We import these ABI to know how to encode methods to send to the RPC node to communicate, but they have the "types" of all the input param and return types.
ie. Looking here: uint256 is technically type BN, address is type string, bytes32 is type Uint8Array, (I'm fairly sure) etc.

audius-protocol/libs/eth-contracts/ABIs/GovernanceUpgraded.json

Lines 389 to 464 in 82bac74

	{
	"constant": true,
	"inputs": [
	{
	"internalType": "uint256",
	"name": "_proposalId",
	"type": "uint256"
	}
	],
	"name": "getProposalById",
	"outputs": [
	{
	"internalType": "uint256",
	"name": "proposalId",
	"type": "uint256"
	},
	{
	"internalType": "address",
	"name": "proposer",
	"type": "address"
	},
	{
	"internalType": "uint256",
	"name": "submissionBlockNumber",
	"type": "uint256"
	},
	{
	"internalType": "bytes32",
	"name": "targetContractRegistryKey",
	"type": "bytes32"
	},
	{
	"internalType": "address",
	"name": "targetContractAddress",
	"type": "address"
	},
	{
	"internalType": "uint256",
	"name": "callValue",
	"type": "uint256"
	},
	{
	"internalType": "string",
	"name": "functionSignature",
	"type": "string"
	},
	{
	"internalType": "bytes",
	"name": "callData",
	"type": "bytes"
	},
	{
	"internalType": "enum Governance.Outcome",
	"name": "outcome",
	"type": "uint8"
	},
	{
	"internalType": "uint256",
	"name": "voteMagnitudeYes",
	"type": "uint256"
	},
	{
	"internalType": "uint256",
	"name": "voteMagnitudeNo",
	"type": "uint256"
	},
	{
	"internalType": "uint256",
	"name": "numVotes",
	"type": "uint256"
	}
	],
	"payable": false,
	"stateMutability": "view",
	"type": "function"
	},

[dylanjeffers]

ahh this is prefect thank you, was just doing best guess

[jowlee]

These should be type BN - ref:

audius-protocol/libs/eth-contracts/ABIs/ServiceTypeManager.json

Lines 115 to 139 in 82bac74

	{
	"constant": false,
	"inputs": [
	{
	"internalType": "bytes32",
	"name": "_serviceType",
	"type": "bytes32"
	},
	{
	"internalType": "uint256",
	"name": "_serviceTypeMin",
	"type": "uint256"
	},
	{
	"internalType": "uint256",
	"name": "_serviceTypeMax",
	"type": "uint256"
	}
	],
	"name": "addServiceType",
	"outputs": [],
	"payable": false,
	"stateMutability": "nonpayable",
	"type": "function"
	},

[dylanjeffers]

Generally not sure between the different of type Wallet from ethereumjs-wallet and type string and when to differentiate the two.

A lot of places don't match the ABIs for type BN vs number - but I'm not sure if that's an issue or if the method should accept both.

Looks great otherwise!

Thanks for the review! updating