Skip to content

Commit

Permalink
docs: add installation instructions, go mod tidy, add dependabot
Browse files Browse the repository at this point in the history
  • Loading branch information
kamikazechaser committed Feb 22, 2024
1 parent a320044 commit d93ac3e
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 2 deletions.
6 changes: 6 additions & 0 deletions .github/dependabot.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: "weekly"
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,56 @@

> GE Publish
CLI tool to publish GE related smart contracts
CLI tool to publish GE related smart contracts to Celo

Supported Smart Contracts:

- [x] SwapPool
- [x] DecimalQuote
- [x] PriceIndexQuote
- [x] Limiter
- [x] LimiterIndex
- [x] TokenRegistry

## Install

Download and extract the binary for your OS/Arch from the [releases page](https://github.com/grassrootseconomics/ge-publish/releases)

E.g. for linux:

### Linux

```bash
wget https://github.com/grassrootseconomics/ge-publish/releases/latest/download/ge-publish-linux-amd64.zip
unzip -j ge-publish-linux-amd64.zip
mv ge-publish-linux-amd64 ge-publish
# (Optional) Make it globally available
sudo mv ge-publish /usr/local/bin
```

## Usage

```bash
./ge-publish --help
```

Examples:

### Limter

```bash
# Set your private key
export PRIVATE_KEY=
./ge_publish --testnet publish limiter
```

### SwapPool

```bash
# Set your private key
export PRIVATE_KEY=
./ge_publish --testnet publish swap-pool --name MySwapPool --symbol SWP1 --decimals 6 --token-registry 0x000000000000000000000000000000000000dEaD --token-limiter 0x000000000000000000000000000000000000dEaD
```

## License

Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ go 1.21.6
require (
github.com/celo-org/celo-blockchain v1.8.0
github.com/grassrootseconomics/celoutils/v2 v2.1.1
github.com/grassrootseconomics/w3-celo v0.16.0
github.com/urfave/cli/v2 v2.27.1
)

Expand All @@ -28,7 +29,6 @@ require (
github.com/go-stack/stack v1.8.1 // indirect
github.com/golang/snappy v0.0.5-0.20220116011046-fa5810519dcb // indirect
github.com/gorilla/websocket v1.5.0 // indirect
github.com/grassrootseconomics/w3-celo v0.16.0 // indirect
github.com/hashicorp/golang-lru v0.5.5-0.20210104140557-80c98217689d // indirect
github.com/hdevalence/ed25519consensus v0.0.0-20201207055737-7fde80a9d5ff // indirect
github.com/holiman/bloomfilter/v2 v2.0.3 // indirect
Expand Down

0 comments on commit d93ac3e

Please sign in to comment.