Socket
Socket
Sign inDemoInstall

@truffle/db

Package Overview
Dependencies
547
Maintainers
9
Versions
160
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @truffle/db

Smart contract data aggregation


Version published
Weekly downloads
12K
increased by0.38%
Maintainers
9
Created
Weekly downloads
 

Readme

Source

@truffle/db

Truffle DB is a complete, flexible system for the querying and mutation of Truffle’s smart contract records. Following the data model available here, Truffle DB persists smart contract information that is typically found in a project's artifacts, and allows for querying this data using GraphQL.


Truffle artifacts are currently stored as JSON files in a project’s build/contracts/ directory. These documents are currently the canonical source of information about a project’s smart contracts. While useful, artifacts can be limited for certain advanced use cases.


For example, the artifacts format expects contracts with unique names. This means that currently a developer is unable to keep two contracts in their project that have the same name. Truffle DB solves this problem with a name record-keeping system that can keep track of multiple contracts in this situation.

Built With

Truffle DB is built with:

  • TypeScript
  • GraphQL
  • Apollo
  • PouchDB

Configuration to enable Truffle DB

Add the following to your truffle-config.js file in order to enable Truffle DB

db: {
  enabled: true
}

Note: Enabling Truffle DB does not affect artifacts, but will produce a new .db directory when you compile or migrate your project.

It will soon be possible to load and access Truffle DB data via truffle compile and truffle migrate. Stay tuned!

Usage

const { connect } = require("@truffle/db")

License

MIT

Keywords

FAQs

Last updated on 13 Sep 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc