Skip to content

Commit

Permalink
0.0.10
Browse files Browse the repository at this point in the history
  • Loading branch information
@sogoiii
sogoiii committed Nov 3, 2022
1 parent 287acda commit 3a020a2
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 58 deletions.
109 changes: 52 additions & 57 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,52 +16,48 @@
This is a CLI is primarily for operators of the holograph network. The CLI includes tools to move NFTs between networks and view their status.

<!-- toc -->

- [Overview](#overview)
- [Usage](#usage)
- [Commands](#commands)
* [Overview](#overview)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->

```sh-session
$ npm install -g @holographxyz/cli
$ holograph COMMAND
running command...
$ holograph (--version)
@holographxyz/cli/0.0.9 darwin-arm64 node-v18.9.0
@holographxyz/cli/0.0.10 darwin-arm64 node-v18.9.0
$ holograph --help [COMMAND]
USAGE
$ holograph COMMAND
...
```

<!-- usagestop -->

# Commands

<!-- commands -->

- [`holograph bridge`](#holograph-bridge)
- [`holograph bridge:contract`](#holograph-bridgecontract)
- [`holograph bridge:nft`](#holograph-bridgenft)
- [`holograph config`](#holograph-config)
- [`holograph config:networks`](#holograph-confignetworks)
- [`holograph config:user`](#holograph-configuser)
- [`holograph config:view`](#holograph-configview)
- [`holograph create`](#holograph-create)
- [`holograph create:contract`](#holograph-createcontract)
- [`holograph create:nft`](#holograph-createnft)
- [`holograph faucet`](#holograph-faucet)
- [`holograph help [COMMAND]`](#holograph-help-command)
- [`holograph operator`](#holograph-operator)
- [`holograph operator:bond`](#holograph-operatorbond)
- [`holograph operator:recover`](#holograph-operatorrecover)
- [`holograph status`](#holograph-status)
- [`holograph status:contract`](#holograph-statuscontract)
- [`holograph status:nft`](#holograph-statusnft)
* [`holograph bridge`](#holograph-bridge)
* [`holograph bridge:contract`](#holograph-bridgecontract)
* [`holograph bridge:nft`](#holograph-bridgenft)
* [`holograph config`](#holograph-config)
* [`holograph config:networks`](#holograph-confignetworks)
* [`holograph config:user`](#holograph-configuser)
* [`holograph config:view`](#holograph-configview)
* [`holograph create`](#holograph-create)
* [`holograph create:contract`](#holograph-createcontract)
* [`holograph create:nft`](#holograph-createnft)
* [`holograph faucet`](#holograph-faucet)
* [`holograph help [COMMAND]`](#holograph-help-command)
* [`holograph operator`](#holograph-operator)
* [`holograph operator:bond`](#holograph-operatorbond)
* [`holograph operator:recover`](#holograph-operatorrecover)
* [`holograph status`](#holograph-status)
* [`holograph status:contract`](#holograph-statuscontract)
* [`holograph status:nft`](#holograph-statusnft)

## `holograph bridge`

Expand All @@ -84,7 +80,7 @@ EXAMPLES
$ holograph bridge:nft --help
```

_See code: [dist/commands/bridge/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/bridge/index.ts)_
_See code: [dist/commands/bridge/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/bridge/index.ts)_

## `holograph bridge:contract`

Expand All @@ -107,10 +103,10 @@ DESCRIPTION
file. Use the "contract:create" command to create or extract one.
EXAMPLES
$ holograph bridge:contract --sourceNetwork="ethereumTestnetGoerli" --destinationNetwork="avalancheTestnet" --deploymentConfig="./MyContract.json"
$ holograph bridge:contract --sourceNetwork="goerli" --destinationNetwork="fuji" --deploymentConfig="./MyContract.json"
```

_See code: [dist/commands/bridge/contract.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/bridge/contract.ts)_
_See code: [dist/commands/bridge/contract.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/bridge/contract.ts)_

## `holograph bridge:nft`

Expand All @@ -133,10 +129,10 @@ DESCRIPTION
Beam a Holographable NFT from source chain to destination chain.
EXAMPLES
$ holograph bridge:nft --sourceNetwork="ethereumTestnetGoerli" --destinationNetwork="avalancheTestnet" --collectionAddress="0x1318d3420b0169522eB8F3EF0830aceE700A2eda" --tokenId="0x01"
$ holograph bridge:nft --sourceNetwork="goerli" --destinationNetwork="fuji" --collectionAddress="0x1318d3420b0169522eB8F3EF0830aceE700A2eda" --tokenId="0x01"
```

_See code: [dist/commands/bridge/nft.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/bridge/nft.ts)_
_See code: [dist/commands/bridge/nft.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/bridge/nft.ts)_

## `holograph config`

Expand Down Expand Up @@ -167,7 +163,7 @@ EXAMPLES
$ holograph config --fromJson '{"version": "beta3", ...}
```

_See code: [dist/commands/config/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/config/index.ts)_
_See code: [dist/commands/config/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/config/index.ts)_

## `holograph config:networks`

Expand All @@ -194,7 +190,7 @@ EXAMPLES
$ holograph config:networks --output clean
```

_See code: [dist/commands/config/networks.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/config/networks.ts)_
_See code: [dist/commands/config/networks.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/config/networks.ts)_

## `holograph config:user`

Expand All @@ -221,7 +217,7 @@ EXAMPLES
$ holograph config:user --output clean
```

_See code: [dist/commands/config/user.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/config/user.ts)_
_See code: [dist/commands/config/user.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/config/user.ts)_

## `holograph config:view`

Expand All @@ -248,7 +244,7 @@ EXAMPLES
$ holograph config:view --output clean
```

_See code: [dist/commands/config/view.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/config/view.ts)_
_See code: [dist/commands/config/view.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/config/view.ts)_

## `holograph create`

Expand All @@ -269,7 +265,7 @@ EXAMPLES
$ holograph create:nft
```

_See code: [dist/commands/create/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/create/index.ts)_
_See code: [dist/commands/create/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/create/index.ts)_

## `holograph create:contract`

Expand All @@ -294,10 +290,10 @@ DESCRIPTION
Deploy a Holographable contract directly to a chain
EXAMPLES
$ holograph create:contract --deploymentType="deployedTx" --tx="0xdb8b393dd18a71b386c8de75b87310c0c8ded0c57cf6b4c5bab52873d54d1e8a" --txNetwork="ethereumTestnetGoerli"
$ holograph create:contract --deploymentType="deployedTx" --tx="0xdb8b393dd18a71b386c8de75b87310c0c8ded0c57cf6b4c5bab52873d54d1e8a" --txNetwork="goerli"
```

_See code: [dist/commands/create/contract.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/create/contract.ts)_
_See code: [dist/commands/create/contract.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/create/contract.ts)_

## `holograph create:nft`

Expand All @@ -322,10 +318,10 @@ DESCRIPTION
Mint a Holographable NFT
EXAMPLES
$ holograph create:nft --network="ethereumTestnetGoerli" --collectionAddress="0xf90c33d5ef88a9d84d4d61f62c913ba192091fe7" --tokenId="0" --tokenUriType="ipfs" --tokenUri="QmfQhPGMAbHL31qcqAEYpSP5gXwXWQa3HZjkNVzZ2mRsRs/metadata.json"
$ holograph create:nft --network="goerli" --collectionAddress="0xf90c33d5ef88a9d84d4d61f62c913ba192091fe7" --tokenId="0" --tokenUriType="ipfs" --tokenUri="QmfQhPGMAbHL31qcqAEYpSP5gXwXWQa3HZjkNVzZ2mRsRs/metadata.json"
```

_See code: [dist/commands/create/nft.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/create/nft.ts)_
_See code: [dist/commands/create/nft.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/create/nft.ts)_

## `holograph faucet`

Expand All @@ -343,10 +339,10 @@ DESCRIPTION
Request tokens from a faucet
EXAMPLES
$ holograph faucet --network=<network>
$ holograph faucet --network="goerli"
```

_See code: [dist/commands/faucet/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/faucet/index.ts)_
_See code: [dist/commands/faucet/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/faucet/index.ts)_

## `holograph help [COMMAND]`

Expand Down Expand Up @@ -374,8 +370,8 @@ Listen for EVM events for jobs and process them

```
USAGE
$ holograph operator [-m listen|manual|auto] [--healthCheck] [--sync] [--unsafePassword <value>] [--networks
goerli|mumbai|fuji|rinkeby]
$ holograph operator [--networks goerli|mumbai|fuji|rinkeby] [-m listen|manual|auto] [--sync]
[--healthCheck] [--unsafePassword <value>]
FLAGS
-m, --mode=<option> The mode in which to run the operator
Expand All @@ -390,24 +386,24 @@ DESCRIPTION
Listen for EVM events for jobs and process them
EXAMPLES
$ holograph operator --networks ethereumTestnetGoerli polygonTestnet avalancheTestnet --mode=auto
$ holograph operator --networks goerli fuji mumbai --mode=auto --sync
```

_See code: [dist/commands/operator/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/operator/index.ts)_
_See code: [dist/commands/operator/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/operator/index.ts)_

## `holograph operator:bond`

Bond an operator into a pod

```
USAGE
$ holograph operator:bond [-n goerli|mumbai|fuji|rinkeby] [--pod <value>] [--amount <value>]
$ holograph operator:bond [--network goerli|mumbai|fuji|rinkeby] [--pod <value>] [--amount <value>]
FLAGS
-n, --network=<option> The network to bond to
<options: goerli|mumbai|fuji|rinkeby>
--amount=<value> Amount of tokens to deposit
--pod=<value> Pod number to join
--amount=<value> Amount of tokens to deposit
--network=<option> Name of network to use
<options: goerli|mumbai|fuji|rinkeby>
--pod=<value> Pod number to join
DESCRIPTION
Bond an operator into a pod
Expand All @@ -416,7 +412,7 @@ EXAMPLES
$ holograph operator:bond --network <string> --pod <number> --amount <number>
```

_See code: [dist/commands/operator/bond.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/operator/bond.ts)_
_See code: [dist/commands/operator/bond.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/operator/bond.ts)_

## `holograph operator:recover`

Expand All @@ -438,7 +434,7 @@ EXAMPLES
$ holograph operator:recover --network="ethereumTestnetGoerli" --tx="0x..."
```

_See code: [dist/commands/operator/recover.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/operator/recover.ts)_
_See code: [dist/commands/operator/recover.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/operator/recover.ts)_

## `holograph status`

Expand All @@ -461,7 +457,7 @@ EXAMPLES
$ holograph status:nft --help
```

_See code: [dist/commands/status/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/status/index.ts)_
_See code: [dist/commands/status/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/status/index.ts)_

## `holograph status:contract`

Expand All @@ -483,7 +479,7 @@ EXAMPLES
$ holograph status:contract --address="0x5059bf8E4De43ccc0C27ebEc9940e2310E071A78"
```

_See code: [dist/commands/status/contract.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/status/contract.ts)_
_See code: [dist/commands/status/contract.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/status/contract.ts)_

## `holograph status:nft`

Expand All @@ -506,8 +502,7 @@ EXAMPLES
$ holograph status:nft --address="0x5059bf8E4De43ccc0C27ebEc9940e2310E071A78" --id=1
```

_See code: [dist/commands/status/nft.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/status/nft.ts)_

_See code: [dist/commands/status/nft.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.10/dist/commands/status/nft.ts)_
<!-- commandsstop -->

## Developing
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@holographxyz/cli",
"version": "0.0.9",
"version": "0.0.10",
"license": "SEE LICENSE IN LICENSE.md",
"description": "Holograph operator CLI",
"author": "@holographxyz",
Expand Down

0 comments on commit 3a020a2

Please sign in to comment.