ethereumj-personal/ethereumj-core/README.md


## ethereum-core

### Include ethereum-core in your project

#### For snapshot builds:

 - Add https://oss.jfrog.org/libs-snapshot/ as a repository to your build script
 - Add a dependency on `org.ethereum:ethereumj-core:${VERSION}`, where `${VERSION}` is of the form `0.7.14-SNAPSHOT`.

Example:

    <repository>
        <id>jfrog-snapshots</id>
        <name>oss.jfrog.org</name>
        <url>https://oss.jfrog.org/libs-snapshot/</url>
        <snapshots><enabled>true</enabled></snapshots>
    </repository>
    <!-- ... -->
    <dependency>
       <groupId>org.ethereum</groupId>
       <artifactId>ethereumj-core</artifactId>
       <version>0.7.14-SNAPSHOT</version>
    </dependency>

#### For release builds:

_There are no release builds at this time. Use snapshots in the meantime._


### Examples

See [ethereumj-studio](../ethereumj-studio).


### Build from source

#### Compile, test and package

Run `../gradlew build`.

 - find jar artifacts at `build/libs`
 - find unit test and code coverage reports at `build/reports`

#### Run an ethereum node

 - run `../gradlew run`, or
 - build a standalone executable jar with `../gradlew shadow` and execute the `-all` jar in `build/libs` using `java -jar [jarfile]`.

#### Import sources into IntelliJ IDEA

Use IDEA 14 or better and import project based on Gradle sources.

Note that in order to build the project without errors in IDEA, you will need to run `gradle antlr4` manually.

#### Install artifacts into your local `~/.m2` repository

Run `../gradlew install`.

#### Publish ethereumj-core builds

Simply push to master, and [the Travis CI build](https://travis-ci.org/ethereum/ethereumj) will take care of the rest. To publish manually instead, just run `../gradlew publish`. Where the artifacts are published depends on the value of the `version` property in the [root build.gradle file](../build.gradle). Snapshots (version values ending in `-SNAPSHOT`) will be published to [oss.jfrog.org](https://oss.jfrog.org/libs-snapshot/org/ethereum/), while releases will be published to [Bintray](https://bintray.com/ethereum/maven/org.ethereum/) (and subsequently to [JCenter](http://jcenter.bintray.com/org/ethereum/)). **You must be a member of the [ethereum Bintray organization](https://bintray.com/ethereum) and you must supply `bintrayUser` and `bintrayKey` properties to the Gradle build in order to authenticate against these repositories**. Configure these properties in your `$HOME/.gradle/gradle.properties` for greatest convenience and security.
Create README.md 2014-09-10 05:34:45 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`## ethereum-core`
Create README.md 2014-09-10 05:34:45 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`### Include ethereum-core in your project`
Update README.md 2014-09-10 05:37:19 +00:00
Publish artifacts to oss.jfrog.org and Bintray See updates to ethereumj-core/README.md for details. 2014-12-29 14:35:42 +00:00			`#### For snapshot builds:`

			`- Add https://oss.jfrog.org/libs-snapshot/ as a repository to your build script`
			- Add a dependency on `org.ethereum:ethereumj-core:${VERSION}`, where `${VERSION}` is of the form `0.7.14-SNAPSHOT`.

			`Example:`

			`<repository>`
			`<id>jfrog-snapshots</id>`
			`<name>oss.jfrog.org</name>`
			`<url>https://oss.jfrog.org/libs-snapshot/</url>`
			`<snapshots><enabled>true</enabled></snapshots>`
			`</repository>`
			`<!-- ... -->`
			`<dependency>`
			`<groupId>org.ethereum</groupId>`
			`<artifactId>ethereumj-core</artifactId>`
			`<version>0.7.14-SNAPSHOT</version>`
			`</dependency>`

			`#### For release builds:`

			`_There are no release builds at this time. Use snapshots in the meantime._`
Update README.md 2014-09-10 05:37:19 +00:00
Update README.md 2014-09-10 05:41:46 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`### Examples`
Update README.md 2014-09-10 05:41:46 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`See [ethereumj-studio](../ethereumj-studio).`
Strip trailing whitespace 2014-12-26 08:36:37 +00:00

Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`### Build from source`
Update README.md 2014-09-10 06:00:37 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`#### Compile, test and package`
Strip trailing whitespace 2014-12-26 08:36:37 +00:00
Support running ethereumj-studio as executable jar See updated ethereumj-studio/README.md for details. Note that this commit removes the `build-post-package.xml` ant file (for now) to simplify the Gradle arrangement. This functionality can be re-introduced later and more simply using Gradle's native DSL. In the meantime, both the -core and -studio projects can be run using `gradle run` or run as executable jars by running `gradle shadowJar` followed by the usual `java -jar` execution of the resulting `-all` jar file found in each project's respective `build/libs` directory. 2014-12-27 00:15:01 +00:00			Run `../gradlew build`.
Strip trailing whitespace 2014-12-26 08:36:37 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			- find jar artifacts at `build/libs`
			- find unit test and code coverage reports at `build/reports`
Strip trailing whitespace 2014-12-26 08:36:37 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`#### Run an ethereum node`

Support running ethereumj-studio as executable jar See updated ethereumj-studio/README.md for details. Note that this commit removes the `build-post-package.xml` ant file (for now) to simplify the Gradle arrangement. This functionality can be re-introduced later and more simply using Gradle's native DSL. In the meantime, both the -core and -studio projects can be run using `gradle run` or run as executable jars by running `gradle shadowJar` followed by the usual `java -jar` execution of the resulting `-all` jar file found in each project's respective `build/libs` directory. 2014-12-27 00:15:01 +00:00			- run `../gradlew run`, or
			- build a standalone executable jar with `../gradlew shadow` and execute the `-all` jar in `build/libs` using `java -jar [jarfile]`.
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00
Introduce src/gen/java for generated sources Previously, sources generated from the serpent antlr grammar in ethereumj-core/src/main/antlr4 were output into the build/generated-src directory by default. This worked from the command line without issue, but caused issues within IDEA, because the entirety of the 'build' directory is excluded from compilation by default when working with a Gradle-based project in IDEA. This change simplifies the arrangement by writing these antlr-generated sources to the src/gen/java. A .gitignore file has been added to ensure that transient source files don't accidentally get checked in. A readme file has been added to explain the situation to the uninitiated. 2014-12-26 16:14:39 +00:00			`#### Import sources into IntelliJ IDEA`

			`Use IDEA 14 or better and import project based on Gradle sources.`

			Note that in order to build the project without errors in IDEA, you will need to run `gradle antlr4` manually.

Support installation of artifacts to local maven repo Apply Gradle's 'maven' plugin in order to support `./gradlew install` task, similar to `mvn install` for building and copying artifacts to the users local ~/.m2 repository. 2014-12-26 20:50:15 +00:00			#### Install artifacts into your local `~/.m2` repository

Support running ethereumj-studio as executable jar See updated ethereumj-studio/README.md for details. Note that this commit removes the `build-post-package.xml` ant file (for now) to simplify the Gradle arrangement. This functionality can be re-introduced later and more simply using Gradle's native DSL. In the meantime, both the -core and -studio projects can be run using `gradle run` or run as executable jars by running `gradle shadowJar` followed by the usual `java -jar` execution of the resulting `-all` jar file found in each project's respective `build/libs` directory. 2014-12-27 00:15:01 +00:00			Run `../gradlew install`.
Support installation of artifacts to local maven repo Apply Gradle's 'maven' plugin in order to support `./gradlew install` task, similar to `mvn install` for building and copying artifacts to the users local ~/.m2 repository. 2014-12-26 20:50:15 +00:00
Port build from Maven to Gradle 2014-12-26 13:23:44 +00:00			`#### Publish ethereumj-core builds`

Re-enable Bintray upload support Thanks to @jbaruch for his comments at https://github.com/ethereum/ethereumj/commit/00aba13#commitcomment-9167542 2015-01-06 13:07:09 +00:00			Simply push to master, and [the Travis CI build](https://travis-ci.org/ethereum/ethereumj) will take care of the rest. To publish manually instead, just run `../gradlew publish`. Where the artifacts are published depends on the value of the `version` property in the [root build.gradle file](../build.gradle). Snapshots (version values ending in `-SNAPSHOT`) will be published to [oss.jfrog.org](https://oss.jfrog.org/libs-snapshot/org/ethereum/), while releases will be published to [Bintray](https://bintray.com/ethereum/maven/org.ethereum/) (and subsequently to [JCenter](http://jcenter.bintray.com/org/ethereum/)). You must be a member of the [ethereum Bintray organization](https://bintray.com/ethereum) and you must supply `bintrayUser` and `bintrayKey` properties to the Gradle build in order to authenticate against these repositories. Configure these properties in your `$HOME/.gradle/gradle.properties` for greatest convenience and security.