# truffle-artifactor

> A contract packager for Ethereum and Javascript

Latest version **4.0.30** (published 2019-08-29) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install truffle-artifactor
pnpm add truffle-artifactor
yarn add truffle-artifactor
bun add truffle-artifactor
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 4.0.30 |
| Published | 2019-08-29 |
| First published | 2017-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 25 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13899 |
| Author | Tim Coulter |
| Maintainers | cruzmolina, davidmurdoch, eggplantzzz, fainashalts, gnidan, haltman, seesemichaelj, tcoulter |

## Links

- npm: https://www.npmjs.com/package/truffle-artifactor
- Repository: https://github.com/trufflesuite/truffle/tree/master/packages/truffle-artifactor
- npm.io page: https://npm.io/package/truffle-artifactor

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.17.13
- [fs-extra](https://npm.io/package/fs-extra.md) 6.0.1
- [@truffle/contract-schema](https://npm.io/package/@truffle/contract-schema.md) ^3.0.14

## Recent versions

- 4.0.30 (latest) — 2019-08-29
- 3.0.9 (v4) — 2019-08-29
- 4.1.0-ens-events.1 (ens-events) — 2019-08-20
- 4.0.24-ens.0 (ens) — 2019-07-15
- 4.0.16-alpha.1 (unbundled-solc) — 2019-05-28
- 4.0.16-alpha.0 (cruz/unbundled-solc) — 2019-05-17
- 4.0.0-beta.2 (beta) — 2018-11-21
- 4.0.29 — 2019-08-22
- 4.0.28 — 2019-08-15
- 4.0.27 — 2019-08-08
- 4.0.26 — 2019-07-31
- 4.0.25 — 2019-07-25
- 4.0.24 — 2019-07-18
- 4.0.23 — 2019-07-11
- 4.0.22 — 2019-07-02
- … 47 more at https://npm.io/package/truffle-artifactor/versions

## README

# truffle-artifactor

This package saves contract artifacts into JSON files

```javascript
const Artifactor = require("truffle-artifactor");
const artifactor = new Artifactor(__dirname);
artifactor.save({/*...*/}); // => a promise saving MyContract.json to a given destination
```

👏

### Features

* Manages contract ABIs, binaries and deployed addresses, so you don't have to.
* Packages up build artifacts into `.json` files, which can then be included in your project with a simple `require`.
* Manages library addresses for linked libraries.

The artifactor can be used with [truffle-contract](https://github.com/trufflesuite/truffle/tree/develop/packages/truffle-contract), which provides features above and beyond `web3`:

* Synchronized transactions for better control flow: transactions won't be considered finished until you're guaranteed they've been mined.
* Promises. No more callback hell. Works well with `ES6` and `async/await`.
* Default values for transactions, like `from` address or `gas`.
* Returning logs, transaction receipt and transaction hash of every synchronized transaction.

### Install

```
$ npm install truffle-artifactor
```

### Example

Here, we'll generate a `.json` files given a JSON object like [@truffle/contract-schema](https://github.com/trufflesuite/truffle/tree/develop/packages/contract-schema). This will give us a file which we can later `require` into other projects and contexts.

```javascript
const Artifactor = require("truffle-artifactor");
const artifactor = new Artifactor(__dirname);

// See truffle-schema for more info: https://github.com/trufflesuite/truffle/tree/develop/packages/contract-schema
const contractData = {
  contractName: "...",        // String; optional.
  abi: ...,                   // Array; required.
  metadata: "...",            // String; optional.
  bytecode: "...",            // String; optional.
  "x-some-dependency": ...    // String, Number, Object, or Array: optional.
};

artifactor.save(contractData);
// The file ./MyContract.json now exists, which you can
// import into your project like any other Javascript file.
```

# API

#### `artifactor.save(contractData)`

Save contract data as a `.json` file. Returns a Promise.

* `contractData`: Object. Data that represents this contract:

    ```javascript
    {
      contractName: "MyContract",   // String; optional. Defaults to "Contract".
      abi: ...,                     // Array; required.  Application binary interface.
      metadata: "...",              // String; optional. Contract metadata.
      bytecode: "...",              // String; optional. Contract-creation binary without resolve library links.
      deployedBytecode: "...",      // String; optional. On-chain deployed binary without resolve library links.
      sourceMap: "...",             // String; optional. Source mapping for bytecode.
      deployedSourceMap: "...",     // String; optional. Source mapping for deployedBytecode.
      source: "...",                // String; optional. Uncompiled source code for contract.
      sourcePath: "...",            // String; optional. File path for uncompiled source code.
      ast: ...,                     // Object; optional. JSON representation of contract source code, as output by compiler.
      legacyAST: ...,               // Object; optional. Legacy JSON representation of contract source code, as output by compiler.
      compiler: ...,                // Object; optional. Compiler "type" and "properties".
      networks: ...,                // Object; optional. Mapping of network ID keys to network object values (address information, links to other contract instances, and/or contract event logs).
      schemaVersion: "...",         // String; optional. Schema version used by contract object representation.
      updatedAt: "...",             // String; optional. Time contract object representation was generated/most recently updated.
      devdoc: "...",                // String; optional. Developer documentation.
      userdoc: "...",               // String; optional. User documentation.
      "x-custom-property": ...      // String, Number, Object, or Array: optional. Custom property. Keys must be prefixed with "x-".
    }
    ```

#### `artifactor.saveAll(contracts)`

Save many contracts to the filesystem at once. Returns a Promise.

* `contracts`: Object. Keys are the contract names and the values are `contractData` objects, as in the `save()` function above:

    ```javascript
    {
      "MyContract": {
        "abi": ...,
        "bytecode": "..."
      }
      "AnotherContract": {
        // ...
      }
    }
    ```

### Running Tests

```
$ npm test
```

### License

MIT

---
_Source: https://npm.io/package/truffle-artifactor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._