Superfluid

Added
- `batchCall` supports new `send` batch operation
- Added `downgradeTo` function in `SuperToken.sol`
- Added `deployContractsAndToken.js` and `runDeployContractsAndToken.js` to `dev-scripts`
- Added `SuperTokenV1Library` which provides a token centric interface for Superfluid specific SuperToken functionality.

Breaking

- `scripts/deploy-test-framework.js` no longer exists, `deploy-test-framework.js` has been moved to `dev-scripts`
- Migration: Use `dev-scripts/deploy-test-framework.js` instead

Changed

- `upgradeTo` logic changed to revert if `data` is not empty and `to` is a contract and is not a registered ERC777 recipient
- `MAX_APP_CALLBACK_LEVEL` is public again

sdk-corev0.5.9
Added
- Added toga events to be part of query

Fixes
- Added CFAForwarderV1 address to sdk-core

sdk-corev0.5.8
Added
- Support for eth-mainnet
- 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)`.


ethereum-contractsv1.4.3
Changes in this ethereum-contracts stable release

Added

- `createCanonicalERC20Wrapper` added for creating ERC20 Wrapper Super tokens which will be added to a canonical wrapper super token list based on naming convention and semi-upgradeability. This will be the recommended way of creating ERC20 Wrapper moving forward. (1115)
- `name` naming convention: Super Token `name` will be `"Super ${underlyingToken.name}"`
- `symbol` naming convention: Super Token `symbol` will be `"${underlyingToken.symbol}x"`
- Hardhat `artifacts` included in npm package (1144)
- Include declaration files in `types` folder for files in `scripts` in npm package (1144)
- Remove custom error codes in favor of localized per contract custom errors (1142)

sdk-corev0.5.7
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

ethereum-contractsv1.4.2
Added

- CFA Hooks added (1099)
- typechain types are provided to all consumers (1113)
- `SuperfluidFrameworkDeployer.sol` create Native Asset and Pure Super Tokens functionality added (1104)
- `TestResolver` added to allow `SuperfluidFrameworkDeployer` contract to grant admin permissions to its deployer (1104)

Fixes

- CFA Agreement forwarder delete flow fix to allow receivers to delete flow (1094)

ethereum-contractsv1.4.1
Changes in this ethereum-contracts stable release

Added

- CFA Agreement forwarder: deployed on all networks at 0xCfA1E187C9141B8bA90a436CB789017FA573d051

Fixes

- [SECURITY] CFA: check flow sender instead of msg sender in order to cover ACL use


sdk-corev0.5.6
Fixes
- Correct `subgraphAPIEndpoint` in `getResolverData`

Breaking
- Don't wrap `SubgraphClient` with `SFError`

js-sdkv0.6.3
Vitalik sets out on a journey with a fellow coiner, Satoshi, and his frog, Pepe, in order to find her sister, E-girl, who has the power to convert any object or person into a simp.

Changed
- Removed support for `kovan`, `rinkeby`, `optimism-kovan` and `arbitrum-rinkeby`
- Added support for `optimism-goerli` and `arbitrum-goerli`

ethereum-contractsv1.4.0
Changes in this ethereum-contracts stable release

Added
- CFA Agreement Forwarder (982)
- Gov: Convenience method for app registration keys and some cleanup (1049)
- App Credit Rule CFA-2 (899)
- Custom Errors Support (1043)
- yAcademy Gas Savings Applied (1062)
- bump solc to 0.8.16 (1065)
- Add gnosisscan support (1050)
- BNB Chain Support (925)
- Initialize logic contracts on deployment (using "castrate") (841)
- add tokenDecimals option to deploy-test-token.js (1025)

Fixed

- [TOGA] Added missing awaits (1044)
- New TestSuperApp: stream redirector wip, for testing when `appCallbackLevel` starting at 0 (1008)
- Prod deployment script fix (971)
- Adds a missing closing parenthesis to example test (967)
- Addresses several shortcomings in current workflows (mainly mainnet related) (911)
- Queue up FAILED_VERIFICATIONS (900)

Changed
- Deprecate support for `kovan`, `rinkeby`, `optimism-kovan`, and `optimism-rinkeby` (1032)
- Remove MaticBridgedToken from monorepo (1060)
- Updating dependencies & dedup dev packages (1064)


subgraphv1.4.6
Added
- Support for `arbitrum-goerli`, `optimism-goerli` added

Breaking
- Support for `kovan`, `arbitrum-rinkeby`, `optimism-kovan` removed

sdk-corev0.5.5
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

Fixes
- Serialize a much smaller version of the cause in `SFError` (only `name`, `message`, `code`)
- Change `SFError.name` from "Error" to "SFError"

sdk-corev0.5.4
Added
- Map indexId to IndexSubscription when querying from Subgraph

Fixes
- Properly console the cause, not the caught serialization error

ethereum-contractsv1.3.1
Changes in this ethereum-contracts stable release

Added

- Add resolver and loader to deployer, add tests (1011)


hardhat-deployerv0.0.1
Hardhat Deployer Initial Release

Hardhat deployment script for testing with the Superfluid contracts on a local development network.

Not suitable for production deployments of the protocol.

See: [README](https://github.com/superfluid-finance/protocol-monorepo/blob/dev/packages/hardhat-deployer/README.md)

subgraphv1.4.5
Added
- `isNativeAssetSuperToken` property added to `Token` entity

sdk-corev0.5.2
Added
- `callAppAction` Operation creator added to `Host` class

Breaking
- `BatchCall.getCallDataFunctionArgs` deprecates the old `BatchCall.getCallAgreementFunctionArgs`
- Migration:
- Replace `getCallAgreementFunctionArgs` with `getCallDataFunctionArgs` and pass in the fragment/ABI as the first argument, whilst keeping the same `callData` argument.
- `Host.populateCallAgreementTxnAndReturnOperation` is replaced by `Host.callAgreement`
- Migration:
- Replace instances of `populateCallAgreementTxnAndReturnOperation` with `callAgreement`

Fixes
- Handle `CALL_APP_ACTION` operation type correctly in SDK-Core when doing a batch call
- Undefined `process` in `constants.ts` in React and client-side apps using SDK-Core directly


sdk-corev0.5.1
Fixes
- Patch fix serializeError strange serialization

sdk-corev0.5.0
A fable about a CT influencer who gives his followers REAL validation -- dispensing both free alpha and free tokens.

Added
- Support for SetEvent and Subgraph v1.4.4
- `Framework.operation` method for easily creating `Operation` instances

Fixes
- Compile AJV validations to prevent unsafe-eval and did not allow SDK-Core usage inside Google Chrome extension due to unsafe-eval CSP

Changed
- `SFError` refactor to be more conventional. It inherits `Error` and uses `cause` to wrap internal errors.
- Use `serialize-error` for serializing error object inside the message.
- Export Operation & OperationType

Breaking
- `SFError.errorObject` renamed to `SFError.cause`

subgraphv1.4.4
Sir Pepe, a legendary degen, is severely injured in a dirty bera attack and is abandoned by his fellow degens. He uses his remaining stablecoins to survive and take revenge on his companion who dumped on him.

Added
- Handle `Set` event from Resolver contract
- New `SetEvent` and `ResolverEntry` entities

Fixes
- Handles unlisting of tokens in resolver

sdk-corev0.4.4
Added
- Query support for Subgraph v1.4.3

Breaking
- `networkName` and `dataSource` options removed from framework initialization, `chainId` is required now

subgraphv1.4.3
Added
- `gasPrice` added to event entities
- `governanceAddress` added to governance related entities
- `totalAmountStreamedInUntilUpdatedAt`, `totalAmountStreamedOutUntilUpdatedAt` added to `AccountTokenSnapshot`
- `totalAmountStreamedIn`, `totalAmountStreamedOut` added to `AccountTokenSnapshotLog`
- `TokenStatisticLog` entity added

Fixes
- GovernanceAddress is no longer hardcoded and subgraph detects new events from newly set governance contracts
- `token` property added to `BurnedEvent`, `MintedEvent` and `SentEvent`

Breaking
- `totalAmountStreamedUntilUpdatedAt` on `AccountTokenSnapshot` and `totalAmountStreamed` on `AccountTokenSnapshotLog` are no longer calculating the total amount streamed out from an account, but the net amount streamed through an account, you can simply replace this with `totalAmountStreamedOutUntilUpdatedAt` and `totalAmountStreamedOut`, respectively

subgraphv1.4.2
Binance is a cryptocurrency exchange which is the largest exchange in the world in terms of daily trading volume of cryptocurrencies. It was founded in 2017 and is registered in the Cayman Islands. Binance was founded by Changpeng Zhao, a developer who had previously created high frequency trading software.

Added
- BNB Chain support added

sdk-corev0.4.3
BNB Chain is the best blockchain for Web3 dApps with massive user bases. Developers can build easily with tutorials, grants, and ecosystem support.

Added
- BNB Chain support

Changed
- maybeCriticalAtTimestamp is nullable

js-sdkv0.6.2
Changed
- ethers.js support removed

Added
- Support for BNB chain (getConfig file)

Breaking
- ethers.js support removed (for those who were using ethers.js with js-sdk)

ethereum-contractsv1.3.0
Added

- Automated generation and publishing of contract API docs with solidity-docgen (880)
- Set newCtx whenever a function is modifying + using it (854)
- CfAv1Library ACL support (803)
- Avalanche Support Added (819)

Fixes

- Production deployment script fixes (821)
- Increase Code Coverage (891)
- SlotsBitmapLibrary Property Test Fuzzing (790)

Changed

- IDA: Distribute no longer reverts when units is 0 (853)
- Use `abi.encodeCall` (869)
- Review safemath & safecast (851)
- Solidity 0.8.14 (896)


subgraphv1.4.1
Changed
- `maybeCriticalAtTimestamp` is nullable

Fixes
- Add back deprecated `rewardAccount` field on `AgreementLiquidatedV2Event` entity (use `rewardAmountReceiver`)

subgraphv1.4.0
An aspiring degen is mysteriously able to enter the start of the bulla market, where she encounters a dazzling crypto startup founder. However, the glamour is not all it appears to be, and the dreams of the past start to crack and splinter into something far darker.

Breaking
- `rewardAccount` renamed to `rewardAmountReceiver` on `AgreementLiquidatedV2Event` entity

Fixes
- Was not properly updating `updatedAtTimestamp` and `updatedAtBlockNumber`
- Wasn't updating `totalAmountStreamedUntilUpdatedAt` for `TokenStats` whenever it was updated for `AccountTokenSnapshot`

Changed
- README updated to remove dead legacy endpoints, new v1/dev endpoints added
- Subgraph tests use hardhat node, config changed in `hardhat.config.ts`

Added
- Script to check if subgraph is deployed on every network
- `logIndex` and `order` properties added to all `Event` entities
- `maybeCriticalAtTimestamp` and `isLiquidationEstimateOptimistic` properties added to `AccountTokenSnapshot` entity
- `AccountTokenSnapshotLog` entity added (created on every update to `AccountTokenSnapshot`)
- Tests added for new properties/entities
- Tests fixed up given subgraph logic

sdk-reduxv0.3.0
Changes & Additions

- Rename mutations and queries for better ordering in source/file explorers:
- For example, "CreateFlow" renamed to "FlowCreateMutation" to go along with "FlowUpdateMutation" and "FlowDeleteMutation" etc
- "MonitorForEventsToInvalidateCache" moved to Subgraph API slice because it uses Subgraph, not an RPC
- Removed `sfApi` completely which combined Subgraph & RPC endpoints. Replaced by leaving just `subgraphApi` (only Subgraph as data source) & `rpcApi` (only RPC as data source)
- Redux slices are required to be set up using `*slice*.reducerPath` syntax
- Tracked transactions can now contain user defined extra data (see `*tracked transactin*.extraData`) which can be specified through the invoked mutation
- `userData` can now be specified through flow mutations
- Tracked transactions now have titles to identify the intent by
- Make it possible to initiate transaction tracking for old pending transactions (see `initiateOldPendingTransactionsTrackingThunk`)
- Transaction tracking invalidates RPC slice and Subgraph slice separately
- RPC is invalidated in its entirety for now
- Subgraph is polled for the block events of the successful transaction to invalidate the slice normally (based on the event type and its data)
- Save timestamp on the tracked transaction of when tracking started
- Simplify caching logic to just "GENERAL" & "SPECIFIC" tags (NOTE: cache tagging mechanism and the invalidation mechanism need more work)
- The idea behind the simplified chaching logic is that sometimes we need to _force_ invalidate the whole chain or the whole token cache. That's then we use the _general_ tag for invalidation. As a rule of thumb, all queries _should_ provide general cache tags. Other times, when we're listening to the blockchain and only want to invalidate specific parts and not _over_ invalidate the cache, then we use the _specific_ cache tags.

sdk-corev0.4.2
Pepe, a blockchain-traversing process server, and his token seller, Wojak, must run for their lives after Pepe drops his seed phrase at the spot where they witness a whale and Bogdanoff murder an NPC.

Fixes
- Patched SDK-Core Subgraph files to be in sync with V1 Subgraph endpoint

subgraphv1.3.4
Crypto tourists of 2022 are forced to fight for their gains when an avalanche (c-chain) of liquidations interrupts their portfolios.

Added
- Avalanche C-Chain network support

sdk-corev0.4.1
When the blockchain is frozen, only a few survivors of the 2020-2021 bull market are left and they ape into the next L1 blockchain aiming to solve the blockspace problem. Wojak leads a group of NPCs wanting to control the blockchain and the coins.

Changed
- `constants.ts`: Canonical network names based off `truffle.config.js` in `packages/ethereum-contracts`

Added
- Network support for Avalanche C-Chain

js-sdkv0.6.1
Added
- Avalanche C-Chain support

subgraphv1.3.3
When Ethereum becomes uninhabitable in the future, a frog and ex-crypto trader, Pepe, is tasked to bridge assets, along with a team of researchers, to find a new network for degens.

Changed
- Removed tests as they were not catching the [issue](https://github.com/graphprotocol/graph-node/issues/3553)

Fixes
- Removed (immutable: true) from `FlowOperatorUpdated` entity - No operators should

subgraphv1.3.2
Scientist Pepe's intention to prove his theory of blockchain immutability turns into an obsession when he decides to go back in time to save his subgraph from bricking.
Changed
- Zero address `Account` and `AccountTokenSnapshot` entities are not filtered out

Fixes
- Global `events` query fixed: global `events` query was breaking due to the `FlowUpdatedEvent` entity implementing the `Event` interface, but not having the immutable property like the other events
- `AccountTokenSnapshot` query with `account { id }` fixed. Was breaking due to faulty logic of creating an `AccountTokenSnapshot` without creating an `Account` entity
- Tests added to ensure this will be caught

js-sdkv0.6.0
NOTE: This is the maintenance branch of js-sdk, you should move onto using sdk-core instead.

Changed

- Added coverage report of js-sdk to codecov (802)


ethereum-contractsv1.2.2
Changes in this ethereum-contracts stable release

Breaking

- SuperfluidFrameworkDeployer.getFramework to return a Framework struct. (789)

Fixes

- Fixed a natspec typo (773)
- Reapply OpenEthereum provider hack (771)

Added

- ERC1820RegistryCompiled for testing frameworks: foundry, etc. (789)
- Add few more CFA and IDA cases (781)
- Test some CFA properties (777)

Changed

- App registration keys with expiration date instead of one-time use.


subgraphv1.3.1
Pepe, a self-centered frog, hops to the different blockchains available for indexing by The Graph for an assignment. He is later shocked when he wakes up the next morning and realises that he is reindexing the same blockchains over and over.

Changed
- Most event entities are immutable (except FlowUpdated)
Added
- New Access Control List (ACL) entities and properties added
- `FlowOperator` entity
- `flowOperator` property
- `deposit` and `totalDeposit` properties added to entities
Fixes
- Properly handle zero address throughout

sdk-corev0.4.0
Changed
- Renamed `Token` to `ERC20Token`
- Exported `ERC20Token`
- Renamed `PagedResult.data` to `PagedResult.items`
- Moved `listAllResults` into separate function from `Query` object
- Removed `SubgraphClient.batchRequests` because Subgraph Node didn't support it
Added
- Added option to specify block details when querying through a `SubgraphQueryHandler`
- Added Subgraph's `_meta` table query
- Added `tokenSymbol` for `SubgraphQueryHandler` entity queries where `token` (token ID) was previously included
- Added `PageNumberPaging` for UI development friendly pagination API
- Added `AllPaging` to recursively query all results from Subgraph
- Added support for `TypedDocumentNode` for `SubgraphClient`
- Expose underlying ethers.js contracts for each class: CFAv1, Host, IDAv1 and `contracts` property in `Framework` class
- Added new ACL function support: authorizing flow operator permissions and create/update/delete flow by operator
- Added `nativeTokenSymbol` property to `constants.ts`
- Split `SuperToken` class into: `WrapperSuperToken`, `PureSuperToken` and `NativeAssetSuperToken` classes
- Added `loadWrapperSuperToken`, `loadNativeAssetSuperToken`, and `loadPureSuperToken` super token initialization functions
- Support `upgrade`, `upgradeTo` and `downgrade` functions via `NativeAssetSuperToken`
- Added `upgradeTo` to `WrapperSuperToken` class as this was missing as well
Breaking
- The `SuperToken` class is now an abstract base class and no longer contains the functions `upgrade` and `downgrade`.
- `underlyingToken` is possibly undefined on `SuperToken`: `WrapperSuperToken` has `underlyingToken`, but `PureSuperToken` and `NativeAssetSuperToken` do not.
> NOTE: These changes are due to the split of `SuperToken` into `WrapperSuperToken`, `PureSuperToken` and `NativeAssetSuperToken` classes.
- Migration:
- if you are unsure of the type of the super token, you can use: `await framework.loadSuperToken("0x...");`
- if you want to load a wrapper super token, use: `await framework.loadWrapperSuperToken("DAIx");`
- if you want to load a native asset super token, use: `await framework.loadNativeAssetSuperToken("ETHx");`
- if you want to load a pure super token, use: `await framework.loadPureSuperToken("0x...");`

ethereum-contractsv1.2.1
Changes in this ethereum-contracts stable release

Breaking

- Contracts/Test layout refactoring + Shared Deployer + Foundry Test Integration (754)
- interfaces/misc/IMultiSigWallet -> interfaces/utils/IMultiSigWallet
- interfaces/ux/IRelayRecipient-> interfaces/utils/IRelayRecipient
- interfaces/ux/IResolver-> interfaces/utils/IRelayRecipient
- ux/BaseRelayRecipient -> libs/BaseReplayRecipient
- ux/Resolver -> utils/Resolver
- ux/SuperUpgrader-> utils/SuperUpgrader
- ux/SuperfluidLoader -> utils/SuperfluidLoader
- tokens/FullUpgradableSuperToken -> superfluid/FullUpgradableSuperToken
- ACL redundant sender param cleanup (763)


ethereum-contractsv1.2.0
Changes in this ethereum-contracts stable release

Added

- Added HALBORN report (759)
- **MAJOR FEATURE**: Access Control List (720)
- ACL base API functions
- FlowOperatorDefinitions library
- new functions in IConstantFlowAgreementV1
- Other changes:
- emit FlowUpdatedExtension event

Fixes

- Fix ERC1820 artifact issue (759)
- Fix an issue with output dir (748)
- [SECURITY] InstantDistributionAgreement.claim should be guarded by ctx check.
- Interface renaming fix re patrician periods (747)

Changed

- Remove Strings.sol again
- Disable zero address subscription for IDA (751)
- Update dev dependencies (694)
- Use hardhat for ethereum-contracts tests (727)
- Update to solc 0.8.13 (721)

Improvements

- Reduce trust assumptions host <-> agreements (749)
- Additional IDA test cases (722)


js-sdkv0.5.13
Changes in this js-sdk stable release

Changed

* Update dev dependencies (694)

Added

* Added gasOptions parameter to IDA and CFA methods (756)



ethereum-contractsv1.1.1
Changes in this ethereum-contracts stable release

Fixes

- Add Strings.sol back to repository (715)


ethereum-contractsv1.1.0
Changes in this ethereum-contracts stable release

Changed

- Use host.getNow to fully abstract time (703)
- Use Solidity v0.8.0 (687)
- Informative revertFromReturnedData (693)

Added

- IDAv1Library (696)
- Added single-file Dapp for deploying SuperToken wrappers (692)
- Print contract sizes (690)
- Workflow Improvements (cloc and faster pre-commit) (688)

Fixes

- Info-show-protocol fix for PPP and cleanup (684)

Breaking

- Monogamous SETH, L2 config improvements (707).
- All interface contracts are requiring you to use solc >= 0.8.0.
- Removed ERC777 callbacks from ERC20.transfer (698).
- [SECURITY] isValidAppAction added, this prevents SuperApp callbacks being mistakenly called by callAppActions. Kudos to JoshuaTrujillo15

sdk-reduxv0.2.2
Changes in this sdk-redux stable release

Added

- Added "optimism-mainnet" and "arbitrum-one" support.

Added
- Added `indexValueCurrent` to `IndexSubscription` query to optimize calculating "total amount distributed" in consuming applications ([629])
- Added `indexTotalUnits` to `IndexSubscription` query to optimize calculating "pool percentage" in consuming applications ([630])

Fixed
- Typo for `networkName: "arbitrum-rinkeby"` fixed (was expecting `"arbitrium-rinkeby"`) in `Framework.create` ([637])

Breaking
- Using `"xdai"` as the `networkName` will no longer work. Updated to `"gnosis"`
- Migration: change `networkName` from `"xdai"` to `"gnosis"`


js-sdkv0.5.12
Changes in this js-sdk stable release

Added

- Added "optimism-mainnet" and "arbitrum-one" support.


ethereum-contractsv1.0.0
Changes in this ethereum-contracts stable release

Changed

- Upgrade `truffle-plugin-verify` and use its proxy verification feature (623)

Added

- 3Ps (558)
- Add SuperApp factory registration script (657)
- CFALibraryV1: added flow() and flowWithCtx() functions (595)
- Self approve transfer (598)
- External set/clear config added to governance (624)

Fixes

- Add missing event emits (656)
- CFALibraryV1: Change solidity pragma in cfa lib to support versions 0.8 & later (642)
- Multiple scripts fixes re: do not engage with unitialized super token proxies (603)

Security

- Call agreement calldata exploit (628)
- Internal code audit iteration one (646)

Technical Debt Cleanups

- Techdebt cleanups (673)
- UUPS review (632)


subgraphv1.3.0
Vinny travels back in time on-chain using The Graph's Subgraph indexer. However, he must index all the relevant events and create the relevant entities in order to return to the present.

Changed
* Package updates (550, 604)
* Subgraph tests use `sdk-core` instead of `js-sdk` and general refactoring (594, 621)

Added
* Subgraph supports new entities: `PPPConfigurationChangedEvent`, `AgreementLiquidatedV2Event` (558)
* Added complementary liquidation tests

Fixed
* +1 to `getRandomFlowRate` so flowRate is never 0 (538)
* `getLiquidations` script null case fix (557)
* handle updating of total supply for native super token (584)

sdk-reduxv0.2.0
Added
- Introduce new Redux slice `sfSubgraph` (571)
- Support improved querying functionality
- Query all the Subgraph entities with all the possible filters and ordering capabilities

sdk-corev0.3.0
Three friends, Vincent, Kaspar and Miao, are tired of the problems in their lives and decide to visit a crypto resort. Their lives change when they are mysteriously teleported to the year 1420.

Changed
- `_ethers` is not exported for UMD build anymore. Use `window._ethers` instead.
- `SFError` and `ErrorType` are now exported
- Generated Subgraph types are now exported (`*_Filter` and `*_OrderBy` types)
- There are a lot of Subgraph types, so it does make the namespace crowded. We'll alleviate it in a later release.
Added
- New query handlers (experimental) to cover full spectrum of Subgraph querying capabilities
- Used by the new release of SDK-redux
- Lacks an easy-to-use API for average SDK-core user

js-sdkv0.5.10
Changes in this ethereum-contracts release

Changed

- Update dependencies for ethereum-contracts/js-sdk & cleaned up prettier usage (593)

ethereum-contractsv1.0.0-rc.11
Changes in this ethereum-contracts release

Changed

- Update dependencies for ethereum-contracts/js-sdk & cleaned up prettier usage (593)

sdk-corev0.2.1
Changes in this sdk-core release
Added
- Load `SuperToken` by token symbol as long as the token is listed on the resolver (588)

js-sdkv0.5.9
Changes in this js-sdk release

Fixed

- Enable EIP-155 transactions always (582)

ethereum-contractsv1.0.0-rc.9
Changes in this ethereum-contracts release

Added

- CFAv1Library (542)
- For 3P feature: makeLiquidationPayoutsV2 (574)

Fixed

- TOGAv2: bond withdrawal in separate tx fallback (544)
- Scripts improvements for L2 network deployments

Experimental features

- CFA minimal deposit (568, 576)

ethereum-contractsv1.0.0-rc.10
Changes in this ethereum-contracts release

Fixes

* Fix loadContracts usage (587)

sdk-corev0.2.0
"The Protagonist"
Changes in this sdk-core release

Changed
- package.json cleanup and subgraph schema updated (522)
- Simpler provider logic for Framework creation (537)
- Use V1 instead of devSubgraph endpoints (550)
- `superTokenFactoryAddress` removed from `IConfig` interface (556)

Added
- Support for new testnets: Optimism Kovan, Avalanche Fuji, and Arbitrum Rinkeby (526)
- Working UMD build added to package and removed duplicated .d.ts typing files from package (535)
- ethers.js overrides object support added to all `Operation` creation functions (540)

Fixed
- Outdated README.md cleanup and updates (520, 524, 526, 530, 537, 549, 556)
- `BatchCall` for callAgreement functions fixed, flow rate calculation utils logic fixed (526)
- Improper base 18 number for flow rate calculation utils (545)
- single network deploy implemented (506)
- eslint errors and .json imports fixed (535)

Breaking
- Breaking change: Framework.create interface breaking change:`web3Ethers` and `hardhatEthers` properties removed (537)
- Migration: if you were using one of these two properties, change the property `web3Ethers` and `hardhatEthers` to `provider`
- Breaking change: non Framework initialized `batchCall` constructor arguments interface change: `config` property removed (556)
- Migration: if you instantiated a `BatchCall` without using Framework, you need to remove the config property and replace it with the property: `hostAddress`

subgraphv1.2.0
After discovering new blockchains in the Cryptoverse, Superfluid and its revolutionary money streaming technology set out to bring magical streams to everyone in crypto.

Added

- Support for new test networks: `arbitrum-rinkeby`, `optimism-kovan` and `avalanche-fuji`.

js-sdkv0.5.8
Changes in this js-sdk release

New

- Added support of new testnets: arbitrum-rinkeby, optimism-kovan, avalanche-

ethereum-contractsv1.0.0-rc.8
Changes in this ethereum-contracts release

New

- Batch super token upgrade (448)
- Native Super Token mintable by Matic POS bridge (459)
- Added CLOWNS/TOGA contract (414)
- Batch liquidator contract (394)
- Upgradable governance (405)
- Added support of new testnets: arbitrum-rinkeby, optimism-kovan, avalanche-fuji

Changes

- Refactor TestEnvironments (436)

Fixes

- Native coin contract verification fix (521)
- (Security) Ida slotsbitmap fix & additional IDA changes (460)
- Improve Admin Scripts (400, 488)
- Print loader address in scripts/print-addresses.js
- Updated dependencies

sdk-reduxv0.1.0
SDK-Redux is an application framework for building front-end applications that interact with the Superfluid Protocol.

More specifically, SDK-Redux is a wrapper library around superfluid-fincance/sdk-core which adds state management to Superfluid related queries and operations. Under the hood, SDK-Redux leverages popular Redux libraries Redux Toolkit & RTK Query.

!!IMPORTANT DISCLAIMER!!

SDK-Redux is in early active development and can have breaking releases without warning and without consideration for semantic versioning.

Added
- Initial preview version of SDK-Redux
- Features:
- Wrap SDK-Core with Redux's RTK-Query to enable cache'ing of queries
- Auto-generate React Hooks
- Tracking loading state in order to show UI spinners
- Tracking broadcasted transactions for UI notifications and data updates
- Managing cache lifetimes
- Avoiding duplicate requests for the same data
- Monitoring blockchain events for data updates (including re-orgs)
- Handle errors and offer user opportunity to retry



sdk-corev0.1.0
Intellectual degeneers Vincent and Kaspar build and sell much wow NFT technology with the help of their friends Miao and Vitalik. But when Vincent and Kaspar accidentally invent what they think is a money streaming machine, Kaspar builds a version capable of streaming a human and puts the device to the test. As the two friends obsess over their creation, they discover the dark consequences of their actions.

This is the first release build and for preview only. Breaking changes can be expected for all `0.x.y` releases.

subgraphv1.1.1
"I'll be back."

Added

- `from` property onto SentEvent (493)
- Subgraph sfmeta entity (491)

Changed

- Subgraph test added to canary build (512)
- using js-sdk0.5.7
- update subgraph dependency versions (target minor) (509)

Fixed

- ci cd cleanup (500)
- single network deploy implemented (506)

Breaking Changes!!!

Due to subgraph schema version upgrades, `isSet` is now also a reserved keyword in the schema. Superfluid events
that had `isSet` argument are all changed to using `isKeySet` instead.

This change will take effect when the superfluid endpoints are updated, it might introduce some period of incompatibility
during the upgrade process.



js-sdkv0.5.7
Added

- add skipTokens option to `Framework.loadToken` (510)


js-sdkv0.5.6
Changes in this Release

Fixes

* Add networks property into Truffle contract init json object to reduce network calls by msoni89 in https://github.com/superfluid-finance/protocol-monorepo/pull/476

What's Changed

* Update dependencies and reviewed new testnet supports by hellwolf in https://github.com/superfluid-finance/protocol-monorepo/pull/499

**Full Changelog**: https://github.com/superfluid-finance/protocol-monorepo/compare/js-sdkv0.5.5...js-sdkv0.5.6

subgraphv1.1.0
Vincent (0xdavinchee), crypto's only hope of stopping the maximalist wars and saving ser Doge, attempts to broker peace between the degens and nocoiners. However, he must first confront his arch nemesis, the rogue agent Bogdanoff.

New

- Add stream period entity (461)
- Name and addresses properties added to event entities (481)

Changes

- Subgraph v1 underlying token added to Token entity (482)
* Decimals and underlying token added to Token entity
* Tests added for new entity and properties: `StreamPeriod` entity, `name` and `addresses` properties on events, `decimal` and `underlyingToken` properties on `Token`


subgraphv1.0.0
Crypto fighters Vincent, Trinity and Morpheus continue to lead the revolt against the Maximalists, unleashing their arsenal of very blockchain and much wow against the systematic forces of so scared and stonks.

Key Features

- Complete set of Superfluid event entities (niiiiice).
- HOL (Higher order level) entities (oh yeeehhh).
- Aggregate entities (whaaaa).
- System testing suite for all entities (first of its kind!).
- Shiny new docs coming to you soon (boom!)...

js-sdkv0.5.5
Changes in this Release

Changed

- Refactor TestEnvironments (436)

Fixes

- Fix SETHx Loading (449)

- Fix up user object (427)
- add some docs
- add some tests
- we check if the flowRate property is empty instead of !flowRate
- we also check if the type of flowRate is not a string, we throw an error if this is the case otherwise the code may behave strangely

- Type information fixes (444, JoshuaTrujillo15 )
* fixed suggestions in js-sdk, fixed related import issues, moved tsconfig.json
* fixed import issue in loadContracts
* updated tsconfig, removed unnecessary any types, fixed import issue
* added optional type for FrameworkOptions
* pdated package and tsconfig typescript issues
* updated CFAv1 interfaces
* replaced EthersWithSigner in Framework, loadContracts
* updated type entry point for ease of import
* updated IDAv1 interfaces (more to come)
* updated CFAv1 interfaces
* fixed CFAHelper optional types
* added User options interfaces
* fixed user option issue


js-sdkv0.5.4
Changes in this Release

Changed

- Remove the lint-staged step
- Print loader address
- Various improve Admin Scripts (400)
- Adjust LoadToken logic when dealign with unlisted token (411)

Added

- added externals to webpack (407)
- Added superTokenCustomType into superTokenObject (428)

Fixes

- Fix SDK browser support + add hardhat network (390, thanks to trozler)
- Small improvements noticed when doing code review to js-dsk (398)
- js-sdk fix node syntax issue (397)
- Fix typescript typing issues (423)

Breaking

None.

js-sdkv0.5.3
Changes in this Release

Fixes

- Fix SDK browser support + add hardhat network (390)

ethereum-contractsv1.0.0-rc.7
Changes in this Release

Changed

- Update dependencies (381)
* update dependencies of packages
* update yarn version
- remove the damn lint-staged
- selfMint requireReceptionAck=false

Added

- add upgrade-super-token-logic.js script

Fixes

- Ignore strings sol in coverage (377)
- Various fix in protocol scripts

Breaking

- make CustomSuperTokenProxyBase more abstract (382)
* rename to CustomSuperTokenBase to avoid silent breaking change


js-sdkv0.5.2
Changes in this Release

Fixes

Typescript Bug Fixes (375)


ethereum-contractsv1.0.0-rc.6
Changes in this Release

Added

- Framework loader and load token by address (366)

Fixes

- solidity interfaces should not require exact version (363)
- ignore contracts/utils/Strings.sol in coverage test (374)
- make utils.rl close readline properly (361)
- Deployment fixes (359)


js-sdkv0.5.1
Patched js-sdk0.5.1

* add .d.ts and .md files to the files list


js-sdkv0.5.0
Changes in this Release

Added

- Framework loader and load token by address (366)
- Typescript type information for SDK (364). Thanks to the contributors JoshuaTrujillo15, manav2401 and Drewsapple

Fixes

- Deployment fixes (359)


js-sdkv0.4.4
Added

- [js-sdk] batchCall ∑ (332)

Changes

- Updadte dependencies (328)

Fixes

- disable double loading (357)


ethereum-contractsv1.0.0-rc.5
Added

- Update create-new-app-registration-key.js (352)
- separate ISETH and INativeSuperToken interfaces (356)
- more protocol scripts (329)

Changes

SuperTokenLogic changes (SuperToken upgrade needed):

- Make selfMint requireReceptionAck=false (353)
- Split IDA into a library and main contract (343)

Fixes

- (Critical) Should not have deposit allowance for different token (344)
- duplicate param description of account in realtimeBalanceOf (349)
- Fix IDA etherscan source verification (346)

ethereum-contractsv1.0.0-rc.4
Changes in this Release
Changed

Updadte dependencies (328)

- truffle/hdwallet-provider, to fix eip155 bugs
- update truffle-plugin-verify
- use --forceConstructorArgs
- turn off a solhint check for compiler-version due to an issue.
* fix lint issue and build
* bump version of superfluid-finance/ethereum-contracts for new release

Added

- Subraph initial setup (303)

Fixes

- truffle/hdwallet-provider, to fix eip155 bugs

Breaking

None.

js-sdkv0.4.3
Changes in this Release

Changed

- loadToken of superTokenKey can load underlyingToken too (311)

Added

- added isSuprTokenListed (311)

Fixes

n/a

Breaking

n/a


ethereum-contractsv1.0.0-rc.3
Changes in this Release

Changed

- make createERC20Wrapper returns the superToken (313)

Added

- Minimal native SuperToken with deploy script (306)
- add custom super token created event (310)

Fixes

- fix upgradeTo for TokenUpgraded event and added tests (312)

Breaking

none.



js-sdkv0.4.2
Changes in this Release

Changed

* use node-jq package and improve error handling of tasks/build-abi-js (308)
* further parallel loading of Framework.initialize (309)

Added

* SDK to be able to load native super token (309)
* make doc clear about tokenKey vs tokenSymbol/superTokenSymbol

Fixes

none

Breaking

none


ethereum-contractsv1.0.0-rc.2
Changes in this Release

Changed

- Additional improvements to the scripts
- cleanup getConfigs (301)

Added

- Added AgreementLiquidatedBy event to CFA (305)
- Add more CFA SuperApp test case (290)

Fixes

- Improved examples daily build stability, update dependencies (301)
- Fixed a CFA bug when superapp manipulating the same flow in the callbacks (290)

Breaking

None.


js-sdkv0.4.1
Changes in this Release

Changed

- Peer dependency of truffle/contract version requirement lowered to ^4.0.0

Added

- Added xdai resolver address
- Added matic resolver address
- Framework.createERC20Wrapper to support overriding superTokenName and superTokenSymbol

Fixes

n/a

Breaking

n/a


ethereum-contractsv1.0.0-rc.1
Changes in this Release

Ethereum-contracts

Changed

- print super tokens in scripts/show-protocol-info.js
- scripts/show-protocol-info.js to print code address of host
- print underlying token address in scripts/show-protocol-info.js
- more docs to scripts/deploy-super-token.js

Added

- added scripts/scan-deployments.js
- added scripts/deploy-unlisted-super-token

Fixes

n/a

Breaking

n/a

js-sdkv0.4.0
Changes in this Release

Changed

- updated IDAHelper class (285)

Added

- Feature/ida testsuite (280)
- Feature - js sdk helpers to support autobind (279)

Fixes

- prettier all js (278)

Breaking

- IDAHelper is now with a revamped interface and its own code documentations.


ethereum-contractsv1.0.0-rc.0
Changes in this Release

Changed

- deployment scripts improvements (291)

Added

- added new network type arbitrum testnet (277)
- Complete CI Coverage integration (281)
- Feature 249 trusted forwarder integration (256)
- add: option weth to SETH proxy deployment (293)
- Superfluid Governance (294)
- add support of app whitelisting (297)
- added PeckShield-Audit-Report-Superfluid-v1.0

Fixes

- prettier all js (278)

Breaking

- use same upgrade/downgrade functions for SETH (296)



js-sdkv0.3.5
Changes in this Release
Changed

n/a

Added

n/a

Fixes

* loadToken should use correct ABI for SETH (271)

Breaking

n/a


js-sdkv0.3.4
Changes in this Release

Changed

n/a

Added

* biconomy forwarder fast track (269)

Fixes

n/a

Breaking
n/a


ethereum-contractsv0.2.8
Changes in this Release

Changed

n/a

Added

* biconomy forwarder fast track (269)

Fixes

n/a

Breaking
n/a


js-sdkv0.3.3
Changes in this Release

Changed

n/a

Added

- support contractLoader in loadContracts (used by ethereum-contracts)

Fixes

n/a

Breaking

n/a

js-sdkv0.3.2
Changes in this Release

Changed

* Updated README (261)

Added

n/a

Fixes

* [js-sdk] Ethers API provider issue with getSigner() (258)

Breaking

n/a


ethereum-contractsv0.2.7
Changes in this Release

Changed

n/a

Added

n/a

Fixes

- use builtTruffleContractLoader for deployment scripts

Breaking

n/a


ethereum-contractsv0.2.6
Changes in this Release

Changed

* Ethereum contracts should include artifacts folder. (261)
* Updated README (261)

Added

n/a

Fixes

n/a

Breaking

n/a


js-sdkv0.3.1
Changes in this Release

Just some minor docs (249) and dependency updates (252) , nothing to see here

ethereum-contractsv0.2.5
Changes in this Release

Changed

n/a

Added

* ship full version of Int96SafeMath 250 (254)
* add TokenUpgraded and TokenDowngraded events to SETH (253)

Fixes

* a bug in agreement library causing non super app callbacks in IDA case (246)

Breaking

n/a


js-sdkv0.3.0
Changes in this Release

👯 The day has come to add `Ethers.js` support! Here is a handy guide to use the SDK with ethers: https://docs.superfluid.finance/superfluid/protocol-tutorials/getting-started/frontend-+-nodejs#installation

Happy hacking!

Changed

- Instantiation has changed (see "Breaking" section)

Added

- New peer dependencies for `truffle/contract` and `ethersproject/contracts`. You must install one, depending on which web3 library you are using. (238)
- Add `ethers.js` support (238)

js
yarn install superfluid-finance/js-sdk ethersproject/contracts

...

const SuperfluidSDK = require("superfluid-finance/js-sdk");
const { Web3Provider } = require("ethersproject/providers");

const sf = new SuperfluidSDK.Framework({
ethers: new Web3Provider(window.ethereum)
});
await sf.initialize()

- New function to load tokens `loadTokens`, which is similar to `options.loadTokens`, but you can call this at any time, rather than only during instantiation. (245)
- Support for Super ETH, which allows you to upgrade the native protocol token to a Super Token. (234)

Fixes

- n/a

Breaking

- For `web3.js` users, we renamed `web3Provider` to `web3`. You must also create the web3.js object first, rather than relying on the sdk to create it. For example:

js
yarn install superfluid-finance/js-sdk truffle/contract

...

const SuperfluidSDK = require("superfluid-finance/js-sdk");
const Web3 = require("web3");

const sf = new SuperfluidSDK.Framework({
web3: new Web3(window.ethereum),
});
await sf.initialize()



ethereum-contractsv0.2.4
Changes in this Release

Changed

- Update to `superfluid-finance/js-sdk^0.3.0`

Added

- Support `ETHx` (Super ETH) in the test environment

Fixes

- Use `safeERC20` in `SuperUpgrader`

Breaking

- n/a

js-sdkv0.2.4
Changes in this Release
Changed

n/a
Added
n/a
Fixes
- Dependency bug in 231
Breaking
n/a

js-sdkv0.2.3
Minor improvements as we continue to separate the sdk from Truffle. Support for ethers.js is planned.

bash
Compare changes
git diff superfluid-finance/ethereum-contracts0.2.2 packages/js-sdk


Changed

- Removes `ethereum-contracts` dependency for the `loadContracts.js` script (219)

Added

n/a

Fixes

n/a

Breaking

n/a

ethereum-contractsv0.2.3
Changes in this Release

Changed

- Build process: workflow for pr branches, canary branch, master branch revamped

Added

- Additional Superfluid host contracts testings (220)
- Build process: etherscan support (223)

Fixes

- PVE001 fix - use SafeERC20 SafeTrasfer(From) (214)
- PVE003 use actual amount when using underlying tokens (217)
- PVE005 support APP_RULE_NO_REGISTRATION_FOR_EOA (216)
- PVE007 rewardAmount in AgreementLiquidated and other minor fixes (218)
- fix deploy-super-token.js script
- corrected licence reference in ethereum-contracts to AGPLv3

Breaking

- fix typo of operationType in batchCall (225)

Added

- Bump sdk-core version to include "optimism-mainnet" and "arbitrum-one" support.
- Change sdk-core peer dependency to allow patched updates.