mirror of https://github.com/poanetwork/quorum.git
Cakeshop documentation inclusion (#773)
This commit is contained in:
Krish1979
fixanoid
parent
b204d1702a
commit
cfaa9d2ebd
|
|
@ -0,0 +1,30 @@
|
|||
??? question "How do I call contracts or send Transactions to existing contracts?"
|
||||
|
||||
The "Sandbox" tab provides the ability to load up a contract that has been deployed using Cakeshop or the Cakeshop APIs and to make Read calls or submit Transactions to those contracts.
|
||||
|
||||
|
||||
??? question "How do I find existing contracts?"
|
||||
|
||||
The "Contracts" explorer tab lists all contracts that have been deployed using Cakeshop sandbox.
|
||||
|
||||
??? question "How do I deploy contracts to my network using Cakeshop?"
|
||||
|
||||
The "Sandbox" tab provides the ability to write and deploy contracts onto your chain.
|
||||
|
||||
??? question "How do I run Cakeshop on any Ethereum build or on my private Ethereum network?"
|
||||
|
||||
See the [Attach Mode](../Getting Started#attach-mode) instructions for using Cakeshop with your Ethereum-like node. This provides you the ability to start Cakeshop without auto-starting a geth node, and then attach it to your already-running node.
|
||||
|
||||
??? question "How do I run Cakeshop on many nodes?"
|
||||
|
||||
See the [Multi-Instance](../Getting Started#multi-instance-setup) instructions for managing multiple nodes that you control on an Ethereum-based network.
|
||||
|
||||
??? question "How do I save the solidity files that I have written in the Sandbox?"
|
||||
|
||||
You can't explicitly save these files at the moment, but they are auto-saved to your browser cache. For this reason, you shouldn't use Cakeshop as your version management system and you should definitely ensure you save them in a proper VCS outside of Cakeshop.
|
||||
|
||||
??? question "What is an 'Ethereum-like' ledger/node?"
|
||||
|
||||
An 'Ethereum-like' ledger/node is one that uses the Ethereum JSON RPC API. The Ethereum clients and [Quorum](https://github.com/jpmorganchase/quorum) are examples.
|
||||
|
||||
Note that if an Ethereum-forked ledger forks too far away from base Ethereum then there may be some issues with using Cakeshop on top of it.</em>
|
||||
|
|
@ -0,0 +1,147 @@
|
|||
## Quickstart
|
||||
### Requirements
|
||||
|
||||
* Java 8+
|
||||
* Java app server (Tomcat, Jetty, etc) [Optional]
|
||||
|
||||
### Running via Spring Boot
|
||||
|
||||
* Download WAR file (Binary packages are available for macOS, Windows, and Linux platforms on the [releases](https://github.com/jpmorganchase/cakeshop/releases) page.
|
||||
)
|
||||
* Run `java -jar cakeshop.war`
|
||||
* Navigate to [http://localhost:8080/](http://localhost:8080/)
|
||||
|
||||
*Note: when running in Windows, -Dgeth.node=geth must be specified as Quorum is not yet available on Windows OS*
|
||||
|
||||
### Running via App Server
|
||||
|
||||
* Download WAR file
|
||||
* Put in `/webapps` folder of your app server
|
||||
* Add Java system property `-Dspring.profiles.active=local` to startup script (`setenv.sh` for tomcat)
|
||||
* Start app server
|
||||
* Navigate to [http://localhost:8080/](http://localhost:8080/) (default port is usually 8080)
|
||||
|
||||
*Note: when running in Windows, -Dgeth.node=geth must be specified as Quorum is not yet available on Windows OS*
|
||||
|
||||
### Running modes
|
||||
|
||||
There are a few ways in which you can run Cakeshop (see the sections below for details on each, as well as [configuration](https://github.com/jpmorganchase/cakeshop/blob/master/docs/configuration.md#geth) page):
|
||||
|
||||
1. **Default mode**: _Used when you want Cakeshop to start up an Ethereum node._
|
||||
|
||||
Running Cakeshop in the Default mode will start up Cakeshop and also start running a regular geth node (on a private/test network).
|
||||
|
||||
2. **'Attach/Unmanaged' mode**: _Used when you want to attach Cakeshop to an already running Ethereum-like node._
|
||||
|
||||
Running Cakeshop in 'Attach' a.k.a 'unmanaged' mode will initialize Cakeshop but not start it nor start any Ethereum node. Once Cakeshop initialization is complete you can configure it to use the RPC details of your running node . When you then start Cakeshop it will attach to your node.
|
||||
|
||||
NOTE: if different parties on the network are using Cakeshop to deploy contracts to the network then they need to ensure they are using the same ContractRegistry address. See details below for setting up the ContractRegistry address in this case.
|
||||
|
||||
3. **Multi-Instance Set Up**: _Used when you want to run Cakeshop on more than one node in your network._
|
||||
|
||||
Cakeshop is currently designed such that a given instance of Cakeshop works directly with a single Ethereum-like node, however you can set up multiple instances of Cakeshop on the same machine (each which could either have been started in 'Default' mode or 'Attach' mode) such that each can talk to a different node.
|
||||
|
||||
NOTE: you can use the Attach mode and/or Multi-Instance setup configuration to run Cakeshop on [Quorum](https://github.com/jpmorganchase/quorum) nodes. See below for connecting Cakeshop to the [7nodes](https://github.com/jpmorganchase/quorum-examples/tree/master/examples/7nodes) network from the quorum-examples repo.
|
||||
|
||||
|
||||
#### The below commands assume you have renamed the WAR file to cakeshop.war
|
||||
|
||||
### Default Mode
|
||||
1. In a terminal window run:
|
||||
|
||||
```
|
||||
$ cd path/to/cakeshop/war
|
||||
$ java -jar cakeshop.war
|
||||
```
|
||||
|
||||
2. Open **http://localhost:8080/** in your browser (Firefox/Chrome supported)
|
||||
|
||||
### Attach Mode
|
||||
1. In a terminal window run:
|
||||
|
||||
```
|
||||
$ cd path/to/cakeshop/war
|
||||
# The 'example' arg below will unpack the war file and set up the cakeshop data folders but will not actually start a node
|
||||
$ java -jar cakeshop.war example
|
||||
```
|
||||
2. Navigate to path/to/cakeshop/war/data/local
|
||||
3. Make the following edits to the application.properties file:
|
||||
* set `geth.url` to the `rpcport` of your ethereum node, i.e. if your geth `rpcport` is 22001 then `geth.url=http\://localhost\:22001`
|
||||
* ensure `geth.auto.start` is set to `false`
|
||||
* ensure `geth.auto.stop` is set to `false`
|
||||
4. Run:
|
||||
|
||||
```
|
||||
$ java -jar cakeshop.war
|
||||
```
|
||||
5. Open **http://localhost:8080/** in your browser (Firefox/Chrome supported)
|
||||
|
||||
### Multi-Instance Setup
|
||||
|
||||
Although Cakeshop currently has a one-to-one mapping with the underlying Ethereum-like node that it connects to, it is possible to have multiple Cakeshop instances running on the same machine, each connecting to a different Ethereum-like node. The best way to achieve this is to create separate Cakeshop folders for each node and then attach to each separately. You should also configure the ContractRegistry address as per the below:
|
||||
|
||||
> ** Cakeshop ContractRegistry contract**
|
||||
|
||||
>Cakeshop deploys a ContractRegistry contract upon start up that is used to track those contracts that have been deployed to the chain using Cakeshop or the Cakeshop APIs. When running a multi-instance setup, you'll want to ensure that each instance of Cakeshop references the same ContractRegistry contract in order that each provides a consistent view within the Contracts Explorer.
|
||||
|
||||
>There are two cmd flags that can be set to achieve this:
|
||||
|
||||
> * `CAKESHOP_SHARED_CONFIG` (<em>recommended</em>): When this flag is set, Cakeshop will try to load a file called 'shared.properties' and read the ContractRegistry address from it. If the file doesn't exist, Cakeshop will deploy the ContractRegistry contract, create this file and store the address in the file.
|
||||
|
||||
> USAGE: `$ CAKESHOP_SHARED_CONFIG="{fileLocation}" java -jar cakeshop.war`
|
||||
|
||||
> * `CAKESHOP_REGISTRY_ADDR`: This flag will directly override whatever ContractRegistry address is configured (or not) and run with that address. Using this flag doesn't change any local Cakeshop settings nor save this address to file and so you would have to run with this flag again to use this address again.
|
||||
|
||||
> USAGE: `$ CAKESHOP_REGISTRY_ADDR="0xabcdefgh.." java -jar cakeshop.war`
|
||||
|
||||
|
||||
1. In terminal window 1 run:
|
||||
|
||||
```
|
||||
mkdir myNetwork && cd myNetwork
|
||||
cp path/to/cakeshop/download /myNetwork
|
||||
cd myNetwork
|
||||
mkdir node1 node2
|
||||
cd node1
|
||||
CAKESHOP_SHARED_CONFIG=".." java -jar ../cakeshop.war example
|
||||
```
|
||||
|
||||
2. Assuming you want to attach to an existing node, navigate to /myNetwork/node1/ and edit **application.properties** per the instructions for [attach mode](#attach-mode) as described above
|
||||
|
||||
3. In terminal window 2 run:
|
||||
|
||||
```
|
||||
cd myNetwork/node2
|
||||
CAKESHOP_SHARED_CONFIG=".." java -jar ../cakeshop.war example
|
||||
```
|
||||
|
||||
4. Navigate to myNetwork/node2 and edit **application.properties** per the instructions for [attach mode](#attach-mode) as described above
|
||||
5. In terminal window 1 run:
|
||||
|
||||
```
|
||||
CAKESHOP_SHARED_CONFIG=".." java -jar ../cakeshop.war
|
||||
```
|
||||
|
||||
6. In terminal window 2 run:
|
||||
|
||||
```
|
||||
CAKESHOP_SHARED_CONFIG=".." java -Dserver.port=8081 -jar cakeshop.war # Cakeshop will now be available on localhost:8081
|
||||
```
|
||||
|
||||
7. In browser window 1 open http://localhost:8080/
|
||||
|
||||
8. In browser window 2 open http://localhost:8081/
|
||||
|
||||
### Running Cakeshop on quorum-examples
|
||||
You can use the 'Attach' mode to use Cakeshop to explore the quorum-examples [7nodes](https://github.com/jpmorganchase/quorum-examples/tree/master/examples/7nodes) network.
|
||||
|
||||
To do so:
|
||||
|
||||
1. Follow the instructions in the [7nodes](https://github.com/jpmorganchase/quorum-examples/tree/master/examples/7nodes) example to start the 7nodes network (running vagrant up, init.sh, start.sh etc.)
|
||||
2. Follow the instructions listed under the [Attach](#attach-mode) mode as described above, using the `rpcport` of the node you want to explore as found in the 7nodes [start.sh](https://github.com/jpmorganchase/quorum-examples/blob/master/examples/7nodes/start.sh) file. Equally, follow the [Multi-Instance](#multi-instance-setup) setup to attach to more than one of the Quorum nodes.
|
||||
|
||||
### Confirming Cakeshop Start Up
|
||||
In all cases, Cakeshop will be running once you see the below image, which shows the Cakeshop build and url that you can access that instance of Cakeshop on:
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## What is it?
|
||||
|
||||
[Cakeshop](https://github.com/jpmorganchase/cakeshop) is a set of tools and APIs for working with [Ethereum](https://ethereum.org/)-like ledgers, packaged as a Java web application archive (WAR) that gets you up and running in under 60 seconds.
|
||||
|
||||
Cakeshop can either start up a geth node, which you can then interact with using the Cakeshop front-end, or it can be connected to an Ethereum-like node, such as Quorum, that you already have running. A given Cakeshop instance connects with one node on the blockchain network you connect to.
|
||||
|
||||
|
||||
|
||||
Out of the box you get:
|
||||
|
||||
|
||||
* **Node Management** - Fully functioning Ethereum node (via geth), setting up a cluster
|
||||
* **Blockchain Explorer** - view transactions, blocks and contracts, and see historical contract state at a point in time
|
||||
* **Admin Console** - start & stop nodes, create a cluster and view the overall status of your network
|
||||
* **Peer Management** - easily discover, add and remove peers
|
||||
* **Solidity Sandbox** - develop, compile, deploy and interact with Solidity smart contracts
|
||||
|
||||
It provides tools for managing a local blockchain node, setting up clusters,
|
||||
exploring the state of the chain, and working with contracts.
|
||||
|
||||
The Cakeshop package includes the [tessera](https://github.com/jpmorganchase/tessera) and [constellation](https://github.com/jpmorganchase/constellation) transaction managers, a [Solidity](https://solidity.readthedocs.org/en/latest/) compiler, and all dependencies. Cakeshop will download the latest version of [quorum](https://github.com/jpmorganchase/quorum) and bootnode from [geth](https://github.com/ethereum/go-ethereum) (to use a different version, see [here](docs/configuration.md#custom-quorum-binaries))
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 365 KiB |
|
|
@ -66,7 +66,11 @@ nav:
|
|||
- How it works: Privacy/Constellation/How constellation works.md
|
||||
- Sample Configuration: Privacy/Constellation/Sample Configuration.md
|
||||
- Running Constellation: Privacy/Constellation/Installation & Running.md
|
||||
- Product Roadmap: roadmap.md
|
||||
- Cakeshop:
|
||||
- Overview: Cakeshop/Overview.md
|
||||
- Getting Started: Cakeshop/Getting started.md
|
||||
- Cakeshop FAQ: Cakeshop/Cakeshop FAQ.md
|
||||
- Product Roadmap: roadmap.md
|
||||
- FAQ: FAQ.md
|
||||
|
||||
theme:
|
||||
|
|
|
|||
Loading…
Reference in New Issue