@superfluid-finance/sdk-core 0.5.7 → 0.5.8-dev.184e981.0

package/CHANGELOG.md

@@ -4,16 +4,22 @@ All notable changes to the SDK-core will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Map `deposit` to Stream when querying from Subgraph
+
+### Changed
+- Framework initialization for supported networks utilizes `@superfluid-finance/metadata`, but still uses the resolver for unsupported/local testing environments
+  - > NOTE: This will not create any changes when doing `Framework.create` and is just a minor optimization.
+- All transactions executed via SDK-Core have a default multiplier (1.2x) applied to the provider estimated gas limit **unless** an ethers `Overrides` object is passed during creation of the `Operation`.
+- There is also the option to pass in an explicit multiplier when executing transactions: `Operation.exec(signer, 1.32)`.
 
 ## [0.5.7] - 2022-10-13
 ### Breaking
-
 -   `CFAv1Forwarder` integrated into SDK-Core and will be the default way of calling CFA agreements and `sender` is now a required property.
   - Migration: pass sender into the affected CFAv1 callAgreement functions - `create/update/deleteFlow`.
   > NOTE: You must pass `shouldUseCallAgreement` explicitly as a property if you want to execute these calls via the Host.
 
 ### Added
-
 -   typechain files consumed from `@superfluid-finance/ethereum-contracts` and exported from SDK-Core
 
 ## [0.5.6] - 2022-09-07
@@ -26,6 +32,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## [0.5.5] - 2022-08-31
 ### Added
 - Support for: `optimism-goerli` and `arbitrum-goerli` added
+
 ### Breaking
 - Support for: `rinkeby`, `ropsten`, `kovan`, `optimism-kovan` and `arbitrum-rinkeby` removed
 - Don't throw `SFError` when executing `Operation` or `BatchCall`; let the original error bubble up
@@ -33,6 +40,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ### Fixes
 - Serialize a much smaller version of the cause in `SFError` (only `name`, `message`, `code`)
 - Change `SFError.name` from "Error" to "SFError"
+
 # [0.5.4] - 2022-08-19
 
 ### Fixes
@@ -234,7 +242,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
   - New `BatchCall` class for creating and executing batch calls with supported `Operation's`
 
 [Unreleased]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.5.7...HEAD
-[0.5.7]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.5.6...sdk-core%40v0.5.7
+[0.5.6]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.5.6...sdk-core%40v0.5.7
 [0.5.6]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.5.5...sdk-core%40v0.5.6
 [0.5.5]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.5.4...sdk-core%40v0.5.5
 [0.5.4]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.5.3...sdk-core%40v0.5.4

package/README.md

@@ -50,6 +50,13 @@ SDK-Core is in early active development and can have breaking releases without w
 
 # Prerequisites
 
+> NOTE: You need to have graphql and ethers installed as a dependency in order to use SDK-Core:
+
+```bash
+yarn install graphql ethers
+```
+
+
 To get the package up and running you'll need to install the necessary dependencies and build the project:
 
 ```bash