diff --git a/CLI.md b/CLI.md index 35ee321a..1d3fbdb1 100644 --- a/CLI.md +++ b/CLI.md @@ -68,7 +68,7 @@ iexec wallet show # show your wallet iexec storage init # initialize your remote storage ``` -> _NB:_ iExec SDK CLI access the public blockchain (mainnet) through [ethers](https://github.com/ethers-io/ethers.js/) to connect different backends ([Alchemy](https://alchemyapi.io/), [Etherscan](https://etherscan.io/), [INFURA](https://infura.io/)). +> _NB:_ iExec SDK CLI access the blockchain through [ethers](https://github.com/ethers-io/ethers.js/) to connect different backends ([Alchemy](https://alchemyapi.io/), [Etherscan](https://etherscan.io/), [INFURA](https://infura.io/)). > > Default API keys for backend services are provided for convenience. > As these keys are shared across all users and are subject to rate limits, **you must use your own API keys** or better **your own node**. @@ -103,8 +103,7 @@ iexec storage init # initialize your remote storage > "default": ..., > "chains": { > ... -> "mainnet": { -> "id": "1", +> "arbitrum-mainnet": { > "host": "http://localhost:8545" > } > } @@ -302,7 +301,6 @@ Commands: - [init](#iexec-init) - [iexec wallet](#iexec-wallet) - [iexec account](#iexec-account) -- [iexec voucher](#iexec-voucher) - [iexec app](#iexec-app) - [iexec dataset](#iexec-dataset) - [iexec workerpool](#iexec-workerpool) @@ -313,7 +311,6 @@ Commands: - [iexec task](#iexec-task) - [iexec storage](#iexec-storage) - [iexec result](#iexec-result) -- [iexec ens](#iexec-ens) - [iexec category](#iexec-category) - [info](#iexec-info) @@ -357,9 +354,6 @@ Commands: - [send-ether](#iexec-wallet-send-ether) - [send-RLC](#iexec-wallet-send-rlc) - [sweep](#iexec-wallet-sweep) -- [bridge-to-sidechain](#iexec-wallet-bridge-to-sidechain) -- [bridge-to-mainchain](#iexec-wallet-bridge-to-mainchain) -- [sendRLC](#iexec-wallet-sendrlc) #### iexec wallet create @@ -428,8 +422,6 @@ Options: #### iexec wallet send-ether -_Alias: sendETH_ - send ether to an address (default unit ether) Usage: @@ -449,7 +441,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | | --force | force perform action without prompting user | | --to \ | receiver address | @@ -475,7 +466,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | | --force | force perform action without prompting user | | --to \ | receiver address | @@ -501,83 +491,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | -| --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | -| --force | force perform action without prompting user | -| --to \ | receiver address | - -#### iexec wallet bridge-to-sidechain - -send RLC from the mainchain to the sidechain (default unit nRLC) - -Usage: - -```sh -iexec wallet bridge-to-sidechain [unit] [options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --password \ | password used to encrypt the wallet (unsafe) | -| --wallet-file \ | specify the name of the wallet file to use | -| --wallet-address \ | specify the address of the wallet to use | -| --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | -| --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | -| --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | -| --force | force perform action without prompting user | - -#### iexec wallet bridge-to-mainchain - -send RLC from the sidechain to the mainchain (default unit nRLC) - -Usage: - -```sh -iexec wallet bridge-to-mainchain [unit] [options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --password \ | password used to encrypt the wallet (unsafe) | -| --wallet-file \ | specify the name of the wallet file to use | -| --wallet-address \ | specify the address of the wallet to use | -| --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | -| --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | -| --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | -| --force | force perform action without prompting user | - -#### iexec wallet sendRLC - -\[DEPRECATED see send-RLC\] send RLC to an address (WARNING! default unit nRLC) - -Usage: - -```sh -iexec wallet sendRLC [unit] [options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --password \ | password used to encrypt the wallet (unsafe) | -| --wallet-file \ | specify the name of the wallet file to use | -| --wallet-address \ | specify the address of the wallet to use | -| --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | -| --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | | --force | force perform action without prompting user | | --to \ | receiver address | @@ -622,7 +535,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | #### iexec account withdraw @@ -646,7 +558,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | #### iexec account show @@ -692,7 +603,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | #### iexec account allowance @@ -739,92 +649,8 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | -### iexec voucher - -manage iExec voucher - -Usage: - -```sh -iexec voucher [options] -``` - -Commands: - -- [show](#iexec-voucher-show) -- [authorize](#iexec-voucher-authorize) -- [revoke](#iexec-voucher-revoke) - -#### iexec voucher show - -show voucher iExec details - -Usage: - -```sh -iexec voucher show [options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --password \ | password used to encrypt the wallet (unsafe) | -| --wallet-file \ | specify the name of the wallet file to use | -| --wallet-address \ | specify the address of the wallet to use | -| --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | -| --chain \ | chain name from "chain.json" | -| --user \ | custom user address | - -#### iexec voucher authorize - -authorize requester to use the voucher - -Usage: - -```sh -iexec voucher authorize [options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --password \ | password used to encrypt the wallet (unsafe) | -| --wallet-file \ | specify the name of the wallet file to use | -| --wallet-address \ | specify the address of the wallet to use | -| --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | -| --chain \ | chain name from "chain.json" | - -#### iexec voucher revoke - -revoke authorization to use the voucher - -Usage: - -```sh -iexec voucher revoke [options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --password \ | password used to encrypt the wallet (unsafe) | -| --wallet-file \ | specify the name of the wallet file to use | -| --wallet-address \ | specify the address of the wallet to use | -| --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | -| --chain \ | chain name from "chain.json" | - ### iexec app manage iExec apps @@ -869,8 +695,6 @@ Options: | --wallet-file \ | specify the name of the wallet file to use | | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | -| --tee | use the Trusted Execution Environment template | -| --tee-framework \ | specify the TEE framework to use | #### iexec app deploy @@ -893,7 +717,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | #### iexec app show @@ -959,7 +782,6 @@ Options: | --raw | use raw output | | --quiet | stop prompting updates | | --chain \ | chain name from "chain.json" | -| --tee-framework \ | specify the TEE framework to use | #### iexec app push-secret @@ -983,7 +805,6 @@ Options: | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | | --secret-value \ | secret value (unsafe) | -| --tee-framework \ | specify the TEE framework to use | #### iexec app publish @@ -1060,7 +881,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | | --force | force perform action without prompting user | | --watch | watch execution status changes | @@ -1071,15 +891,13 @@ Options: | --secret \ | specify the requester secrets mappings (\=\) to use in the app (only available for TEE tasks, use with --tag tee)
\* usage:
\* \[command\] \[args\] --secret 1=login 2=password
\* \[command\] \[args\] --secret 1=login --secret 2=password
\* \[command\] --secret 1=login --secret 2=password -- \[args\]
\* please note that this option is variadic, any number of mappings can be passed, use `--` to stop the list
| | --category \ | id of the task category | | --tag \ | specify tags
\* usage: --tag tag1,tag2 | -| --storage-provider \<"ipfs"\|"dropbox"\> | specify the storage to use to store the result archive | +| --storage-provider \<"dropbox"\|"ipfs"\> | specify the storage to use to store the result archive | | --callback \ | specify the callback address of the request | | --encrypt-result | encrypt the result archive with the beneficiary public key (only available for TEE tasks, use with --tag tee) | | --trust \ | trust level | | --beneficiary \ | specify the beneficiary of the request (default user address) | | --params \ | specify the params of the request
\* usage: --params '{"iexec\_args":"do stuff","iexec\_input\_files":\["https://example.com/file.zip"\]}' | | --skip-preflight-check | skip preflight check, this may result in task execution fail | -| --use-voucher | use the voucher to cover the costs of matching orders | -| --voucher-address \ | specify the voucher contract to use other than the owned voucher | #### iexec app request-execution @@ -1114,7 +932,7 @@ Options: | --category \ | id of the task category | | --tag \ | specify tags
\* usage: --tag tag1,tag2 | | --volume \ | number of run | -| --storage-provider \<"ipfs"\|"dropbox"\> | specify the storage to use to store the result archive | +| --storage-provider \<"dropbox"\|"ipfs"\> | specify the storage to use to store the result archive | | --callback \ | specify the callback address of the request | | --encrypt-result | encrypt the result archive with the beneficiary public key (only available for TEE tasks, use with --tag tee) | | --trust \ | trust level | @@ -1143,7 +961,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | | --force | force perform action without prompting user | | --to \ | receiver address | @@ -1218,7 +1035,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | #### iexec dataset show @@ -1310,7 +1126,6 @@ Options: | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | | --secret-path \ | push the secret from a file | -| --tee-framework \ | specify the TEE framework to use | #### iexec dataset check-secret @@ -1329,7 +1144,6 @@ Options: | --raw | use raw output | | --quiet | stop prompting updates | | --chain \ | chain name from "chain.json" | -| --tee-framework \ | specify the TEE framework to use | #### iexec dataset publish @@ -1406,7 +1220,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | | --force | force perform action without prompting user | | --to \ | receiver address | @@ -1425,7 +1238,6 @@ Commands: - [init](#iexec-workerpool-init) - [deploy](#iexec-workerpool-deploy) -- [set-api-url](#iexec-workerpool-set-api-url) - [show](#iexec-workerpool-show) - [count](#iexec-workerpool-count) - [publish](#iexec-workerpool-publish) @@ -1474,31 +1286,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | -| --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | - -#### iexec workerpool set-api-url - -declare the workerpool API URL on the blockchain - -Usage: - -```sh -iexec workerpool set-api-url [workerpoolAddress] [options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --password \ | password used to encrypt the wallet (unsafe) | -| --wallet-file \ | specify the name of the wallet file to use | -| --wallet-address \ | specify the address of the wallet to use | -| --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | -| --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | #### iexec workerpool show @@ -1623,7 +1410,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | | --force | force perform action without prompting user | | --to \ | receiver address | @@ -1665,7 +1451,6 @@ Options: | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | | --secret-value \ | secret value (unsafe) | -| --tee-framework \ | specify the TEE framework to use | #### iexec requester check-secret @@ -1688,7 +1473,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --tee-framework \ | specify the TEE framework to use | ### iexec order @@ -1785,7 +1569,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | | --force | force perform action without prompting user | | --app \ | specify the app order from the marketplace to fill | @@ -1794,8 +1577,6 @@ Options: | --request \ | specify the requestorder from the marketplace to fill | | --params \ | specify the params of the request, existing request order will be ignored
\* usage: --params '{"iexec\_args":"do stuff","iexec\_input\_files":\["https://example.com/file.zip"\]}' | | --skip-preflight-check | skip preflight check, this may result in task execution fail | -| --use-voucher | use the voucher to cover the costs of matching orders | -| --voucher-address \ | specify the voucher contract to use other than the owned voucher | #### iexec order publish @@ -1873,7 +1654,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | | --force | force perform action without prompting user | | --app | cancel a signed apporder | @@ -2095,7 +1875,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | ### iexec task @@ -2185,7 +1964,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --gas-price \ | set custom gas price for transactions (default unit wei) | | --confirms \ | set custom block count to wait for transactions confirmation (default 1 block) | ### iexec storage @@ -2210,7 +1988,7 @@ initialize the remote storage Usage: ```sh -iexec storage init [provider] [options] +iexec storage init [options] ``` Options: @@ -2226,7 +2004,6 @@ Options: | --chain \ | chain name from "chain.json" | | --force-update | update if already exists | | --token \ | storage provider authorization token (unsafe) | -| --tee-framework \ | specify the TEE framework to use | #### iexec storage check @@ -2235,7 +2012,7 @@ check if the remote storage is initialized Usage: ```sh -iexec storage check [provider] [options] +iexec storage check [options] ``` Options: @@ -2250,7 +2027,6 @@ Options: | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | | --user \ | custom user address | -| --tee-framework \ | specify the TEE framework to use | ### iexec result @@ -2343,7 +2119,6 @@ Options: | --chain \ | chain name from "chain.json" | | --force-update | update if already exists | | --secret-path \ | push the secret from a file | -| --tee-framework \ | specify the TEE framework to use | #### iexec result check-encryption-key @@ -2368,105 +2143,6 @@ Options: | --wallet-address \ | specify the address of the wallet to use | | --keystoredir \ | specify the wallet directory \<"global"\|"local"\|custom\> | | --chain \ | chain name from "chain.json" | -| --tee-framework \ | specify the TEE framework to use | - -### iexec ens - -manage ENS names - -Usage: - -```sh -iexec ens [options] -``` - -Commands: - -- [resolve](#iexec-ens-resolve) -- [lookup](#iexec-ens-lookup) -- [get-owner](#iexec-ens-get-owner) -- [register](#iexec-ens-register) - -#### iexec ens resolve - -resolve an ENS name to an address - -Usage: - -```sh -iexec ens resolve [options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --chain \ | chain name from "chain.json" | - -#### iexec ens lookup - -lookup for the ENS name of an address - -Usage: - -```sh -iexec ens lookup
[options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --chain \ | chain name from "chain.json" | - -#### iexec ens get-owner - -find the the owner address of an ENS name - -Usage: - -```sh -iexec ens get-owner [options] -``` - -Options: - -| option | description | -| --- | --- | -| --raw | use raw output | -| --quiet | stop prompting updates | -| --chain \ | chain name from "chain.json" | - -#### iexec ens register - -register an ENS if needed and setup both ENS resolution and reverse resolution - -Usage: - -```sh -iexec ens register