Bring library into 2019

simolus3 · May 4, 2019 · d075457 · d075457
1 parent 8c2cd0e
commit d075457
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.0.0
+Basically a complete rewrite of the library - countless bug fixes, a more fluent
+and consistent api and more features:
+- experimental api to perform expensive operations in a background isolate. Set
+`enableBackgroundIsolate` to true when creating a `Web3Client` to try it out.
+- Events! Use `addedBlocks`, `pendingTransactions` and `events` for auto-updating
+streams.
+- The client now has a `dispose()` method which should be called to stop the 
+background isolate and terminate all running streams.
+
+This version contains breaking changes! Here is an overview listing some of them.
+
+| Before        | Updated API  |
+| :------------- | -----:|
+| Creating credentials via `Credentials.fromPrivateKeyHex`   | Use the `EthPrivateKey` class or, even better, `client.credentialsFromPrivateKey` |
+| Sending transactions or calling contract functions | The api has been changed to just a single methods instead of a transaction builder. See the examples for details. |
+| Low-level cryptographic operations like signing, hashing and converting hex <-> byte array <-> integer  | Not available in the core library. Import `package:web3dart/crypto.dart` instead |
+
+If you run into problems after updating, please [create an issue](https://github.com/simolus3/web3dart/issues/new).
+
 ## 0.4.4
  - Added `getTransactionByHash` method - thank you, [maxholman](https://github.com/maxholman)!
  - Allow a different N parameter for scrypt when creating new wallets.

diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright 2018
+Copyright 2019 Simon Binder
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: