mirror of
https://github.com/EvernodeXRPL/hp-devkit.git
synced 2026-04-29 15:37:58 +00:00
Minor updates.
This commit is contained in:
10
README.md
10
README.md
@@ -3,6 +3,11 @@ Developer toolkit for Hot Pocket smart contract development. This toolkit makes
|
||||
|
||||
We use Docker containers to run Hot Pocket and smart contracts in a Linux environment. We also use Docker containers to distribute developer tools so developers can use the tools on any platform as long as they install Docker.
|
||||
|
||||
<img width="829" alt="image" src="https://user-images.githubusercontent.com/33562092/174513691-4700f356-09c5-47f9-ad5c-550abaefc1b1.png">
|
||||
|
||||
## Public documentation
|
||||
Available [here](https://github.com/HotPocketDev/evernode-sdk/tree/main/hpdevkit)
|
||||
|
||||
## Prerequisites
|
||||
- [Docker](https://docs.docker.com/engine/install/)
|
||||
|
||||
@@ -71,8 +76,8 @@ Example `hp.cfg.override` for a nodejs application:
|
||||
|
||||
#### Code generator
|
||||
```
|
||||
# Generate nodejs starter project
|
||||
.\hpdevkit.ps1 gen nodejs starter <project name>
|
||||
# Generate nodejs starter contract project
|
||||
.\hpdevkit.ps1 gen nodejs starter-contract <project name>
|
||||
```
|
||||
|
||||
### Generate executable
|
||||
@@ -85,7 +90,6 @@ The executable can be distributed to be run as a CLI tool on developer machine.
|
||||
## Environment variables
|
||||
| Name | Description | Default value |
|
||||
| --- | --- | --- |
|
||||
| HP_CLUSTER | Name of the cluster. Can be used to spin up different clusters for different applications. | `default` |
|
||||
| HP_CLUSTER_SIZE | Number of nodes in the cluster. Applied with 'deploy' command. | `1` |
|
||||
| HP_DEFAULT_NODE | The node the 'deploy' command uses to display logs. | `1` |
|
||||
| HP_DEVKIT_IMAGE | Docker image to be used for devkit cluster management. | `evernodedev/hpdevkit` |
|
||||
|
||||
@@ -78,7 +78,7 @@ function create_instance {
|
||||
# Create container for hot pocket instance.
|
||||
local container_name="${container_prefix}_$node"
|
||||
docker container create --name $container_name --privileged \
|
||||
-p $peer_port:$peer_port -p $user_port:$user_port --network $network --network-alias node$node \
|
||||
-p $user_port:$user_port --network $network --network-alias node$node \
|
||||
--mount type=volume,src=$volume,dst=$volume_mount $hotpocket_image run $(contract_dir_mount_path $node)
|
||||
}
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
$GlobalPrefix = "hpdevkit"
|
||||
$Version = "0.1.0"
|
||||
|
||||
$Cluster = if ($env:HP_CLUSTER) { $env:HP_CLUSTER } else { "default" };
|
||||
$Cluster = "default"
|
||||
$ClusterSize = if ($env:HP_CLUSTER_SIZE) { $env:HP_CLUSTER_SIZE } else { 1 };
|
||||
$DefaultNode = if ($env:HP_DEFAULT_NODE) { $env:HP_DEFAULT_NODE } else { 1 };
|
||||
$DevKitImage = if ($env:HP_DEVKIT_IMAGE) { $env:HP_DEVKIT_IMAGE } else { "evernodedev/hpdevkit" };
|
||||
|
||||
Reference in New Issue
Block a user