Brownie

• Overview
  • Features
• Quickstart
  • Creating a New Project
  • Exploring the Project
  • Compiling your Contracts
  • Core Functionality
  • Writing Scripts
  • Testing your Project

Getting Started

• Installing Brownie
  • Other Installation Methods
  • Dependencies
• Creating a New Project
  • Creating an Empty Project
  • Creating a Project from a Template
• Structure of a Project
  • contracts/
  • interfaces/
  • scripts/
  • tests/
• Compiling Contracts
  • Supported Languages
  • Interfaces
  • Compiler Settings
  • Installing the Compiler
• Interacting with your Contracts
  • Using the Console
  • Writing Scripts
  • Writing Tests
• Brownie Package Manager
  • Installing a Package
  • Working with Packages
  • Using Packages in your Project
• The Brownie GUI
  • Getting Started
  • Working with Opcodes
  • Viewing Reports
  • Report JSON Format

Core Functionality

• Working with Accounts
  • Broadcasting Multiple Transactions
• Working with Contracts
  • Deploying Contracts
  • Interacting with your Contracts
  • Contracts Outside of your Project
• Interacting with the Blockchain
  • Accessing Block Information
  • Accessing Transaction Data
  • Manipulating the Development Chain
• Inspecting and Debugging Transactions
  • Event Data
  • Internal Transactions and Deployments
  • Debugging Failed Transactions
  • Inspecting the Trace
• Data Types
  • Wei
  • Fixed

Testing

• Writing Unit Tests
  • Getting Started
  • Fixtures
  • Handling Reverted Transactions
  • Parametrizing Tests
  • Testing against Other Projects
  • Running Tests
• Pytest Fixtures Reference
  • Session Fixtures
  • Contract Fixtures
  • Isolation Fixtures
  • Coverage Fixtures
• Property-Based Testing
  • What is Property-Based Testing?
  • Writing Tests
  • Strategies
  • Settings
• Stateful Testing
  • Rule-based State Machines
  • Test Execution Sequence
  • Writing Stateful Tests
  • Running Stateful Tests
• Coverage Evaluation
  • Viewing Coverage Data
  • How Coverage Evaluation Works
  • Improving Performance
• Security Analysis with MythX
  • Authentication
  • Scanning for Vulnerabilities
  • Viewing Analysis Results

Networks and Deployment

• Deployment Basics
  • Writing a Deployment Script
  • Running your Deployment Script
  • The Deployment Map
  • Interacting with Deployed Contracts
  • Saving Deployments on Development Networks
• Network Management
  • Network Configuration
  • Launching and Connecting
  • Live Networks
  • Using a Forked Development Network
• Account Management
  • Generating a New Account
  • Importing from a Private Key
  • Importing from a Keystore
  • Exporting a Keystore
  • Unlocking Accounts
  • Unlocking Accounts on Development Networks

Reference

• The Configuration File
  • Default Configuration
  • Settings
• The Build Folder
  • Compiler Artifacts
  • Deployment Artifacts
  • Test Results and Coverage Data
  • Installed ethPM Package Data
• Brownie as a Python Package
  • Loading a Project
  • Loading Project Config Settings
  • Accessing the Network
• Brownie API
  • brownie
  • brownie.convert
  • brownie.network
  • brownie.project
  • brownie.test
  • brownie.utils