aitrean/typ3

typ3's Issues

Clean up codebase

With all of the abstractions and typings in the repo, a production release will need to look tidier than what we currently have. This will include

• Code commenting for all functions

• Organized declaration files for all of the interfaces and typings

• Reviewing the structure of our functions and whether our abstractions need to be reorganized.

Support RawTx Creation

Right now, the ConnectedContract's methods directly send a transaction with the unlocked account specified in the txObj. This implies we'd have to sign each account on the node we want to use.

Ideally, the ConnectedContract proxy should be able to infer whether to generate a rawTx or directly send a Tx by checking if the txObj has specified a "from" field. If from is not specified, return a raw sendTx object to be signed outside the scope of typ3 and passed through a node. If from is specified, call eth_sendTx directly (this is the functionality we currently support).

Implement fallback function support.

Currently do not have logic for fallback calls integrated. Make sure to implement.

Add Event Handling

Implement event filtering as an abstraction of the contract's filter objects.

Update tsconfig/tslint

Update tsconfig to use stricter checks

Dynamic Testing Around Sol Files

Right now, testing packages Solidity files with their bytecode and abis that are manually compiled outside of the test process. It would be useful to integrate solc and typ3-cli into the automated testing process, so that changes to the Solidity files would automatically reflect in their corresponding abis/bytecode.

Implement new solidity return types

Currently the ABI experimentally supports struct and dynamic array return types, along with view and pure constant type functions. These need to eventually be accounted for

Merge typ3 and typ3-cli

Ideally, typ3 and typ3-cli should come as one module which supports both the cli and the package behaviour of both. Should merge both repos into one module and publish to npm.

Remaining Productionization Tasks Checklist

List of tasks that need to be finished before typ3 supports the full set of contract, filter, and node functionality.

• #2 Add event handling
• #7 Support raw transaction creation for signing.
• #9 Clean up codebase
• #11 Function Overloading
• #12 Fallback Support

Finish Implementation for Function Overloading

Finish writing the implementation for interpreting overloaded functions by queue-ing multiple definitions in a bucket.

Implement run-time validation of parameters

Implement better run-time validation of parameters in regards to supplied parameters. (Ex. Validate addresses, type QUANTITY / UNFORMATTED data according to Ethereum's ABI and JSON-RPC spec.

Expose mapping function for JSON-RPC methods

Expose a parameter to the user to do mapping of JSON-RPC methods before it is used for node. This would allow for custom JSON-RPC methods to be used and existing ones to be transformed via mapping function.