@holographxyz/cli/oclif.manifest.json

Holograph operator CLI

{"version":"0.0.11","commands":{"analyze":{"id":"analyze","description":"Extract all operator jobs and get their status","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","hidden":true,"aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --scope='{\"network\":\"goerli\",\"startBlock\":10857626,\"endBlock\":11138178}' --scope='{\"network\":\"mumbai\",\"startBlock\":26758573,\"endBlock\":27457918}' --scope='{\"network\":\"fuji\",\"startBlock\":11406945,\"endBlock\":12192217}'"],"flags":{"scope":{"name":"scope","type":"option","description":"JSON object of blocks to analyze \"{ network: string, startBlock: number, endBlock: number }\"","multiple":true},"scopeFile":{"name":"scopeFile","type":"option","description":"JSON file path of blocks to analyze (ie \"./scopeFile.json\")","required":false,"multiple":false,"exclusive":["scope"]},"output":{"name":"output","type":"option","description":"Specify a file to output the results to (ie \"../../analyzeResults.json\")","multiple":false,"default":"./testnet.analyzeResults.json"},"updateApiOn":{"name":"updateApiOn","type":"option","description":"Update DB cross-chain table with correct beam status","multiple":false}},"args":[]},"bridge:contract":{"id":"bridge:contract","description":"Bridge a Holographable contract from source chain to destination chain. You need to have a deployment config JSON file. Use the \"contract:create\" command to create or extract one.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --sourceNetwork=\"goerli\" --destinationNetwork=\"fuji\" --deploymentConfig=\"./MyContract.json\""],"flags":{"sourceNetwork":{"name":"sourceNetwork","type":"option","description":"The network from which contract deploy request will be sent","required":false,"multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]},"destinationNetwork":{"name":"destinationNetwork","type":"option","description":"The network on which the contract will be deployed","required":false,"multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]},"deploymentConfig":{"name":"deploymentConfig","type":"option","description":"The config file to use","required":false,"multiple":false}},"args":[]},"bridge":{"id":"bridge","description":"Make a bridge request.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":[{"description":"Learn how to bridge a Holographable contract","command":"<%= config.bin %> bridge:contract --help"},{"description":"Learn how to bridge a Holographable NFT","command":"<%= config.bin %> bridge:nft --help"}],"flags":{},"args":[]},"bridge:nft":{"id":"bridge:nft","description":"Bridge a Holographable NFT from one network to another.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --sourceNetwork=\"goerli\" --destinationNetwork=\"fuji\" --collectionAddress=\"0x1318d3420b0169522eB8F3EF0830aceE700A2eda\" --tokenId=\"0x01\""],"flags":{"collectionAddress":{"name":"collectionAddress","type":"option","description":"The address of the collection smart contract","required":false,"multiple":false},"tokenId":{"name":"tokenId","type":"option","description":"The token ID of the NFT to beam","required":false,"multiple":false},"sourceNetwork":{"name":"sourceNetwork","type":"option","description":"The source network from which to beam","required":false,"multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]},"destinationNetwork":{"name":"destinationNetwork","type":"option","description":"The destination network which to beam to","required":false,"multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]}},"args":[]},"config":{"id":"config","description":"Initialize the Holograph CLI with a config file. If no flags are passed, the CLI will prompt you for the required information.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --privateKey abc...def","$ <%= config.bin %> <%= command.id %> --fromFile ./config.json","$ <%= config.bin %> <%= command.id %> --fromJson '{\"version\": \"beta3\", ...}"],"flags":{"network":{"name":"network","type":"option","description":"Network to set","multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]},"url":{"name":"url","type":"option","description":"Provider URL of network to set","multiple":false,"dependsOn":["network"]},"privateKey":{"name":"privateKey","type":"option","description":"Default account to use when sending all transactions","multiple":false},"fromFile":{"name":"fromFile","type":"option","description":"Path to the config file to load","multiple":false},"fromJson":{"name":"fromJson","type":"option","description":"JSON object to use as the config","multiple":false}},"args":[]},"config:networks":{"id":"config:networks","description":"View the current network config.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %>","$ <%= config.bin %> <%= command.id %> --output json","$ <%= config.bin %> <%= command.id %> --output yaml","$ <%= config.bin %> <%= command.id %> --output clean"],"flags":{"output":{"name":"output","type":"option","description":"Output format","multiple":false,"options":["clean","json","yaml"]}},"args":[]},"config:user":{"id":"config:user","description":"View the current user information.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %>","$ <%= config.bin %> <%= command.id %> --output json","$ <%= config.bin %> <%= command.id %> --output yaml","$ <%= config.bin %> <%= command.id %> --output clean"],"flags":{"output":{"name":"output","type":"option","description":"Output format","multiple":false,"options":["clean","json","yaml"]}},"args":[]},"config:view":{"id":"config:view","description":"View the current config state of the Holograph CLI.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %>","$ <%= config.bin %> <%= command.id %> --output json","$ <%= config.bin %> <%= command.id %> --output yaml","$ <%= config.bin %> <%= command.id %> --output clean"],"flags":{"output":{"name":"output","type":"option","description":"Output format","multiple":false,"options":["clean","json","yaml"]}},"args":[]},"create:contract":{"id":"create:contract","description":"Deploy a Holographable contract.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","hidden":false,"aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --deploymentType=\"deployedTx\" --tx=\"0xdb8b393dd18a71b386c8de75b87310c0c8ded0c57cf6b4c5bab52873d54d1e8a\" --txNetwork=\"goerli\""],"flags":{"tx":{"name":"tx","type":"option","description":"The hash of transaction that deployed the original contract","required":false,"multiple":false},"txNetwork":{"name":"txNetwork","type":"option","description":"The network on which the transaction was executed","required":false,"multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]},"targetNetwork":{"name":"targetNetwork","type":"option","description":"The network on which the contract will be executed","required":false,"multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]},"deploymentType":{"name":"deploymentType","type":"option","description":"The type of deployment to use","required":false,"multiple":false,"options":["deployedTx","deploymentConfig","createConfig"]},"deploymentConfig":{"name":"deploymentConfig","type":"option","description":"The config file to use","required":false,"multiple":false}},"args":[]},"create":{"id":"create","description":"Create Holographable contracts and NFTs.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> create","$ <%= config.bin %> create:contract","$ <%= config.bin %> create:nft"],"flags":{},"args":[]},"create:nft":{"id":"create:nft","description":"Mint a Holographable NFT.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --network=\"goerli\" --collectionAddress=\"0xf90c33d5ef88a9d84d4d61f62c913ba192091fe7\" --tokenId=\"0\" --tokenUriType=\"ipfs\" --tokenUri=\"QmfQhPGMAbHL31qcqAEYpSP5gXwXWQa3HZjkNVzZ2mRsRs/metadata.json\""],"flags":{"collectionAddress":{"name":"collectionAddress","type":"option","description":"The address of the collection smart contract","required":false,"multiple":false},"tokenId":{"name":"tokenId","type":"option","description":"The token id to mint. By default the token id is 0, which mints the next available token id","required":false,"multiple":false,"default":"0"},"tokenUriType":{"name":"tokenUriType","type":"option","description":"The token URI type","required":false,"multiple":false,"options":["ipfs","https","arweave"]},"tokenUri":{"name":"tokenUri","type":"option","description":"The uri of the token, minus the prepend (ie \"ipfs://\")","required":false,"multiple":false},"network":{"name":"network","type":"option","description":"Name of network to use","required":false,"multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]}},"args":[]},"faucet":{"id":"faucet","description":"Request Testnet HLG from a faucet.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --network=\"goerli\""],"flags":{"network":{"name":"network","type":"option","description":"Name of network to use","required":false,"multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]}},"args":[]},"indexer":{"id":"indexer","description":"Listen for EVM events and update database network status","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","hidden":true,"aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --networks ethereumTestnetGoerli polygonTestnet avalancheTestnet"],"flags":{"host":{"name":"host","type":"option","char":"h","description":"The host to send data to","multiple":false,"default":"http://localhost:9001"},"networks":{"name":"networks","type":"option","description":"Space separated list of networks to use","required":false,"multiple":true,"options":["goerli","mumbai","fuji","rinkeby"]},"warp":{"name":"warp","type":"option","char":"w","description":"Start from the beginning of the chain","multiple":false,"default":0},"healthCheck":{"name":"healthCheck","type":"boolean","description":"Launch server on http://localhost:6000 to make sure command is still running","allowNo":false},"healthCheckPort":{"name":"healthCheckPort","type":"option","description":"This flag allows you to choose what port the health check sever is running on.","multiple":false,"dependsOn":["healthCheck"]}},"args":[],"LAST_BLOCKS_FILE_NAME":"indexer-blocks.json"},"operator:bond":{"id":"operator:bond","description":"Bond in to a pod.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --network <string> --pod <number> --amount <number>"],"flags":{"network":{"name":"network","type":"option","description":"Name of network to use","required":false,"multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]},"pod":{"name":"pod","type":"option","description":"Pod number to join","multiple":false},"amount":{"name":"amount","type":"option","description":"Amount of tokens to deposit","multiple":false}},"args":[]},"operator":{"id":"operator","description":"Listen for jobs and execute jobs.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --networks goerli fuji mumbai --mode=auto --sync"],"flags":{"mode":{"name":"mode","type":"option","char":"m","description":"The mode in which to run the operator","multiple":false,"options":["listen","manual","auto"]},"sync":{"name":"sync","type":"boolean","description":"Start from last saved block position instead of latest block position","allowNo":false},"unsafePassword":{"name":"unsafePassword","type":"option","description":"Enter the plain text password for the wallet in the holograph cli config","multiple":false},"networks":{"name":"networks","type":"option","description":"Space separated list of networks to use","required":false,"multiple":true,"options":["goerli","mumbai","fuji","rinkeby"]},"healthCheck":{"name":"healthCheck","type":"boolean","description":"Launch server on http://localhost:6000 to make sure command is still running","allowNo":false},"healthCheckPort":{"name":"healthCheckPort","type":"option","description":"This flag allows you to choose what port the health check sever is running on.","multiple":false,"dependsOn":["healthCheck"]}},"args":[]},"operator:recover":{"id":"operator:recover","description":"Attempt to re-run/recover a specific job.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --network=\"ethereumTestnetGoerli\" --tx=\"0x...\""],"flags":{"network":{"name":"network","type":"option","description":"The network on which the transaction was executed","multiple":false,"options":["goerli","mumbai","fuji","rinkeby"]},"tx":{"name":"tx","type":"option","description":"The hash of transaction that we want to attempt to execute","multiple":false},"healthCheck":{"name":"healthCheck","type":"boolean","description":"Launch server on http://localhost:6000 to make sure command is still running","allowNo":false},"healthCheckPort":{"name":"healthCheckPort","type":"option","description":"This flag allows you to choose what port the health check sever is running on.","multiple":false,"dependsOn":["healthCheck"]}},"args":[]},"operator:unbond":{"id":"operator:unbond","description":"Un-bond an operator from a pod","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %>"],"flags":{},"args":[]},"propagator":{"id":"propagator","description":"Listen for EVM events deploys collections to the supported networks","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","hidden":true,"aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --networks ethereumTestnetRinkeby polygonTestnet avalancheTestnet --mode=auto"],"flags":{"mode":{"name":"mode","type":"option","char":"m","description":"The mode in which to run the propagator","multiple":false,"options":["listen","manual","auto"]},"sync":{"name":"sync","type":"boolean","description":"Start from last saved block position instead of latest block position","allowNo":false},"unsafePassword":{"name":"unsafePassword","type":"option","description":"Enter the plain text password for the wallet in the holograph cli config","multiple":false},"warp":{"name":"warp","type":"option","char":"w","description":"Start from the beginning of the chain","multiple":false,"default":0},"networks":{"name":"networks","type":"option","description":"Space separated list of networks to use","required":false,"multiple":true,"options":["goerli","mumbai","fuji","rinkeby"]},"recover":{"name":"recover","type":"option","description":"Provide a JSON array of RecoveryData objects to manually ensure propagation","multiple":false,"default":"[]"},"recoverFile":{"name":"recoverFile","type":"option","description":"Filename reference to JSON array of RecoveryData objects to manually ensure propagation","multiple":false},"healthCheck":{"name":"healthCheck","type":"boolean","description":"Launch server on http://localhost:6000 to make sure command is still running","allowNo":false},"healthCheckPort":{"name":"healthCheckPort","type":"option","description":"This flag allows you to choose what port the health check sever is running on.","multiple":false,"dependsOn":["healthCheck"]}},"args":[]},"status:contract":{"id":"status:contract","description":"Check the status of a contract across all networks defined in the config.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --address=\"0x5059bf8E4De43ccc0C27ebEc9940e2310E071A78\""],"flags":{"address":{"name":"address","type":"option","description":"The address of contract to check status of","multiple":false},"output":{"name":"output","type":"option","description":"Define table output type","multiple":false,"options":["csv","json","yaml",""],"default":"yaml"}},"args":[],"LAST_BLOCKS_FILE_NAME":"blocks.json"},"status":{"id":"status","description":"Get the status of a contract or NFT.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":[{"description":"Learn how to get the status of a contract","command":"<%= config.bin %> status:contract --help"},{"description":"Learn how to get the status of an NFT","command":"<%= config.bin %> status:nft --help"}],"flags":{},"args":[]},"status:nft":{"id":"status:nft","description":"Check the status of an NFT across all networks defined in the config.","strict":true,"pluginName":"@holographxyz/cli","pluginAlias":"@holographxyz/cli","pluginType":"core","aliases":[],"examples":["$ <%= config.bin %> <%= command.id %> --address=\"0x5059bf8E4De43ccc0C27ebEc9940e2310E071A78\" --id=1"],"flags":{"address":{"name":"address","type":"option","description":"The address of contract to check status of","multiple":false},"id":{"name":"id","type":"option","description":"Token ID to check","multiple":false},"output":{"name":"output","type":"option","description":"Define table output type","multiple":false,"options":["csv","json","yaml",""],"default":"yaml"}},"args":[],"LAST_BLOCKS_FILE_NAME":"blocks.json"}}}