Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cobraframework/cobra

A fast, flexible and simple development environment framework for Ethereum smart contract, testing and deployment on EVM.
https://github.com/cobraframework/cobra

blockchain compile deploy ethereum framework hdwallet network pytest smart-contracts test unittest

Last synced: 2 months ago
JSON representation

A fast, flexible and simple development environment framework for Ethereum smart contract, testing and deployment on EVM.

Host: GitHub
URL: https://github.com/cobraframework/cobra
Owner: cobraframework
License: other
Archived: true
Created: 2019-07-14T06:21:49.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-12-08T05:56:51.000Z (about 2 years ago)
Last Synced: 2024-11-11T15:07:53.494Z (2 months ago)
Topics: blockchain, compile, deploy, ethereum, framework, hdwallet, network, pytest, smart-contracts, test, unittest
Language: Python
Homepage: https://pypi.org/project/eth-cobra
Size: 728 KB
Stars: 53
Watchers: 5
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-web3-tools-and-dapps - Cobra - Introducing a quick and user-friendly tool for creating and implementing smart contracts on EVM blockchains. (dApps directory / Development Frameworks)
DeFi-Developer-Road-Map - Cobra - A fast, flexible and simple development environment framework for Ethereum smart contract, testing and deployment on Ethereum virtual machine(EVM). (Roadmap)

README

[![Build Status](https://travis-ci.com/cobraframework/cobra.svg?branch=master)](https://travis-ci.com/cobraframework/cobra)
![PyPI Python Version](https://img.shields.io/pypi/pyversions/eth-cobra.svg)
![PyPI License](https://img.shields.io/pypi/l/eth-cobra.svg?color=black)
![PyPI Version](https://img.shields.io/pypi/v/eth-cobra.svg?color=blue)
[![Coverage Status](https://coveralls.io/repos/github/cobraframework/cobra/badge.svg?branch=master)](https://coveralls.io/github/cobraframework/cobra?branch=master)

---

A fast, flexible and simple development environment framework for Ethereum smart contract, testing and
deployment on Ethereum virtual machine(EVM).

With cobra you can get built-in smart contract compilation, linking, deployment, binary management,
automated contract testing with Unittest and PyTest frameworks, scriptable deployment & migrations framework
and network management for deploying to many public & private networks like [INFURA](https://infura.io) or
[Ganache CLI](https://github.com/trufflesuite/ganache-cli).

## Dependency

This library requires the `solc` executable to be present.

Only versions `>=0.4.2` are supported and tested though this library may work
with other versions.

* [solc](http://solidity.readthedocs.io/en/latest/installing-solidity.html): Ethereum solidity compiler.
* [ganache-cli](https://github.com/trufflesuite/ganache-cli): A command-line version of Ethereum blockchain server.
* [pip](https://pypi.org/project/pip/): To install packages from the Python Package Index and other indexes.
* [python3](https://www.python.org/downloads/release/python-368/): version 3.6 or greater.

## Installation
PIP to install cobra globally. For Linux sudo may be required.
```
$ pip install eth-cobra
```

## Development
We welcome pull requests. To get started, just fork this repo, clone it locally, and run:
```
$ pip install -e . -r requirements.txt
```

## Quick Usage

Initialize project structure

A default set of contract and tests, run the following command:

```
$ cobra init
```

Get help:

```
$ cobra --help
```

From there, you can run `cobra compile`, `cobra deploy/migrate` and `cobra test --unittest/--pytest`
to compile your contracts, deploy those contracts to the network, and run their associated unit tests.

advanced cobra.yaml

```yaml
compile:
solidity_path: "./contracts" # global
artifact_path: "./build/contracts"
contracts: [
contract: {
solidity: "Contract.sol",
solidity_path: "./contracts/libs", # detail
import_remappings: [
"=/path/folder/contracts/"
],
allow_paths: [
"/path/folder/contracts/"
]
}
]

deploy:
artifact_path: "./build/contracts/"
contracts: [
contract: {
artifact: "Contract.json",
links: ["Contract.json"]
}
]

test:
artifact_path: "./build/contracts/"
test_paths: ["./tests"]
contracts: [
contract: {
artifact: "Contract.json",
links: ["Contract.json"]
}
]

network:
development: {
url: "https://ropsten.infura.io/...",
# host: "localhost",
# port: 8545,
hdwallet: {
mnemonic: "decide adjust legend nation type same task aim rigid lucky guilt close", # or
seed: "decide adjust legend nation type same task aim rigid lucky guilt close",
password: "meherett",
private: "5f8935bb3b61b312ba1114cbf6f1ea30102383f2b043a1b213aa482132d25049",
gas: 3000000,
gas_price: 1000000
},
protocol: "HTTPS", # HTTP, HTTPS, WS(WebSocket) and ICP
# account: {
# address: "0x6a373a75c388ac2d160f1d2b6d9ada34f29831cd",
# gas: 3000000,
# gas_price: 1000000
# }
}
```

## Testing
Tests are still under development.

You can run the tests with:

```
$ pytest tests
```

Or use `tox` to run the complete suite against the full set of build targets, or pytest to run specific
tests against a specific version of Python.

## Contributing
Feel free to open an issue if you find a problem, or a pull request if you've solved an issue.

## Meta

Meheret Tesfaye – [@meherett](https://github.com/meherett) – [email protected]

Distributed under the MIT license. See ``LICENSE`` for more information.

[https://github.com/meherett](https://github.com/meherett)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details