https://github.com/deno-web3/sol_build

🏗 Compile Solidity smart contracts with Deno
https://github.com/deno-web3/sol_build

deno ethereum solidity web3

Last synced: about 1 month ago
JSON representation

🏗 Compile Solidity smart contracts with Deno

• Host: GitHub
• URL: https://github.com/deno-web3/sol_build
• Owner: deno-web3
• License: mit
• Created: 2021-10-18T22:07:56.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-04T11:37:49.000Z (about 1 year ago)
• Last Synced: 2024-01-04T12:37:16.565Z (about 1 year ago)
• Topics: deno, ethereum, solidity, web3
• Language: TypeScript
• Homepage: https://deno.land/x/sol_build
• Size: 75.2 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


# sol_build

[![][code-quality-img]][code-quality] [![][docs-badge]][docs]



Compile Solidity smart contracts with Deno.

## Getting Started

Deno >=v1.25 is required.

To install `sol_build` globally run:

```sh

deno install --allow-read --allow-write --allow-net -f https://deno.land/x/sol_build/cli.ts

```

Initialize a new project with a sample `hello.sol` contract:

```sh

sol_build init helloworld

# Initializing a new project

# Fetching releases...

# Downloading soljson from https://solc-bin.ethereum.org/bin/soljson-v0.8.19+commit.7dd6d404.js...

cd helloworld

```

Compile all Solidity files and produce [Hardhat](https://github.com/NomicFoundation/hardhat)-compatible artifacts with ABIs, EVM bytecode and more:

```sh

sol_build compile

```

If you only need ABIs, pass the `--abi` option.

To run optimizations, pass the `--optimizer ` flag. 

## Configuration

You can pass a custom config as a file with `sol_build -c sol.config.ts` if you need more flexible settings:

```ts

import type { Config } from 'https://deno.land/x/sol_build/config.ts'

export const config = {

  abi: true, // only produce ABIs

  // all solidity settings go here

}

```

CLI arguments have a higher priority over config except for `outputSelection` setting.

## Programmatic use

`sol_build` exports functions for finding, linking and compiling Solidity files.

```ts

import { compileToFs } from 'https://deno.land/x/sol_build/mod.ts'

import { createRequire } from 'https://deno.land/[email protected]/node/module.ts'

const require = createRequire(import.meta.url)

const solc = solc = wrapper(require('./.solc.js'))

await compileToFs(solc, { optimizer: { enabled: true, runs: 200 }})

```

[code-quality-img]: https://img.shields.io/codefactor/grade/github/deno-web3/sol_build?style=for-the-badge&color=626890&

[code-quality]: https://www.codefactor.io/repository/github/deno-web3/sol_build

[docs-badge]: https://img.shields.io/github/v/release/deno-web3/sol_build?label=Docs&logo=deno&style=for-the-badge&color=626890

[docs]: https://doc.deno.land/https/deno.land/x/sol_build/mod.ts