Welcome to EOSFactory’s documentation!

EOSFactory is a Python-based EOS smart-contract development framework, created by Tokenika. 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.

Tutorials

• Introduction to EOSFactory
• Installing EOSFactory
• Interacting with EOS Contracts in EOSFactory
• Building and Deploying EOS Contracts using EOSFactory
• Working with EOS Contracts using EOSFactory in Visual Studio Code
• Interacting with Public Testnet

Use Cases

• Symbolic Names
• Account Object
• Master Account Object
• Wallet Class

Patterns

• Patterns
• BIOS Boot Sequence
• Set Account Permission
• Set Action Permission

EOSFactory API

• utils

• shell.account
• shell.contract
• shell.wallet

• core.interface
• core.config
• core.errors
• core.setup
• core.logger
• core.teos
• core.cleos
• core.cleos_get
• core.cleos_set
• core.cleos_sys
• core.manager
• core.testnet
• core.utils

Support

For issues not covered in the documentation there is a dedicated EOS Factory Support channel on Telegram.

Release Notes

• EOSFactory Release Notes - v2.4

Roadmap

• Plan for Subsequent EOSFactory Releases
• Long-term EOSFactory Roadmap

Indices and tables

• Index
• Module Index