Truffle overview

A world class development environment, testing framework and asset pipeline for blockchains using the PlatON Virtual Machine (EVM), aiming to make life as a developer easier. With Truffle, you get:

• Built-in smart contract compilation, linking, deployment and binary management.
• Automated contract testing for rapid development.
• Scriptable, extensible deployment & migrations framework.
• Network management for deploying to any number of public & private networks.
• Interactive console for direct contract communication.
• Configurable build pipeline with support for tight integration.
• External script runner that executes scripts within a Truffle environment.

Truffle document content

Truffle document contains 5 parts: Quick Start, Basic Functions, Writing Test Cases, Advanced Usage, References, The following is an outline:

• Truffle QuickStart
  • Creating a project
  • Exploring the project
  • Testing
  • Compiling
  • Migrating
  • Interacting with the contract
  • Continue learning

Getting-started

• Installation
  • Install nodejs
  • Install platon-truffle
  • problems
  • Requirements
• Creating a project
• Compiling Contracts
  • Location
  • Command
  • Build artifacts
  • Dependencies
• Running migrations
  • Command for solidity
  • Migration files
  • Initial migration
  • Deployer
  • Network considerations
  • Available accounts
  • Deployer API
  • Command for wasm
• Interacting with your contracts
  • Introduction
  • Reading and writing data
  • Introducing abstractions
  • Executing contract functions
  • Special methods on Truffle contract objects
  • Further reading
• Using platon-truffle console
  • Why console?
  • Commands
  • Features
• Writing external scripts
  • Command
  • File structure

Testing

• Testing your contracts
  • Framework
  • Location
  • Command
• Writing solidity contract tests in javascript
  • Use contract() instead of describe()
  • Use contract abstractions within your tests
  • Using artifacts.require()
  • Using web3
  • Examples
  • Specifying tests
  • TypeScript File Support
• Writing wasm contract tests in javascript
  • Use contract() instead of describe()
  • Using global contract object
  • Using web3
  • Examples
  • Specifying contract
• Writing test in solidity
  • Example
  • Test structure
  • Advanced features

Advanced

• Networks and APP deployment
  • Configuration
  • Specifying a network
  • Specifying a wasm contract
  • Build artifacts
  • Application deployment
• Build Processes
  • Running an external command
  • Providing a custom function
  • Creating a custom module
  • Bootstrapping your application

Reference

• Configuration
  • Location
  • General options
  • Compiler configuration
• Contract abstractions
  • Usage
• API
  • Contract Abstraction API
  • Contract Instance API
• Truffle commands
  • Usage
  • Available commands