EOSFactory is a Python-based EOS smart-contract development & testing framework, created by Tokenika.
The goal is to achieve a similar functionality to Ethereum's Truffle Framework.
With a single command-line interface you can create a private testnet and then compile, unit-test and deploy EOS smart-contracts.
All of this using simple yet powerful Python3 syntax.
Undoubtedly, everything that EOSFactory offers can be done with the official EOSIO toolset, i.e. cleos and eosiocpp. Does it make EOSFactory just a simple alternative to those tools? Not really.
Try to go through EOS tutorials based on cleos and you'll see how much concentration is required to follow those simple examples without making a single mistake. And now imagine doing it 10 or 100 times. Surely, it's a daunting task!
Code development and unit-testing involve tasks that need to be executed hundreds of times, and each time in exactly the same way and exactly the same context. Therefore those tasks need to be fully automated, as otherwise a lot of time is being wasted and, what’s even worse, a lot of additional uncertainty is introduced. Manually performed actions are prone to errors.
And this is what EOSFactory actually brings to the table: an easy & intuitive way to automate the process of dealing with smart-contracts. Write down, in the form of a Python script, what needs to be done multiple times in exactly the same way and exactly the same context, and then just run the script. EOSFactory will take care of everything else: it will compile your smart-contract, create a new testnet, deploy the contract, invoke its methods and verify the response, then tear down the testnet, and finally report the results. And all of this done in a couple of seconds.
When you use tools like cleos all you have at your disposal is issuing separate, one-off commands, as cleos is not able to keep your state. Thus each time you interact with a contract, you need to tell cleos which contract and which account you mean. Contrary to that, in EOSFactory everything is an object. You create a contract (or an account), keep reference to it and then invoke its various methods.
The front-end of EOSFactory is simply a Python3 Command Line Interface. This way you can interact with EOS smart-contract, and prove it works as expected, without having to deal with the complexity of a low-level language like C++. In most cases Python’s syntax is clear for everyone.
As EOS full node is very quick we don’t need to rely on a testnet simulator similar to TestRPC in Ethereum. Instead, we can work with a real testnet and this makes unit-tests much more reliable. Thus EOSFactory has the ability to launch and tear down an EOS testnet in a very efficient way, so that you can fully test your smart-contract in a couple of seconds and do it multiple times.
We make sure everything we do is fully compatible with Windows - our toolset enables you to run an EOS node and interact with it on any operating system, including Windows, MacOS and Linux.
EOSFactory is composed of three layers:
- C++ client (i.e.
cleos) connected to an EOS node (i.e.nodeos) running a private or public testnet, - C++ bridge (i.e.
teos) for functionalities not supported bycleos, - Python wrapper acting as a convenient human-oriented interface.
Using Python will allow us to build interactive tutorials for EOS smart-contracts.
- Introduction to EOSFactory
- Installing EOSFactory
- Interacting with EOS Contracts in EOSFactory
- Building and deploying EOS Contracts in EOSFactory
- Working with EOS Contracts using EOSFactory in VSC
- Interacting with Public Testnet
Please refer to this index of Python modules which constitute the front-end of EOSFactory.
Please refer to this document.
As of the v1.1 release, EOSFactory is a production-ready system, which means it can be used for working with real-life smart-contracts.
Both local (private) testnets and remote (public) testnets are supported. Theoretically you could even use it on the EOS mainnet, even though it's not recommended at this stage for security reasons.
After v1.1 has been released, our current focus is mainly on stabilizing the code, collecting feedback from users and improving UX.
Our long-term goal is to turn EOSFactory into a comprehensive IDE (Integrated Development Environment) for EOS smart-contracts, similar to Ethereum's Truffle Framework.
This code is provided as is, under MIT Licence.