Releases: iExecBlockchainComputing/iexec-sdk
Releases · iExecBlockchainComputing/iexec-sdk
[8.1.1] 2023-05-22
Changed
- Typescript fixes
[8.1.0] 2023-05-17
Changed
- Typescript fixes
- app orderbook accept
"any"
for the app address to fetch orderbook without filtering on app - dataset orderbook accept
"any"
for the dataset address to fetch orderbook without filtering on dataset
[8.0.0] 2023-04-07
Added
defaultTeeFramework
option forIExecConfig
andchain.json
for choosing the default TEE framework to useiexec app init
option--tee-framework <'scone'|'gramine'>
to specify the TEE framework to use for the app- tee framework tags 'scone' & 'gramine'
- app orderbook accept
"any"
fordataset
,workerpool
,requester
to fetch orderbook without filtering - dataset orderbook accept
"any"
forapp
,workerpool
,requester
to fetch orderbook without filtering - workerpool orderbook accept
"any"
forapp
,dataset
,requester
to fetch orderbook without filtering - requester orderbook accept
"any"
forworkerpool
to fetch orderbook without filtering
Changed
- SMS URL resolution depends on TEE framework (default
scone
) - SMS URL override in
IExecConfig
orchain.json
acceptsRecord<TeeFramework,Url> | string
iexec app push-secret
andapp.pushAppSecretExists(appAddress)
use a TEE framework inferred from app if not specifiediexec app check-secret
andapp.checkAppSecret(appAddress, secret)
use a TEE framework inferred from app if not specifiediexec storage init
andstorage.pushStorageToken(appAddress)
use the default TEE framework if not specifiediexec storage check
andapp.checkStorageTokenExists(appAddress, secret)
use the default TEE framework if not specifiediexec requester check-secret <name>
andsecrets.checkRequesterSecretExists(name)
use the default TEE framework if not specifiediexec requester push-secret <name>
andsecrets.pushRequesterSecret(name, value)
use the default TEE framework if not specifiediexec result check-encryption-key
andresult.checkResultEncryptionKeyExists(address)
use the default TEE framework if not specifiediexec result push-encryption-key
andresult.pushResultEncryptionKey(value)
use the default TEE framework if not specifiediexec dataset check-secret
anddataset.checkDatasetSecretExists(datasetAddress)
use the default TEE framework if not specifiediexec dataset push-secret
anddataset.pushDatasetSecret(datasetAddress, encryptionKey)
use the default TEE framework if not specified- TEE app
mrenclave.provider
has been renamedmrenclave.framework
- [BREAKING] drop support for node 12
- [BREAKING] exports ES modules only, since all NodeJS LTS now supports ES modules natively, commonjs modules are no longer exported.
- if you use commonjs module
require
consider moving to ES module to use static import (ie:import iexecSdk from 'iexec'
) - if moving your project to ES module is not an option, you must use dynamic import to load iExec SDK (ie:
import('iexec').then((iexecSdk) => { ... })
)
- if you use commonjs module
- [BREAKING] 'tee' tag must be combined with a tee framework tag ('scone' or 'gramine')
- [BREAKING]
checkRequest
option is replaced bypreflightCheck
, usepreflightCheck: false
to disable checks - [BREAKING]
--skip-request-check
option is replaced by--skip-preflight-check
- [BREAKING] bellecour is now the default chain initialized in
chain.json
when runningiexec init
- [BREAKING] iExec stack is no longer deployed on mainnet, stack configuration for mainnet is no longer provided
- [BREAKING] iExec enterprise stack is no longer deployed, stack configuration for enterprise is no longer provided
Removed
- [BREAKING] viviani is no longer available in the default configuration
- [BREAKING] goerli is no longer available in the default configuration
- [BREAKING] removed now useless faucet commands
iexec wallet get-RLC
andiexec wallet get-ether
[7.2.1] 2022-07-25
Changed
- TypeScript fixes
[7.2.0] 2022-07-05
Added
- workerpool API url configuration
iexec task debug <taskid> [--logs]
to show offchain informationens.getDefaultDomain(address)
to get the default free to use ENS domain given an address- support for requester secrets
- check dataset secret exists on requestorder check
- check requester secret exists on requestorder check
- app/dataset/workerpool predict address methods
- app/dataset/workerpool check deployed methods
Changed
show
commands display ENS when configurediexec ens register <label> --for <address>
default domain is selected given the nature of--for
address- [DEPRECATED] Node 12 support will be droped
[7.1.0] 2022-04-11
[7.1.0] 2022-04-11
Added
- TypeScript interfaces
providerOptions
can be passed to the constructor to configure ethers default provider on bridged chainethProvider
now accepts network name, network chainId and RPC url, using one of those option will setup an IExecConfig with provider allowing read-only operations (operations requiring a Signer will fail)
Changed
- split lib into
IExecConfig
and independantIExecModule
s to allow modular imports - reintegrated
iexec-contracts-js-client
- fix a bug transforming an Array into a plain object
- documentation refactoring
- fix ENS configure resolution removed useless transaction for EOA
[7.0.2] 2022-02-16
[7.0.2] 2022-02-16
Added
- observable ENS configuration with
ens.obsConfigureResolution(label, address)
- observable bridge to mainchain with
wallet.obsBridgeToMainchain(amount)
- observable bridge to sidechain with
wallet.obsBridgeToSidechain(amount)
Changed
- update deps
[7.0.0] 2021-12-17
[7.0.0] 2021-12-17
Added
- ENS resolution on iExec sidechains and custom networks
- ENS methods in CLI & lib:
iexec ens resolve <name>
andiexec.ens.resolveName(name)
iexec ens lookup <address>
andiexec.ens.lookupAddress(addres)
iexec ens get-owner <name>
andiexec.ens.getOwner(name)
iexec ens register <label>
iexec.ens.claimName(label, domain)
iexec.ens.configureResolution(name, address)
Changed
- fix
iexec registry validate app
to support new mrenclave format
[6.0.1] 2021-12-8
[6.0.1] 2021-12-8
Changed
- update default ipfs gateway
[6.0.0] 2021-07-19
[6.0.0] 2021-07-19
Added
- client-side (in browser) dataset encryption is now possible.
- confirms option allows to set the number of block to wait for transaction confirmation.
iexec app init --tee
init the TEE app template
Changed
- [BREAKING]
iexec init
set default chainviviani
(iExec sidecahin testnet) inchain.json
, previously wasgoerli
(using--chain
option still overrides thechain.json
configuration). - [BREAKING] SCONE file system encryption is dropped in favor of AES-256-CBC for dataset encryption. Existing datasets will stop working, these datasets original files MUST be re-encrypted using
iexec dataset encrypt
and republished. - [BREAKING] changed generated dataset keys and encrypted datasets files naming pattern.
- [BREAKING] a dataset is now a single file. in order to pass a tree structure, the dataset owner must package all the files in a single archive file, applications that previously used multiple files from a single dataset must handle unwrapping files from an archive file.
- [BREAKING] app
mrenclave
format changed from string to object previously deployed TEE apps must be rebuilt and redeployed with v6 workflow - [BREAKING]
iexec.task.obsTask()
now returnsPromise<Observable>
previously it returnedObservabe
- [BREAKING]
iexec.deal.obsDeal()
now returnsPromise<Observable>
previously it returnedObservabe
- [DEPRECATED]
iexec wallet getETH
is now an alias toiexec wallet get-ether
and will be removed in a next version - [DEPRECATED]
iexec wallet getRLC
is now an alias toiexec wallet get-RLC
and will be removed in a next version - [DEPRECATED]
iexec wallet sendETH
is now an alias toiexec wallet send-ether
and will be removed in a next version - [DEPRECATED]
iexec wallet sendRLC
will be removed in a next version, useiexec wallet send-RLC
BEWARE default unit is RLC! chainId
is no longer required to callIExec
constructor, the chainId is lazily fetched from the provider- fix
iexec wallet send-ether
return sentamount
in wei - fix
fetchWorkerpoolOrderbook()
to includerequester
restricted workerpoolorders (fixapp run
using requester restricted workerpoolorder) - fix
iexec app run
--gas-price
option - removed
mrenclave
from app default template iexec appr run --watch
andiexec deal show --watch
added tasks status details
Removed
- [BREAKING]
--algorithm
option is removed fromiexec dataset encrypt
- [BREAKING] removed
iexec.network.id
andiexec.network.isSidechain
, useiexec.network.getNetwork() => Promise<{chainId: String, isSidechain: Boolean}>
- [BREAKING] tee post-compute configuration responsibility has been transferred to the SMS and is no longer supported by requestorder. any custom
iexec_tee_post_compute_image
andiexec_tee_post_compute_fingerprint
will be silently removed fromrequestorder.params
. - [BREAKING] drop previously deprecated
iexec wallet show --raw
returned json keybalance.ETH
, usebalance.ether
instead - [BREAKING] drop previously deprecated
bridge.bridgedChainId
inchain.json
usebridge.bridgedChainName
instead - [BREAKING] drop previously deprecated
iexec.orderbook.fetchWorkerpoolOrderbook(category, options)
usecategory
as an option ofiexec.orderbook.fetchWorkerpoolOrderbook(options)
- [BREAKING] drop previously deprecated
iexec.orderbook.fetchRequestOrderbook(category, options)
usecategory
as an option ofiexec.orderbook.fetchRequestOrderbook(options)
- [BREAKING] drop previously deprecated
iexec.orderbook.fetchAppOrderbook()
returned valueappOrders
useorders
- [BREAKING] drop previously deprecated
iexec.orderbook.fetchDatasetOrderbook()
returned valuedatasetOrders
useorders
- [BREAKING] drop previously deprecated
iexec.orderbook.fetchWorkerpoolOrderbook()
returned valueworkerpoolOrders
useorders
- [BREAKING] drop previously deprecated
iexec.orderbook.fetchRequestOrderbook()
returned valuerequestOrders
useorders
- [BREAKING] drop previously deprecated
task.waitForTaskStatusChange(taskid, initialStatus)
usetask.obsTask(taskid)