CONTRACTS.md

Contracts

Directory Structure

lib
├── abi # abi output from src/
|
├── ethers # ethers contract abstractions codegenned from abis only (no bytecode)
│
├── solidity # the contracts themselves, in .sol form
│
├── truffle  # truffle contract abstractions codegenned from abis + bytecode
|
└── web3  # web3 contract abstractions codegenned from abis + bytecode

Usage

These smart contracts can be imported as a dependency in various ways described below.

Solidity

The solidity smart contracts themselves can simply be imported via the solidity directory of @leovigna/solidity-starter.

import "@leovigna/solidity-starter/solidity/Example.sol";

JSON Artifacts

import ExampleArtifact from '@leovigna/solidity-starter/abi/Example.json';

Ethers

import ExampleEthers from '@leovigna/solidity-starter/ethers/Example';
const example = ExampleEthers.attach(deployed.address).connect(
    new ethers.providers.JsonRpcProvider('http://localhost:8545'),
);

Truffle

import ExampleTruffle from '@leovigna/solidity-starter/truffle/Example';
const example = await ExampleTruffle.new();

Web3

import ExampleWeb3 from '@leovigna/solidity-starter/web3/Example';
const example = ExampleWeb3(web3);