https://github.com/ChainSafe/truffle-plugin-abigen

Truffle plugin to post-process contracts for go-ethereum's abigen
https://github.com/ChainSafe/truffle-plugin-abigen

Last synced: 3 months ago
JSON representation

Truffle plugin to post-process contracts for go-ethereum's abigen

• Host: GitHub
• URL: https://github.com/ChainSafe/truffle-plugin-abigen
• Owner: ChainSafe
• License: other
• Created: 2020-02-09T23:28:10.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-01T12:56:39.000Z (11 months ago)
• Last Synced: 2024-07-13T10:28:18.085Z (4 months ago)
• Language: Solidity
• Homepage:
• Size: 289 KB
• Stars: 15
• Watchers: 6
• Forks: 6
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# truffle-plugin-abigen

This truffle plugin generates the required files needed to use Geths [abigen](https://github.com/ethereum/go-ethereum/wiki/Native-DApps:-Go-bindings-to-Ethereum-contracts) to generate contract bindings in golang.

## Installation

1. Install the plugin with npm

    ```sh

    npm install @chainsafe/truffle-plugin-abigen

    ```

2. Add the plugin to your `truffle.js` or `truffle-config.js` file

    ```js

    module.exports = {

      /* ... rest of truffle-config */

      plugins: [

        "@chainsafe/truffle-plugin-abigen"

      ]

    }

    ```

## Usage

Before running ensure that you've compiled your contracts:

```sh

truffle compile

```

To generate specific contract bindings:

```sh

truffle run abigen SomeContractName AnotherContractName

```

Alternatively, to generate bindings for all your contracts:

```sh

truffle run abigen

```

### Debugging

You can pass an optional `--debug` flag into the plugin to display debug messages during the verification process. This is generally not necessary, but can be used to provide additional information when the plugin appears to malfunction.