Skip to content
Merged
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
392 changes: 12 additions & 380 deletions CLI.md

Large diffs are not rendered by default.

60 changes: 8 additions & 52 deletions cli_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down Expand Up @@ -103,8 +103,7 @@ iexec storage init # initialize your remote storage
> "default": ...,
> "chains": {
> ...
> "mainnet": {
> "id": "1",
> "arbitrum-mainnet": {
> "host": "http://localhost:8545"
> }
> }
Expand Down Expand Up @@ -396,67 +395,24 @@ 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 `resultProxy` set the url of the Result Proxy 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).
- 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
- optional key `alchemy` set Alchemy API Token
- optional key `etherscan` set Etherscan API Token
- optional key `infura` set INFURA Project ID or ProjectID and Project Secret
- optional key `quorum` set minimum number of backends that must agree before forwarding blockchain responses

```json
{
"default": "bellecour",
"default": "arbitrum-sepolia-testnet",
"chains": {
"dev": {
"host": "http://localhost:8545",
"id": "65535",
"sms": {
"scone": "http://localhost:5000"
},
"resultProxy": "http://localhost:8089",
"sms": "http://localhost:5000",
"ipfsGateway": "http://localhost:8080",
"hub": "0xC129e7917b7c7DeDfAa5Fff1FB18d5D7050fE8ca",
"bridge": {
"contract": "0x1e32aFA55854B6c015D284E3ccA9aA5a463A1418",
"bridgedChainName": "dev-sidechain"
}
"hub": "0xC129e7917b7c7DeDfAa5Fff1FB18d5D7050fE8ca"
},
"dev-sidechain": {
"host": "http://localhost:18545",
"id": "123456",
"sms": {
"scone": "http://localhost:15000"
},
"resultProxy": "http://localhost:18089",
"ipfsGateway": "http://localhost:18080",
"native": true,
"useGas": false,
"hub": "0xC129e7917b7c7DeDfAa5Fff1FB18d5D7050fE8ca",
"bridge": {
"contract": "0x1e32aFA55854B6c015D284E3ccA9aA5a463A1418",
"bridgedChainName": "development"
}
},
"mainnet": {},
"bellecour": {}
},
"providers": {
"alchemy": "ALCHEMY_API_KEY",
"etherscan": "ETHERSCAN_API_KEY",
"infura": {
"projectId": "INFURA_PROJECT_ID",
"projectSecret": "INFURA_PROJECT_SECRET"
},
"quorum": 1
"arbitrum-sepolia-testnet": {},
"arbitrum-mainnet": {}
}
}
```
Expand Down
5 changes: 0 additions & 5 deletions docs/-internal-/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@

## Classes

- [BridgeObservable](classes/BridgeObservable.md)
- [DealObservable](classes/DealObservable.md)
- [ENSConfigurationObservable](classes/ENSConfigurationObservable.md)
- [IExecContractsClient](classes/IExecContractsClient.md)
- [TaskObservable](classes/TaskObservable.md)

Expand All @@ -27,7 +25,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 @@ -40,7 +37,6 @@
- [PublishedWorkerpoolorder](interfaces/PublishedWorkerpoolorder.md)
- [RequestorderParams](interfaces/RequestorderParams.md)
- [RequestorderTemplate](interfaces/RequestorderTemplate.md)
- [SconeMREnclave](interfaces/SconeMREnclave.md)
- [SignableApporder](interfaces/SignableApporder.md)
- [SignableDatasetorder](interfaces/SignableDatasetorder.md)
- [SignableRequestorder](interfaces/SignableRequestorder.md)
Expand All @@ -50,7 +46,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)
97 changes: 0 additions & 97 deletions docs/-internal-/classes/BridgeObservable.md

This file was deleted.

101 changes: 0 additions & 101 deletions docs/-internal-/classes/ENSConfigurationObservable.md

This file was deleted.

Loading
Loading