Skip to content

Commit

Permalink
Merge pull request #285 from iExecBlockchainComputing/release/v8.10.1
Browse files Browse the repository at this point in the history
Release/v8.10.1

## [8.10.1]

### Changed

- Typescript fixes
- fix an issue occurring when network 134 is already registered on ethers
- doc fixes
  • Loading branch information
PierreJeanjacquot authored Aug 26, 2024
2 parents 7436858 + 2c6fb3e commit 6845ca3
Show file tree
Hide file tree
Showing 17 changed files with 42 additions and 32 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

All notable changes to this project will be documented in this file.

## [8.10.1] 2024-08-26

### Changed

- Typescript fixes
- fix an issue occurring when network 134 is already registered on ethers
- doc fixes

## [8.10.0] 2024-07-24

### Added
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/Observable.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

**subscribe**(`callbacks`): () => `void`

subscribe to a data source events via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned unsubscribe method.
subscribe to a data source events via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.

return the `unsubscribe: () => void` method.

Expand All @@ -59,7 +59,7 @@ return the `unsubscribe: () => void` method.

▸ (): `void`

subscribe to a data source events via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned unsubscribe method.
subscribe to a data source events via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.

return the `unsubscribe: () => void` method.

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/internal_.BridgeObservable.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

**subscribe**(`callbacks`): () => `void`

subscribe and start the bridge process to transfer tokens from one chain to another until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned cancel method.
subscribe and start the bridge process to transfer tokens from one chain to another until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned cancel method.

return the `cancel: () => void` method.

Expand All @@ -61,17 +61,17 @@ data:
| Name | Type |
| :------ | :------ |
| `callbacks` | `Object` |
| `callbacks.complete` | () => `any` |
| `callbacks.error` | (`error`: `Error`) => `any` |
| `callbacks.next` | (`data`: { `bridgeAddress?`: `string` ; `dailyLimit?`: [`BN`](utils.BN.md) ; `maxPerTx?`: [`BN`](utils.BN.md) ; `message`: ``"CHECK_BRIDGE_POLICY"`` \| ``"BRIDGE_POLICY_CHECKED"`` \| ``"CHECK_BRIDGE_LIMIT"`` \| ``"BRIDGE_LIMIT_CHECKED"`` \| ``"SEND_TO_BRIDGE_TX_REQUEST"`` \| ``"SEND_TO_BRIDGE_TX_SUCCESS"`` \| ``"WAIT_RECEIVE_TX"`` \| ``"RECEIVE_TX_SUCCESS"`` ; `minPerTx?`: [`BN`](utils.BN.md) ; `totalSpentPerDay?`: [`BN`](utils.BN.md) ; `txHash?`: `string` }) => `any` |
| `callbacks.complete?` | () => `any` |
| `callbacks.error?` | (`error`: `Error`) => `any` |
| `callbacks.next?` | (`data`: { `bridgeAddress?`: `string` ; `dailyLimit?`: [`BN`](utils.BN.md) ; `maxPerTx?`: [`BN`](utils.BN.md) ; `message`: ``"CHECK_BRIDGE_POLICY"`` \| ``"BRIDGE_POLICY_CHECKED"`` \| ``"CHECK_BRIDGE_LIMIT"`` \| ``"BRIDGE_LIMIT_CHECKED"`` \| ``"SEND_TO_BRIDGE_TX_REQUEST"`` \| ``"SEND_TO_BRIDGE_TX_SUCCESS"`` \| ``"WAIT_RECEIVE_TX"`` \| ``"RECEIVE_TX_SUCCESS"`` ; `minPerTx?`: [`BN`](utils.BN.md) ; `totalSpentPerDay?`: [`BN`](utils.BN.md) ; `txHash?`: `string` }) => `any` |

#### Returns

`fn`

▸ (): `void`

subscribe and start the bridge process to transfer tokens from one chain to another until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned cancel method.
subscribe and start the bridge process to transfer tokens from one chain to another until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned cancel method.

return the `cancel: () => void` method.

Expand Down
4 changes: 2 additions & 2 deletions docs/classes/internal_.DealObservable.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

**subscribe**(`callbacks`): () => `void`

subscribe to deal updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned unsubscribe method.
subscribe to deal updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.

return the `unsubscribe: () => void` method.

Expand All @@ -66,7 +66,7 @@ data:

▸ (): `void`

subscribe to deal updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned unsubscribe method.
subscribe to deal updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.

return the `unsubscribe: () => void` method.

Expand Down
4 changes: 2 additions & 2 deletions docs/classes/internal_.ENSConfigurationObservable.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

**subscribe**(`callbacks`): () => `void`

subscribe and start the ENS configuration process until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned cancel method.
subscribe and start the ENS configuration process until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned cancel method.

return the `cancel: () => void` method.

Expand Down Expand Up @@ -73,7 +73,7 @@ data:

▸ (): `void`

subscribe and start the ENS configuration process until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned cancel method.
subscribe and start the ENS configuration process until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned cancel method.

return the `cancel: () => void` method.

Expand Down
4 changes: 2 additions & 2 deletions docs/classes/internal_.TaskObservable.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

**subscribe**(`callbacks`): () => `void`

subscribe to task updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned unsubscribe method.
subscribe to task updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.

return the `unsubscribe: () => void` method.

Expand All @@ -67,7 +67,7 @@ data:

▸ (): `void`

subscribe to task updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned unsubscribe method.
subscribe to task updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.

return the `unsubscribe: () => void` method.

Expand Down
2 changes: 1 addition & 1 deletion docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ ___

Ƭ **NRLCAmount**: `number` \| `string` \| [`BN`](classes/utils.BN.md)

nRLC amount (nRLC stands for nano RLC, the smallest sub-division of the RLC token: 1 RLC = 1,000,000,000 RLC).
nRLC amount (nRLC stands for nano RLC, the smallest sub-division of the RLC token: 1 RLC = 1,000,000,000 nRLC).

named units ('nRLC', 'RLC') can be used with the format `${amount} ${unit}`

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "iexec",
"version": "8.10.0",
"version": "8.10.1",
"description": "iExec SDK",
"bin": {
"iexec": "./dist/esm/cli/cmd/iexec.js"
Expand Down
2 changes: 1 addition & 1 deletion src/common/generated/sdk/package.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// this file is auto generated do not edit it
/* eslint-disable */
export const name = "iexec";
export const version = "8.10.0";
export const version = "8.10.1";
export const description = "iExec SDK";
export default { name, version, description };
2 changes: 1 addition & 1 deletion src/common/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ export type OrderHash = Bytes32;
*/
export type WeiAmount = number | string | BN;
/**
* nRLC amount (nRLC stands for nano RLC, the smallest sub-division of the RLC token: 1 RLC = 1,000,000,000 RLC).
* nRLC amount (nRLC stands for nano RLC, the smallest sub-division of the RLC token: 1 RLC = 1,000,000,000 nRLC).
*
* named units ('nRLC', 'RLC') can be used with the format `${amount} ${unit}`
*
Expand Down
12 changes: 7 additions & 5 deletions src/common/utils/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,10 @@ export const getChainDefaults = ({ id, flavour }) => ({
export const isEnterpriseEnabled = (id) => !!enterpriseEnabledMap[id];

// register ethers unknown networks
const bellecourNetwork = new Network(networkMap[134].name, 134).attachPlugin(
new EnsPlugin(ensMap[134].registry, 134),
);
Network.register(bellecourNetwork.chainId, () => bellecourNetwork);
Network.register(bellecourNetwork.name, () => bellecourNetwork);
if (Network.from(134).name === 'unknown') {
const bellecourNetwork = new Network(networkMap[134].name, 134).attachPlugin(
new EnsPlugin(ensMap[134].registry, 134),
);
Network.register(bellecourNetwork.chainId, () => bellecourNetwork);
Network.register(bellecourNetwork.name, () => bellecourNetwork);
}
2 changes: 1 addition & 1 deletion src/common/utils/reactive.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export class Observable {
/**
* subscribe to a data source events via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned unsubscribe method.
* subscribe to a data source events via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.
*
* return the `unsubscribe: () => void` method.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/lib/IExecDealModule.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {

declare class DealObservable extends Observable {
/**
* subscribe to deal updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned unsubscribe method.
* subscribe to deal updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.
*
* return the `unsubscribe: () => void` method.
*
Expand Down
2 changes: 1 addition & 1 deletion src/lib/IExecENSModule.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Address, ENS, TxHash } from '../common/types.js';

declare class ENSConfigurationObservable extends Observable {
/**
* subscribe and start the ENS configuration process until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned cancel method.
* subscribe and start the ENS configuration process until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned cancel method.
*
* return the `cancel: () => void` method.
*
Expand Down
2 changes: 1 addition & 1 deletion src/lib/IExecTaskModule.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ interface Task {

declare class TaskObservable extends Observable {
/**
* subscribe to task updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned unsubscribe method.
* subscribe to task updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.
*
* return the `unsubscribe: () => void` method.
*
Expand Down
8 changes: 4 additions & 4 deletions src/lib/IExecWalletModule.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { Observable } from '../common/utils/reactive.js';

declare class BridgeObservable extends Observable {
/**
* subscribe and start the bridge process to transfer tokens from one chain to another until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the retruned cancel method.
* subscribe and start the bridge process to transfer tokens from one chain to another until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned cancel method.
*
* return the `cancel: () => void` method.
*
Expand Down Expand Up @@ -47,7 +47,7 @@ declare class BridgeObservable extends Observable {
* | `WAIT_RECEIVE_TX` | sent once if the bridged chain is configured | `bridgeAddress` |
* | `RECEIVE_TX_SUCCESS` | sent once if the bridged chain is configured | `txHash` |
*/
next: (data: {
next?: (data: {
message:
| 'CHECK_BRIDGE_POLICY'
| 'BRIDGE_POLICY_CHECKED'
Expand All @@ -69,13 +69,13 @@ declare class BridgeObservable extends Observable {
*
* no other callback is fired after firing `complete()`
*/
complete: () => any;
complete?: () => any;
/**
* callback fired once when an error occurs
*
* no other callback is fired after firing `error(error: Error)`
*/
error: (error: Error) => any;
error?: (error: Error) => any;
}): /**
* `cancel: () => void` method, calling this method cancels the subscription
*
Expand Down

0 comments on commit 6845ca3

Please sign in to comment.