Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 1 addition & 102 deletions CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,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)
Expand Down Expand Up @@ -742,89 +741,6 @@ Options:
| --gas-price \<amount unit...\> | set custom gas price for transactions (default unit wei) |
| --confirms \<blockCount\> | set custom block count to wait for transactions confirmation (default 1 block) |

### iexec voucher

manage iExec voucher

Usage:

```sh
iexec voucher <command> [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\> | password used to encrypt the wallet (unsafe) |
| --wallet-file \<walletFileName\> | specify the name of the wallet file to use |
| --wallet-address \<walletAddress\> | specify the address of the wallet to use |
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --chain \<name\> | chain name from "chain.json" |
| --user \<address\> | custom user address |

#### iexec voucher authorize

authorize requester to use the voucher

Usage:

```sh
iexec voucher authorize <requester> [options]
```

Options:

| option | description |
| --- | --- |
| --raw | use raw output |
| --quiet | stop prompting updates |
| --password \<password\> | password used to encrypt the wallet (unsafe) |
| --wallet-file \<walletFileName\> | specify the name of the wallet file to use |
| --wallet-address \<walletAddress\> | specify the address of the wallet to use |
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --chain \<name\> | chain name from "chain.json" |

#### iexec voucher revoke

revoke authorization to use the voucher

Usage:

```sh
iexec voucher revoke <requester> [options]
```

Options:

| option | description |
| --- | --- |
| --raw | use raw output |
| --quiet | stop prompting updates |
| --password \<password\> | password used to encrypt the wallet (unsafe) |
| --wallet-file \<walletFileName\> | specify the name of the wallet file to use |
| --wallet-address \<walletAddress\> | specify the address of the wallet to use |
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --chain \<name\> | chain name from "chain.json" |

### iexec app

manage iExec apps
Expand Down Expand Up @@ -869,7 +785,6 @@ Options:
| --wallet-file \<walletFileName\> | specify the name of the wallet file to use |
| --wallet-address \<walletAddress\> | specify the address of the wallet to use |
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --tee | use the Trusted Execution Environment template |
| --tee-framework \<name\> | specify the TEE framework to use |

#### iexec app deploy
Expand Down Expand Up @@ -959,7 +874,6 @@ Options:
| --raw | use raw output |
| --quiet | stop prompting updates |
| --chain \<name\> | chain name from "chain.json" |
| --tee-framework \<name\> | specify the TEE framework to use |

#### iexec app push-secret

Expand All @@ -983,7 +897,6 @@ Options:
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --chain \<name\> | chain name from "chain.json" |
| --secret-value \<secretValue\> | secret value (unsafe) |
| --tee-framework \<name\> | specify the TEE framework to use |

#### iexec app publish

Expand Down Expand Up @@ -1078,8 +991,6 @@ Options:
| --beneficiary \<address\> | specify the beneficiary of the request (default user address) |
| --params \<json\> | specify the params of the request<br/>\* 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 \<voucherAddress\> | specify the voucher contract to use other than the owned voucher |

#### iexec app request-execution

Expand Down Expand Up @@ -1310,7 +1221,6 @@ Options:
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --chain \<name\> | chain name from "chain.json" |
| --secret-path \<secretPath\> | push the secret from a file |
| --tee-framework \<name\> | specify the TEE framework to use |

#### iexec dataset check-secret

Expand All @@ -1329,7 +1239,6 @@ Options:
| --raw | use raw output |
| --quiet | stop prompting updates |
| --chain \<name\> | chain name from "chain.json" |
| --tee-framework \<name\> | specify the TEE framework to use |

#### iexec dataset publish

Expand Down Expand Up @@ -1665,7 +1574,6 @@ Options:
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --chain \<name\> | chain name from "chain.json" |
| --secret-value \<secretValue\> | secret value (unsafe) |
| --tee-framework \<name\> | specify the TEE framework to use |

#### iexec requester check-secret

Expand All @@ -1688,7 +1596,6 @@ Options:
| --wallet-address \<walletAddress\> | specify the address of the wallet to use |
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --chain \<name\> | chain name from "chain.json" |
| --tee-framework \<name\> | specify the TEE framework to use |

### iexec order

Expand Down Expand Up @@ -1794,8 +1701,6 @@ Options:
| --request \<orderHash\> | specify the requestorder from the marketplace to fill |
| --params \<json\> | specify the params of the request, existing request order will be ignored<br/>\* 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 \<voucherAddress\> | specify the voucher contract to use other than the owned voucher |

#### iexec order publish

Expand Down Expand Up @@ -2226,7 +2131,6 @@ Options:
| --chain \<name\> | chain name from "chain.json" |
| --force-update | update if already exists |
| --token \<token\> | storage provider authorization token (unsafe) |
| --tee-framework \<name\> | specify the TEE framework to use |

#### iexec storage check

Expand All @@ -2250,7 +2154,6 @@ Options:
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --chain \<name\> | chain name from "chain.json" |
| --user \<address\> | custom user address |
| --tee-framework \<name\> | specify the TEE framework to use |

### iexec result

Expand Down Expand Up @@ -2343,7 +2246,6 @@ Options:
| --chain \<name\> | chain name from "chain.json" |
| --force-update | update if already exists |
| --secret-path \<secretPath\> | push the secret from a file |
| --tee-framework \<name\> | specify the TEE framework to use |

#### iexec result check-encryption-key

Expand All @@ -2368,7 +2270,6 @@ Options:
| --wallet-address \<walletAddress\> | specify the address of the wallet to use |
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
| --chain \<name\> | chain name from "chain.json" |
| --tee-framework \<name\> | specify the TEE framework to use |

### iexec ens

Expand Down Expand Up @@ -2695,14 +2596,12 @@ The `chain.json` file, located in every iExec project, describes the parameters
- `chains` set the available chains
- optional key `host` set the url of the ethereum node used by the SDK cli on each chain (overwrite default value).
- optional key `hub` set the address of the hub used by the SDK cli on each chain (overwrite default value).
- optional key `sms` set the url of the Secret Management Service used by the SDK cli on each chain (overwrite default value), this key accepts a string or a mapping TEE framework - SMS url.
- optional key `sms` set the url of the Secret Management Service used by the SDK cli on each chain (overwrite default value).
- optional key `resultProxy` set the url of the Result Proxy used by the SDK cli on each chain (overwrite default value).
- optional key `iexecGateway` set the url of the iexec marketplace gateway used by the SDK cli on each chain (overwrite default value).
- optional key `ipfsGateway` set the url of the IPFS gateway used by the SDK cli on each chain (overwrite default value).
- optional key `pocoSubgraph` set the url of the PoCo subgraph used by the SDK cli on each chain (overwrite default value).
- optional key `voucherSubgraph` set the url of the voucher subgraph used by the SDK cli on each chain (overwrite default value).
- optional key `bridge` set the bridge used by the SDK cli when working with bridged networks (sidechain). `bridge.contract` set the address of the RLC bridge on the chain, `bridge.bridgedChainName` set the reference to the bridged network.
- optional key `voucherHub` set the address of the voucher hub contract used by the SDK cli on each chain (overwrite default value).
- optional key `native` specify whether or not the chain native token is RLC (overwrite default value: chain value or `false`).
- optional key `useGas` specify whether or not the chain requires to spend gas to send a transaction (overwrite default value: chain value or `true`).
- optional key `providers` set the backends for public chains
Expand Down
4 changes: 1 addition & 3 deletions cli_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,14 +396,12 @@ The `chain.json` file, located in every iExec project, describes the parameters
- `chains` set the available chains
- optional key `host` set the url of the ethereum node used by the SDK cli on each chain (overwrite default value).
- optional key `hub` set the address of the hub used by the SDK cli on each chain (overwrite default value).
- optional key `sms` set the url of the Secret Management Service used by the SDK cli on each chain (overwrite default value), this key accepts a string or a mapping TEE framework - SMS url.
- optional key `sms` set the url of the Secret Management Service used by the SDK cli on each chain (overwrite default value).
- optional key `resultProxy` set the url of the Result Proxy used by the SDK cli on each chain (overwrite default value).
- optional key `iexecGateway` set the url of the iexec marketplace gateway used by the SDK cli on each chain (overwrite default value).
- optional key `ipfsGateway` set the url of the IPFS gateway used by the SDK cli on each chain (overwrite default value).
- optional key `pocoSubgraph` set the url of the PoCo subgraph used by the SDK cli on each chain (overwrite default value).
- optional key `voucherSubgraph` set the url of the voucher subgraph used by the SDK cli on each chain (overwrite default value).
- optional key `bridge` set the bridge used by the SDK cli when working with bridged networks (sidechain). `bridge.contract` set the address of the RLC bridge on the chain, `bridge.bridgedChainName` set the reference to the bridged network.
- optional key `voucherHub` set the address of the voucher hub contract used by the SDK cli on each chain (overwrite default value).
- optional key `native` specify whether or not the chain native token is RLC (overwrite default value: chain value or `false`).
- optional key `useGas` specify whether or not the chain requires to spend gas to send a transaction (overwrite default value: chain value or `true`).
- optional key `providers` set the backends for public chains
Expand Down
2 changes: 0 additions & 2 deletions docs/-internal-/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
- [Dataset](interfaces/Dataset.md)
- [DatasetDeploymentArgs](interfaces/DatasetDeploymentArgs.md)
- [DatasetorderTemplate](interfaces/DatasetorderTemplate.md)
- [GramineMREnclave](interfaces/GramineMREnclave.md)
- [HashableApporder](interfaces/HashableApporder.md)
- [HashableDatasetorder](interfaces/HashableDatasetorder.md)
- [HashableRequestorder](interfaces/HashableRequestorder.md)
Expand All @@ -50,7 +49,6 @@
- [SignedRequestorder](interfaces/SignedRequestorder.md)
- [SignedWorkerpoolorder](interfaces/SignedWorkerpoolorder.md)
- [Task](interfaces/Task.md)
- [VoucherInfo](interfaces/VoucherInfo.md)
- [Workerpool](interfaces/Workerpool.md)
- [WorkerpoolDeploymentArgs](interfaces/WorkerpoolDeploymentArgs.md)
- [WorkerpoolorderTemplate](interfaces/WorkerpoolorderTemplate.md)
2 changes: 1 addition & 1 deletion docs/-internal-/interfaces/AppDeploymentArgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ app image digest

### mrenclave?

> `optional` **mrenclave**: [`SconeMREnclave`](SconeMREnclave.md) \| [`GramineMREnclave`](GramineMREnclave.md)
> `optional` **mrenclave**: [`SconeMREnclave`](SconeMREnclave.md)

optional for TEE apps only, specify the TEE protocol to use

Expand Down
31 changes: 0 additions & 31 deletions docs/-internal-/interfaces/GramineMREnclave.md

This file was deleted.

67 changes: 0 additions & 67 deletions docs/-internal-/interfaces/VoucherInfo.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ Additionally the [IExec](./classes/IExec.md) module exposes all the following li
- [IExecSecretsModule](./classes/IExecSecretsModule.md) exposes **secrets** methods
- [IExecStorageModule](./classes/IExecStorageModule.md) exposes **storage** methods
- [IExecTaskModule](./classes/IExecTaskModule.md) exposes **task** methods
- [IExecVoucherModule](./classes/IExecVoucherModule.md) exposes **voucher** methods
- [IExecWalletModule](./classes/IExecWalletModule.md) exposes **wallet** methods
- [IExecWorkerpoolModule](./classes/IExecWorkerpoolModule.md) exposes **workerpool** methods

Expand Down
8 changes: 0 additions & 8 deletions docs/classes/IExec.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,14 +156,6 @@ task module

***

### voucher

> **voucher**: [`IExecVoucherModule`](IExecVoucherModule.md)

voucher module

***

### wallet

> **wallet**: [`IExecWalletModule`](IExecWalletModule.md)
Expand Down
Loading
Loading