Skip to content

Commit 3549bf4

Browse files
r0qsmatheusaaguiarcameel
committed
Update note about old libsolc API
Co-authored-by: matheusaaguiar <[email protected]> Co-authored-by: Kamil Śliwak <[email protected]>
1 parent 426df63 commit 3549bf4

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,9 @@ The low-level API is as follows:
205205
For examples how to use them, please refer to the README of the above mentioned solc-js releases.
206206

207207
**Note**: These low-level functions remain available for compatibility reasons.
208-
However, they were superseded by the `compile()` function and are no longer required in newer versions. The functions `compileSingle`, `compileMulti` and `compileCallback` are always `null` in the newer versions.
208+
However, they were superseded by the `compile()` function and are no longer required.
209+
Starting from version `0.5.0+commit.1d4f565a`, the functions `compileSingle`, `compileMulti`, and `compileCallback` are always `null` when using newer solc binary versions.
210+
It is recommended to use the latest release of solc-js, but it should also handle all the older solc binaries down to `0.1.x`.
209211

210212
### Using with Electron
211213

@@ -250,7 +252,7 @@ solc.loadRemoteVersion('latest', function(err, solcSnapshot) {
250252

251253
The version **must** be in the long format.
252254
Thus, if you would like to use version `v0.8.17` you need to include the commit hash of the release.
253-
You can extract the long version string for each version from the [public available release list](https://binaries.soliditylang.org/bin/list.json).
255+
You can extract the long version string for each version from the [publicly available release list](https://binaries.soliditylang.org/bin/list.json).
254256

255257
```javascript
256258
solc.loadRemoteVersion('v0.8.17+commit.8df45f5f', function(err, solcSnapshot) { /* ... */ });

0 commit comments

Comments
 (0)