Skip to content

Commit 64ed8c1

Browse files
feat!: remove voucher support (#511)
1 parent 596e3f1 commit 64ed8c1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+125
-3814
lines changed

CLI.md

Lines changed: 0 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,6 @@ Commands:
302302
- [init](#iexec-init)
303303
- [iexec wallet](#iexec-wallet)
304304
- [iexec account](#iexec-account)
305-
- [iexec voucher](#iexec-voucher)
306305
- [iexec app](#iexec-app)
307306
- [iexec dataset](#iexec-dataset)
308307
- [iexec workerpool](#iexec-workerpool)
@@ -742,89 +741,6 @@ Options:
742741
| --gas-price \<amount unit...\> | set custom gas price for transactions (default unit wei) |
743742
| --confirms \<blockCount\> | set custom block count to wait for transactions confirmation (default 1 block) |
744743

745-
### iexec voucher
746-
747-
manage iExec voucher
748-
749-
Usage:
750-
751-
```sh
752-
iexec voucher <command> [options]
753-
```
754-
755-
Commands:
756-
757-
- [show](#iexec-voucher-show)
758-
- [authorize](#iexec-voucher-authorize)
759-
- [revoke](#iexec-voucher-revoke)
760-
761-
#### iexec voucher show
762-
763-
show voucher iExec details
764-
765-
Usage:
766-
767-
```sh
768-
iexec voucher show [options]
769-
```
770-
771-
Options:
772-
773-
| option | description |
774-
| --- | --- |
775-
| --raw | use raw output |
776-
| --quiet | stop prompting updates |
777-
| --password \<password\> | password used to encrypt the wallet (unsafe) |
778-
| --wallet-file \<walletFileName\> | specify the name of the wallet file to use |
779-
| --wallet-address \<walletAddress\> | specify the address of the wallet to use |
780-
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
781-
| --chain \<name\> | chain name from "chain.json" |
782-
| --user \<address\> | custom user address |
783-
784-
#### iexec voucher authorize
785-
786-
authorize requester to use the voucher
787-
788-
Usage:
789-
790-
```sh
791-
iexec voucher authorize <requester> [options]
792-
```
793-
794-
Options:
795-
796-
| option | description |
797-
| --- | --- |
798-
| --raw | use raw output |
799-
| --quiet | stop prompting updates |
800-
| --password \<password\> | password used to encrypt the wallet (unsafe) |
801-
| --wallet-file \<walletFileName\> | specify the name of the wallet file to use |
802-
| --wallet-address \<walletAddress\> | specify the address of the wallet to use |
803-
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
804-
| --chain \<name\> | chain name from "chain.json" |
805-
806-
#### iexec voucher revoke
807-
808-
revoke authorization to use the voucher
809-
810-
Usage:
811-
812-
```sh
813-
iexec voucher revoke <requester> [options]
814-
```
815-
816-
Options:
817-
818-
| option | description |
819-
| --- | --- |
820-
| --raw | use raw output |
821-
| --quiet | stop prompting updates |
822-
| --password \<password\> | password used to encrypt the wallet (unsafe) |
823-
| --wallet-file \<walletFileName\> | specify the name of the wallet file to use |
824-
| --wallet-address \<walletAddress\> | specify the address of the wallet to use |
825-
| --keystoredir \<path\> | specify the wallet directory \<"global"\|"local"\|custom\> |
826-
| --chain \<name\> | chain name from "chain.json" |
827-
828744
### iexec app
829745

830746
manage iExec apps
@@ -1078,8 +994,6 @@ Options:
1078994
| --beneficiary \<address\> | specify the beneficiary of the request (default user address) |
1079995
| --params \<json\> | specify the params of the request<br/>\* usage: --params '{"iexec\_args":"do stuff","iexec\_input\_files":\["https://example.com/file.zip"\]}' |
1080996
| --skip-preflight-check | skip preflight check, this may result in task execution fail |
1081-
| --use-voucher | use the voucher to cover the costs of matching orders |
1082-
| --voucher-address \<voucherAddress\> | specify the voucher contract to use other than the owned voucher |
1083997

1084998
#### iexec app request-execution
1085999

@@ -1794,8 +1708,6 @@ Options:
17941708
| --request \<orderHash\> | specify the requestorder from the marketplace to fill |
17951709
| --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"\]}' |
17961710
| --skip-preflight-check | skip preflight check, this may result in task execution fail |
1797-
| --use-voucher | use the voucher to cover the costs of matching orders |
1798-
| --voucher-address \<voucherAddress\> | specify the voucher contract to use other than the owned voucher |
17991711

18001712
#### iexec order publish
18011713

@@ -2700,9 +2612,7 @@ The `chain.json` file, located in every iExec project, describes the parameters
27002612
- optional key `iexecGateway` set the url of the iexec marketplace gateway used by the SDK cli on each chain (overwrite default value).
27012613
- optional key `ipfsGateway` set the url of the IPFS gateway used by the SDK cli on each chain (overwrite default value).
27022614
- optional key `pocoSubgraph` set the url of the PoCo subgraph used by the SDK cli on each chain (overwrite default value).
2703-
- optional key `voucherSubgraph` set the url of the voucher subgraph used by the SDK cli on each chain (overwrite default value).
27042615
- 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.
2705-
- optional key `voucherHub` set the address of the voucher hub contract used by the SDK cli on each chain (overwrite default value).
27062616
- optional key `native` specify whether or not the chain native token is RLC (overwrite default value: chain value or `false`).
27072617
- optional key `useGas` specify whether or not the chain requires to spend gas to send a transaction (overwrite default value: chain value or `true`).
27082618
- optional key `providers` set the backends for public chains

cli_template.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -401,9 +401,7 @@ The `chain.json` file, located in every iExec project, describes the parameters
401401
- optional key `iexecGateway` set the url of the iexec marketplace gateway used by the SDK cli on each chain (overwrite default value).
402402
- optional key `ipfsGateway` set the url of the IPFS gateway used by the SDK cli on each chain (overwrite default value).
403403
- optional key `pocoSubgraph` set the url of the PoCo subgraph used by the SDK cli on each chain (overwrite default value).
404-
- optional key `voucherSubgraph` set the url of the voucher subgraph used by the SDK cli on each chain (overwrite default value).
405404
- 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.
406-
- optional key `voucherHub` set the address of the voucher hub contract used by the SDK cli on each chain (overwrite default value).
407405
- optional key `native` specify whether or not the chain native token is RLC (overwrite default value: chain value or `false`).
408406
- optional key `useGas` specify whether or not the chain requires to spend gas to send a transaction (overwrite default value: chain value or `true`).
409407
- optional key `providers` set the backends for public chains

docs/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ Additionally the [IExec](./classes/IExec.md) module exposes all the following li
8282
- [IExecSecretsModule](./classes/IExecSecretsModule.md) exposes **secrets** methods
8383
- [IExecStorageModule](./classes/IExecStorageModule.md) exposes **storage** methods
8484
- [IExecTaskModule](./classes/IExecTaskModule.md) exposes **task** methods
85-
- [IExecVoucherModule](./classes/IExecVoucherModule.md) exposes **voucher** methods
8685
- [IExecWalletModule](./classes/IExecWalletModule.md) exposes **wallet** methods
8786
- [IExecWorkerpoolModule](./classes/IExecWorkerpoolModule.md) exposes **workerpool** methods
8887

docs/classes/IExec.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ module exposing all the iExec SDK modules
3232
- [secrets](IExec.md#secrets)
3333
- [storage](IExec.md#storage)
3434
- [task](IExec.md#task)
35-
- [voucher](IExec.md#voucher)
3635
- [wallet](IExec.md#wallet)
3736
- [workerpool](IExec.md#workerpool)
3837

@@ -181,14 +180,6 @@ task module
181180

182181
___
183182

184-
### voucher
185-
186-
**voucher**: [`IExecVoucherModule`](IExecVoucherModule.md)
187-
188-
voucher module
189-
190-
___
191-
192183
### wallet
193184

194185
**wallet**: [`IExecWalletModule`](IExecWalletModule.md)

docs/classes/IExecConfig.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ const wallet = IExecWalletModule.fromConfig(config);
3838
- [resolvePocoSubgraphURL](IExecConfig.md#resolvepocosubgraphurl)
3939
- [resolveResultProxyURL](IExecConfig.md#resolveresultproxyurl)
4040
- [resolveSmsURL](IExecConfig.md#resolvesmsurl)
41-
- [resolveVoucherHubAddress](IExecConfig.md#resolvevoucherhubaddress)
42-
- [resolveVoucherSubgraphURL](IExecConfig.md#resolvevouchersubgraphurl)
4341

4442
## Constructors
4543

@@ -237,29 +235,3 @@ resolve the current SMS URL
237235
#### Returns
238236

239237
`Promise`<`string`\>
240-
241-
___
242-
243-
### resolveVoucherHubAddress
244-
245-
**resolveVoucherHubAddress**(): `Promise`<``null`` \| `string`\>
246-
247-
resolve the current VoucherHub contract address
248-
returns `null` if not available
249-
250-
#### Returns
251-
252-
`Promise`<``null`` \| `string`\>
253-
254-
___
255-
256-
### resolveVoucherSubgraphURL
257-
258-
**resolveVoucherSubgraphURL**(): `Promise`<``null`` \| `string`\>
259-
260-
resolve the current voucher subgraph URL
261-
returns `null` if not available
262-
263-
#### Returns
264-
265-
`Promise`<``null`` \| `string`\>

docs/classes/IExecModule.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ module base
3636

3737
[`IExecTaskModule`](IExecTaskModule.md)
3838

39-
[`IExecVoucherModule`](IExecVoucherModule.md)
40-
4139
[`IExecWalletModule`](IExecWalletModule.md)
4240

4341
[`IExecWorkerpoolModule`](IExecWorkerpoolModule.md)

docs/classes/IExecOrderModule.md

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ ___
335335

336336
### estimateMatchOrders
337337

338-
**estimateMatchOrders**(`orders`, `options?`): `Promise`<{ `sponsored`: [`BN`](utils.BN.md) ; `total`: [`BN`](utils.BN.md) ; `volume`: [`BN`](utils.BN.md) }\>
338+
**estimateMatchOrders**(`orders`): `Promise`<{ `sponsored`: [`BN`](utils.BN.md) ; `total`: [`BN`](utils.BN.md) ; `volume`: [`BN`](utils.BN.md) }\>
339339

340340
estimates the cost of matching the provided orders
341341

@@ -347,24 +347,20 @@ const orders = {
347347
workerpoolorder,
348348
requestorder,
349349
};
350-
const result = await estimateMatchOrders(orders, {useVoucher: true});
350+
const result = await estimateMatchOrders(orders);
351351
console.log(`executable volume: ${result.volume} tasks`);
352352
console.log(`total cost for matching orders: ${result.total} nRLC`);
353-
console.log(`sponsored cost covered by voucher: ${result.sponsored} nRLC`);
354353
```
355354

356355
#### Parameters
357356

358-
| Name | Type | Description |
359-
| :------ | :------ | :------ |
360-
| `orders` | `Object` | - |
361-
| `orders.apporder` | [`ConsumableApporder`](../interfaces/internal_.ConsumableApporder.md) | - |
362-
| `orders.datasetorder?` | [`ConsumableDatasetorder`](../interfaces/internal_.ConsumableDatasetorder.md) | - |
363-
| `orders.requestorder` | [`ConsumableRequestorder`](../interfaces/internal_.ConsumableRequestorder.md) | - |
364-
| `orders.workerpoolorder` | [`ConsumableWorkerpoolorder`](../interfaces/internal_.ConsumableWorkerpoolorder.md) | - |
365-
| `options?` | `Object` | - |
366-
| `options.useVoucher?` | `boolean` | use a voucher contract to sponsor the deal |
367-
| `options.voucherAddress?` | `string` | override the voucher contract to use, must be combined with `useVoucher: true` the user must be authorized by the voucher's owner to use it |
357+
| Name | Type |
358+
| :------ | :------ |
359+
| `orders` | `Object` |
360+
| `orders.apporder` | [`ConsumableApporder`](../interfaces/internal_.ConsumableApporder.md) |
361+
| `orders.datasetorder?` | [`ConsumableDatasetorder`](../interfaces/internal_.ConsumableDatasetorder.md) |
362+
| `orders.requestorder` | [`ConsumableRequestorder`](../interfaces/internal_.ConsumableRequestorder.md) |
363+
| `orders.workerpoolorder` | [`ConsumableWorkerpoolorder`](../interfaces/internal_.ConsumableWorkerpoolorder.md) |
368364

369365
#### Returns
370366

@@ -489,17 +485,15 @@ console.log(`created deal ${dealid} in tx ${txHash}`);
489485

490486
#### Parameters
491487

492-
| Name | Type | Description |
493-
| :------ | :------ | :------ |
494-
| `orders` | `Object` | - |
495-
| `orders.apporder` | [`ConsumableApporder`](../interfaces/internal_.ConsumableApporder.md) | - |
496-
| `orders.datasetorder?` | [`ConsumableDatasetorder`](../interfaces/internal_.ConsumableDatasetorder.md) | - |
497-
| `orders.requestorder` | [`ConsumableRequestorder`](../interfaces/internal_.ConsumableRequestorder.md) | - |
498-
| `orders.workerpoolorder` | [`ConsumableWorkerpoolorder`](../interfaces/internal_.ConsumableWorkerpoolorder.md) | - |
499-
| `options?` | `Object` | - |
500-
| `options.preflightCheck?` | `boolean` | - |
501-
| `options.useVoucher?` | `boolean` | use a voucher contract to sponsor the deal |
502-
| `options.voucherAddress?` | `string` | override the voucher contract to use, must be combined with `useVoucher: true` the user must be authorized by the voucher's owner to use it |
488+
| Name | Type |
489+
| :------ | :------ |
490+
| `orders` | `Object` |
491+
| `orders.apporder` | [`ConsumableApporder`](../interfaces/internal_.ConsumableApporder.md) |
492+
| `orders.datasetorder?` | [`ConsumableDatasetorder`](../interfaces/internal_.ConsumableDatasetorder.md) |
493+
| `orders.requestorder` | [`ConsumableRequestorder`](../interfaces/internal_.ConsumableRequestorder.md) |
494+
| `orders.workerpoolorder` | [`ConsumableWorkerpoolorder`](../interfaces/internal_.ConsumableWorkerpoolorder.md) |
495+
| `options?` | `Object` |
496+
| `options.preflightCheck?` | `boolean` |
503497

504498
#### Returns
505499

0 commit comments

Comments
 (0)