openethereum / pwasm-abi Goto Github PK

View Code? Open in Web Editor NEW

29.0 29.0 17.0 899 KB

Parity WASM Abi (Legacy and new)

License: Apache License 2.0

Rust 100.00%

pwasm-abi's Introduction

OpenEthereum

Fast and feature-rich multi-network Ethereum client.

» Download the latest release «

Description
Technical Overview
Building
3.1 Building Dependencies
3.2 Building from Source Code
3.3 Starting OpenEthereum
Testing
Documentation
Toolchain
Contributing
License

1. Description

Built for mission-critical use: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. OpenEthereum provides the core infrastructure essential for speedy and reliable services.

Clean, modular codebase for easy customisation
Advanced CLI-based client
Minimal memory and storage footprint
Synchronise in hours, not days with Warp Sync
Modular for light integration into your service or product

2. Technical Overview

OpenEthereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing OpenEthereum using the Rust programming language. OpenEthereum is licensed under the GPLv3 and can be used for all your Ethereum needs.

By default, OpenEthereum runs a JSON-RPC HTTP server on port :8545 and a Web-Sockets server on port :8546. This is fully configurable and supports a number of APIs.

If you run into problems while using OpenEthereum, check out the old wiki for documentation, feel free to file an issue in this repository, or hop on our Discord chat room to ask a question. We are glad to help!

You can download OpenEthereum's latest release at the releases page or follow the instructions below to build from source. Read the CHANGELOG.md for a list of all changes between different versions.

3. Building

3.1 Build Dependencies

OpenEthereum requires latest stable Rust version to build.

We recommend installing Rust through rustup. If you don't already have rustup, you can install it like this:

Linux:
```
$ curl https://sh.rustup.rs -sSf | sh
```
OpenEthereum also requires clang (>= 9.0), clang++, pkg-config, file, make, and cmake packages to be installed.
OSX:
```
$ curl https://sh.rustup.rs -sSf | sh
```
clang is required. It comes with Xcode command line tools or can be installed with homebrew.
Windows: Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the rustup installer from https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe, start "VS2015 x64 Native Tools Command Prompt", and use the following command to install and set up the msvc toolchain:
```
$ rustup default stable-x86_64-pc-windows-msvc
```

Once you have rustup installed, then you need to install:

Perl
Yasm

Make sure that these binaries are in your PATH. After that, you should be able to build OpenEthereum from source.

3.2 Build from Source Code

# download OpenEthereum code
$ git clone https://github.com/openethereum/openethereum
$ cd openethereum

# build in release mode
$ cargo build --release --features final

This produces an executable in the ./target/release subdirectory.

Note: if cargo fails to parse manifest try:

$ ~/.cargo/bin/cargo build --release

Note, when compiling a crate and you receive errors, it's in most cases your outdated version of Rust, or some of your crates have to be recompiled. Cleaning the repository will most likely solve the issue if you are on the latest stable version of Rust, try:

$ cargo clean

This always compiles the latest nightly builds. If you want to build stable, do a

$ git checkout stable

3.3 Starting OpenEthereum

Manually

To start OpenEthereum manually, just run

$ ./target/release/openethereum

so OpenEthereum begins syncing the Ethereum blockchain.

Using `systemd` service file

To start OpenEthereum as a regular user using systemd init:

Copy ./scripts/openethereum.service to your systemd user directory (usually ~/.config/systemd/user).
Copy release to bin folder, write sudo install ./target/release/openethereum /usr/bin/openethereum
To configure OpenEthereum, see our wiki for details.

4. Testing

Download the required test files: git submodule update --init --recursive. You can run tests with the following commands:

All packages
```
cargo test --all
```
Specific package
```
cargo test --package <spec>
```

Replace <spec> with one of the packages from the package list (e.g. cargo test --package evmbin).

You can show your logs in the test output by passing --nocapture (i.e. cargo test --package evmbin -- --nocapture)

5. Documentation

Be sure to check out our wiki for more information.

Viewing documentation for OpenEthereum packages

You can generate documentation for OpenEthereum Rust packages that automatically opens in your web browser using rustdoc with Cargo (of the The Rustdoc Book), by running the the following commands:

All packages

cargo doc --document-private-items --open

Specific package

cargo doc --package <spec> -- --document-private-items --open

Use--document-private-items to also view private documentation and --no-deps to exclude building documentation for dependencies.

Replacing <spec> with one of the following from the details section below (i.e. cargo doc --package openethereum --open):

Package List

OpenEthereum Client Application
```
openethereum
```
OpenEthereum Account Management, Key Management Tool, and Keys Generator
```
ethcore-accounts, ethkey-cli, ethstore, ethstore-cli
```
OpenEthereum Chain Specification
```
chainspec
```
OpenEthereum CLI Signer Tool & RPC Client
```
cli-signer parity-rpc-client
```
OpenEthereum Ethash & ProgPoW Implementations
```
ethash
```
EthCore Library
```
ethcore
```
- OpenEthereum Blockchain Database, Test Generator, Configuration, Caching, Importing Blocks, and Block Information
```
ethcore-blockchain
```
- OpenEthereum Contract Calls and Blockchain Service & Registry Information
```
ethcore-call-contract
```
- OpenEthereum Database Access & Utilities, Database Cache Manager
```
ethcore-db
```
- OpenEthereum Virtual Machine (EVM) Rust Implementation
```
evm
```
- OpenEthereum Light Client Implementation
```
ethcore-light
```
- Smart Contract based Node Filter, Manage Permissions of Network Connections
```
node-filter
```
- OpenEthereum Client & Network Service Creation & Registration with the I/O Subsystem
```
ethcore-service
```
- OpenEthereum Blockchain Synchronization
```
ethcore-sync
```
- OpenEthereum Common Types
```
common-types
```
- OpenEthereum Virtual Machines (VM) Support Library
```
vm
```
- OpenEthereum WASM Interpreter
```
wasm
```
- OpenEthereum WASM Test Runner
```
pwasm-run-test
```
- OpenEthereum EVM Implementation
```
evmbin
```
- OpenEthereum JSON Deserialization
```
ethjson
```
- OpenEthereum State Machine Generalization for Consensus Engines
```
parity-machine
```

OpenEthereum Miner Interface

ethcore-miner parity-local-store price-info ethcore-stratum using_queue

OpenEthereum Logger Implementation
```
ethcore-logger
```
OpenEthereum JSON-RPC Servers
```
parity-rpc
```
OpenEthereum Updater Service
```
parity-updater parity-hash-fetch
```

OpenEthereum Core Libraries (util)

accounts-bloom blooms-db dir eip-712 fake-fetch fastmap fetch ethcore-io
journaldb keccak-hasher len-caching-lock memory-cache memzero
migration-rocksdb ethcore-network ethcore-network-devp2p panic_hook
patricia-trie-ethereum registrar rlp_compress stats
time-utils triehash-ethereum unexpected parity-version

6. Toolchain

In addition to the OpenEthereum client, there are additional tools in this repository available:

evmbin - OpenEthereum EVM Implementation.
ethstore - OpenEthereum Key Management.
ethkey - OpenEthereum Keys Generator.

The following tools are available in a separate repository:

ethabi - OpenEthereum Encoding of Function Calls. Docs here
whisper - OpenEthereum Whisper-v2 PoC Implementation.

7. Contributing

An introduction has been provided in the "So You Want to be a Core Developer" presentation slides by Hernando Castano. Additional guidelines are provided in CONTRIBUTING.

Contributor Code of Conduct

CODE_OF_CONDUCT

8. License

LICENSE

pwasm-abi's People

Contributors

Stargazers

Watchers

Forkers

pirapira cheme pzixel 0zand1z scrtlabs oasislabs moriaab lab10-coop daohub-io lxngoddess5321 isabella232 johan-kok

pwasm-abi's Issues

Don't require clients to import crates

The user of the library is required to import bigint and parity-hash crates whenever using the derive.

This should be done automatically by the macro if possible, we should not force users to import something and use extern crate * and then never use it.

Failed to run cargo test

~/dapp/wasm/pwasm-abi > cargo test

   Compiling pwasm-abi v0.1.4 
error[E0463]: can't find crate for `hex`========================>      ] 10/11: pwasm-abi
 --> src/eth/tests.rs:1:1
  |
1 | extern crate rustc_hex as hex;
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ can't find crate

error: aborting due to previous error

For more information about this error, try `rustc --explain E0463`.
error: Could not compile `pwasm-abi`.

To learn more, run the command again with --verbose.

I can't change the optional to false in the Cargo.toml, there will be another issue.

rustc-hex = { version = "1.0", optional = true }

I just get start with pwasm-abi, any hint to fix the test issue?

Update to latest syn

Check negation panic in abi

Resolve default gas passed to call

gaslimit can return U256 in current runtime ?
with 0 (zero) passed call will always fail ?

Contract member variables

It is very unclear whether contract member variables are persistent. Currently, I am having to store all state using explicit load/store opcodes. Ideally, this crate would do this automatically.

Payable functions do not have payable set in JSON ABI

When building a smart contract with a function marked with #[payable], the ABI JSON output by the build does not set payable to true.
Manually editing the JSON after the build seems to give the expected results, but this is quite cumbersome.

As you can see, the commit in which the payable attribute was added (here) did not modify the JSON generation to include the payable attribute.

Make in-repo examples of deriving functions and their variants

Sort H256 proper generation in Solidity

Add support for repr enums

Consider following code:

#[repr(u8)]
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
enum MyEnum
{
	A,
	B,
	C
}

#[eth_abi(TokenEndpoint, TokenClient)]
pub trait SampleContractInterface {
	fn constructor(&mut self, myEnum: MyEnum);
}

Expected result: everything works

Actual result:

error: custom attribute panicked
  --> src\lib.rs:65:5
   |
65 |     #[eth_abi(TokenEndpoint, TokenClient)]
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = help: message: Unable to handle param of type MyEnum: not supported by abi

error: aborting due to previous error

error: Could not compile `pwasm-abstractions-contract`.

pwasm-abi-derive is not compatible with no-std libs

I've tested it with serde, but I'm pretty sure the problem is wider.

Sample code

#![no_std]

extern crate pwasm_ethereum;
#[macro_use]
extern crate serde_derive;
extern crate serde;

Cargo.toml

[package]
name = "pwasm-tutorial-contract"
version = "0.1.0"
authors = ["Alexey Frolov <[email protected]>"]

[dependencies]
pwasm-std = "0.9"
pwasm-ethereum = "0.5"
pwasm-abi = "0.1.2"
pwasm-abi-derive = "0.1.2"
serde_derive = { version = "1.0", default-features = false }
serde = { version = "1.0", default-features = false }

[lib]
crate-type = ["cdylib"]

[profile.release]
panic = "abort"
lto = true
opt-level = "z"

Expected result

everything compiles

Actual result:

$ ./build.sh
   Compiling pwasm-tutorial-contract v0.1.0 (file:///C:/Users/Alex/Documents/Repo/pwasm-tutorial/step-0)
warning: unused `#[macro_use]` import
 --> src\lib.rs:6:1
  |
6 | #[macro_use]
  | ^^^^^^^^^^^^
  |
  = note: #[warn(unused_imports)] on by default

error: duplicate lang item in crate `std`: `panic_impl`.
  |
  = note: first defined in crate `pwasm_std`.

error: duplicate lang item in crate `std`: `oom`.
  |
  = note: first defined in crate `pwasm_std`.

error: aborting due to 2 previous errors

error: Could not compile `pwasm-tutorial-contract`.

P.S.

Combinations that work:

Cargo.toml without pwasm-abi-derive = "0.1.2"
lib.rs without extern crate serde;

Looks like build on `master` is broken

See https://travis-ci.org/paritytech/pwasm-abi/builds/340460927

cannot find type `Vec` in this scope

Using version 0.2 of pwasm-abi-derive like this:

#[eth_abi(TokenEndpoint)]
pub trait TokenInterface {
    /// The constructor
    fn constructor(&mut self, _total_supply: U256);
    /// Total amount of tokens
    fn totalSupply(&mut self) -> U256;
}

Will result in the following error on build (using nightly-2018-11-12):

error[E0412]: cannot find type `Vec` in this scope

The following line in lib.rs of pwasm-abi-derive seems to be the culprit:

use pwasm_abi::types::{H160, H256, U256, Address};

Changing it to include "Vec":

use pwasm_abi::types::{H160, H256, U256, Address, Vec};

fixes the build.

AbiType missing for [u8; 32]

Maybe also for [u8; X<32] with padding?

Example for custom impl of AbiType

Will also check the api consistency

Abi derive should work with anonymous trait function parameters

this works:

#[eth_abi(Endpoint, Client)]
pub trait TestContract {
	fn baz(&mut self, p1: u32);
}

this currently does not:

#[eth_abi(Endpoint, Client)]
pub trait TestContract {
	fn baz(&mut self, u32);
}

More tests for Sink with complex dynamic-sized parameters

Implement fallback functions

I am porting the POA Networks Bridge Contracts from Solidity to Rust. However, the Solidity code makes use of fallback functions in several places, perhaps most notably here. The eth_abi macro doesn’t support fallback functions.

AbiType implementation missing for H256

Naming Endpoint

looks like a bad name

rename to "Handler"? "Dispatcher"?

Bug in impl AbiType for Vec<T>

Version: 0.2.2

According to the spec, Vec<T> should be encoded as enc(k) enc([X[0], ..., X[k-1]]), when k is the length of the Vec<T>. However the current impl encodes it as enc(k, [X[0], ..., X[k-1]]).

WASM-only compact abi

More tests, integrate tests using pwasm-test

Support fixed length array (`[T; *]`) as AbiType and in derivation for arbitrary T (not only u8)

Arrays as params are not supported

Sample contract:

#[eth_abi(TokenEndpoint, TokenClient)]
pub trait SampleContractInterface {
  fn constructor(&mut self);
  fn createRequest(&mut self, serviceNumber: [u8; 30], date: u64);
}

pub struct SampleContract;

impl SampleContractInterface for SampleContract {
	fn constructor(&mut self) {}

	fn createRequest(&mut self, serviceNumber: [u8; 30], date: u64) {}
}

All tests are passing, but when it's called via web3 api it returns an error.

Logs don't provide a lot of information, however I post them too

{
  "transactionHash": "0xeb0885071aa00c8ec9c6df9620af67c22aa0012daef881f607bc5c8a4df8534c",
  "transactionIndex": "0x0",
  "blockHash": "0xe5f5d1018bbcf228695c8cfcd7f548f434384df6a4e0ee5bfba44b488d93d22e",
  "blockNumber": "0x5d47",
  "cumulativeGasUsed": "0x4630c0",
  "gasUsed": "0x4630c0",
  "contractAddress": null,
  "status": "0x0",
  "logs": []
}

I expect it to be working via web3 calls.

Please add stateMutability to json data.

I do not know if this content should be written here.
I'm sorry if I'm wrong.

Could you add the "stateMutability" item to the json data (target/json/*.json) created when building the pwasm file?

Thank you.

JSON is not generated if not generating a client

Just using #[eth_abi(Endpoint)] does not generate the JSON ABI definition.

#[eth_abi(Endpoint, Client)] works, but requires a lot of package imports (see #43 ) and generates warnigns regarding unused client.

openethereum / pwasm-abi Goto Github PK

pwasm-abi's Introduction

OpenEthereum

Table of Contents

1. Description

2. Technical Overview

3. Building

3.1 Build Dependencies

3.2 Build from Source Code

3.3 Starting OpenEthereum

Manually

Using systemd service file

4. Testing

5. Documentation

Viewing documentation for OpenEthereum packages

6. Toolchain

7. Contributing

Contributor Code of Conduct

8. License

pwasm-abi's People

Contributors

Stargazers

Watchers

Forkers

pwasm-abi's Issues

Sample code

Cargo.toml

Expected result

Actual result:

Combinations that work:

Recommend Projects

Recommend Topics

Recommend Org

Using `systemd` service file