@superfluid-finance/sdk-core 0.3.3-dev.ff14ff1.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/CHANGELOG.md +15 -1
  2. package/README.md +1 -827
  3. package/dist/index.umd.js +5556 -5490
  4. package/dist/main/Framework.d.ts +21 -3
  5. package/dist/main/Framework.d.ts.map +1 -1
  6. package/dist/main/Framework.js +55 -3
  7. package/dist/main/Framework.js.map +1 -1
  8. package/dist/main/SuperToken.d.ts +1 -3
  9. package/dist/main/SuperToken.d.ts.map +1 -1
  10. package/dist/main/SuperToken.js.map +1 -1
  11. package/dist/main/abi/SuperfluidGovernanceII.json +0 -18
  12. package/dist/main/defaultSubgraphReleaseTag.json +1 -1
  13. package/dist/main/typechain/SuperfluidGovernanceII.d.ts +0 -16
  14. package/dist/main/typechain/SuperfluidGovernanceII.d.ts.map +1 -1
  15. package/dist/main/typechain/factories/SuperfluidGovernanceII__factory.d.ts.map +1 -1
  16. package/dist/main/typechain/factories/SuperfluidGovernanceII__factory.js +0 -18
  17. package/dist/main/typechain/factories/SuperfluidGovernanceII__factory.js.map +1 -1
  18. package/dist/module/Framework.d.ts +21 -3
  19. package/dist/module/Framework.d.ts.map +1 -1
  20. package/dist/module/Framework.js +55 -3
  21. package/dist/module/Framework.js.map +1 -1
  22. package/dist/module/SuperToken.d.ts +1 -3
  23. package/dist/module/SuperToken.d.ts.map +1 -1
  24. package/dist/module/SuperToken.js.map +1 -1
  25. package/dist/module/abi/SuperfluidGovernanceII.json +0 -18
  26. package/dist/module/defaultSubgraphReleaseTag.json +1 -1
  27. package/dist/module/typechain/SuperfluidGovernanceII.d.ts +0 -16
  28. package/dist/module/typechain/SuperfluidGovernanceII.d.ts.map +1 -1
  29. package/dist/module/typechain/factories/SuperfluidGovernanceII__factory.d.ts.map +1 -1
  30. package/dist/module/typechain/factories/SuperfluidGovernanceII__factory.js +0 -18
  31. package/dist/module/typechain/factories/SuperfluidGovernanceII__factory.js.map +1 -1
  32. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -5,6 +5,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
5
5
 
6
6
  ## [Unreleased]
7
7
 
8
+ ## [0.4.0] - 2022-05-06
9
+
8
10
  ### Added
9
11
  - Added option to specify block details when querying through a `SubgraphQueryHandler`
10
12
  - Added Subgraph's `_meta` table query
@@ -16,6 +18,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
16
18
  - Added new ACL function support: authorizing flow operator permissions and create/update/delete flow by operator
17
19
  - Added `nativeTokenSymbol` property to `constants.ts`
18
20
  - Split `SuperToken` class into: `WrapperSuperToken`, `PureSuperToken` and `NativeAssetSuperToken` classes
21
+ - Added `loadWrapperSuperToken`, `loadNativeAssetSuperToken`, and `loadPureSuperToken` super token initialization functions
19
22
  - Support `upgrade`, `upgradeTo` and `downgrade` functions via `NativeAssetSuperToken`
20
23
  - Added `upgradeTo` to `WrapperSuperToken` class as this was missing as well
21
24
 
@@ -29,6 +32,16 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
29
32
  ### Internal
30
33
  - Use `eslint-plugin-prettier` over separate `prettier` instance
31
34
 
35
+ ### Breaking
36
+ - The `SuperToken` class is now an abstract base class and no longer contains the functions `upgrade` and `downgrade`.
37
+ - `underlyingToken` is possibly undefined on `SuperToken`: `WrapperSuperToken` has `underlyingToken`, but `PureSuperToken` and `NativeAssetSuperToken` do not.
38
+ > NOTE: These changes are due to the split of `SuperToken` into `WrapperSuperToken`, `PureSuperToken` and `NativeAssetSuperToken` classes.
39
+ - Migration:
40
+ - if you are unsure of the type of the super token, you can use: `await framework.loadSuperToken("0x...");`
41
+ - if you want to load a wrapper super token, use: `await framework.loadWrapperSuperToken("DAIx");`
42
+ - if you want to load a native asset super token, use: `await framework.loadNativeAssetSuperToken("ETHx");`
43
+ - if you want to load a pure super token, use: `await framework.loadPureSuperToken("0x...");`
44
+
32
45
  ## [0.3.2] - 2022-03-16
33
46
 
34
47
  ### Added
@@ -103,7 +116,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
103
116
  - New `SuperToken` class with `SuperToken` CRUD functionality and an underlying `Token` class with basic `ERC20` functionality
104
117
  - New `BatchCall` class for creating and executing batch calls with supported `Operation's`
105
118
 
106
- [Unreleased]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.3.1...HEAD
119
+ [Unreleased]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.3.2...HEAD
120
+ [0.3.2]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.3.1...sdk-core%40v0.3.2
107
121
  [0.3.1]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.3.0...sdk-core%40v0.3.1
108
122
  [0.3.0]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.2.1...sdk-core%40v0.3.0
109
123
  [0.2.1]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.2.0...sdk-core%40v0.2.1