Truffle DB - Proposal

This document serves to aid in discussion towards the goal of improving Truffle’s record-keeping of smart contracts. More specifically, this document presents a proposal for a new core component to manage a Truffle project’s persisted artifact files and to enable intuitive and robust querying thereof.

The primary goals for this component are:

0. Don’t lose any relevant data about a project’s smart contracts or their deployed instances.
1. Provide a flexible interface for reading and writing persisted information about smart contracts.
2. Maintain backwards compatibility with Truffle’s existing record-keeping.

At its core, Truffle DB seeks to provide a GraphQL interface for accessing project smart contract information.

Contents:

• Background
  • What are “Artifacts”?
  • Truffle’s Architecture
• Glossary
  • Notes
• Requirements
  • Use Cases Overview
  • Use Cases
• Data Model
  • Projects and Named Resources
  • Data Model Resources
  • Combined Data Model
• Software Design
  • Interface Compatibility
  • Artifact Compatibility

Indices and tables

• Index
• Module Index
• Search Page