{"_id":"@aave-dao/aave-umbrella","_rev":"2-cbc0aa5969516084ba000118dae9a6e3","name":"@aave-dao/aave-umbrella","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@aave-dao/aave-umbrella","version":"1.0.0","keywords":[],"author":{"name":"BGD Labs for Aave"},"license":"BUSL1.1","_id":"@aave-dao/aave-umbrella@1.0.0","maintainers":[{"name":"sakulstra","email":"lukasstrassel@googlemail.com"},{"name":"andykoz","email":"kyzia.ru@gmail.com"}],"homepage":"https://github.com/aave-dao/aave-umbrella#readme","bugs":{"url":"https://github.com/aave-dao/aave-umbrella/issues"},"dist":{"shasum":"86d3e1d5e5185c09a4df23ebf43418d86b10dc59","tarball":"https://registry.npmjs.org/@aave-dao/aave-umbrella/-/aave-umbrella-1.0.0.tgz","fileCount":44,"integrity":"sha512-rB133BjVKBmT7yRenpBMLjTZCOJCB4V2hnow0p6clprCoxxvCpd7zSXZ/YBFzH00/S+yQarhZWd0r5T//sCDoA==","signatures":[{"sig":"MEUCIQDLctlUW+uL1PfjTh9mIgnXrZ/9BU09d/Y8F6fctpqxbQIgO87k2AbbtwI6dBW8kOgSCw4j7N+U0BoblXx9A4bpEzE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":300240},"gitHead":"d34359f567da4fbb58685e114cd1b824d8300fac","scripts":{"lint":"prettier ./","release":"changeset publish","lint:fix":"npm run lint -- --write","changeset":"changeset","version-packages":"changeset version"},"_npmUser":{"name":"sakulstra","email":"lukasstrassel@googlemail.com"},"repository":{"url":"git+https://github.com/aave-dao/aave-umbrella.git","type":"git"},"_npmVersion":"10.8.2","description":"","directories":{},"_nodeVersion":"20.19.4","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"prettier":"2.8.7","@changesets/cli":"^2.28.1","prettier-plugin-solidity":"1.1.3"},"_npmOperationalInternal":{"tmp":"tmp/aave-umbrella_1.0.0_1753867970117_0.582344177882709","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-07-30T09:32:50.063Z","modified":"2026-05-19T17:33:06.159Z","1.0.0":"2025-07-30T09:32:50.311Z"},"bugs":{"url":"https://github.com/aave-dao/aave-umbrella/issues"},"author":{"name":"BGD Labs for Aave"},"license":"BUSL1.1","homepage":"https://github.com/aave-dao/aave-umbrella#readme","keywords":[],"repository":{"url":"git+https://github.com/aave-dao/aave-umbrella.git","type":"git"},"description":"","maintainers":[{"email":"npm@avaralabs.com","name":"npm_avaralabs"}],"readme":"# Aave Umbrella\n\n\n\n
\n\n## Umbrella core overview\n\n`Umbrella` is an upgraded version of the Aave Safety Module, based on a staking and slashing mechanism. The primary reserve coverage asset is an `aToken` wrapped in a [`waToken (StataTokenV2)`](https://github.com/bgd-labs/aave-v3-origin/blob/main/src/contracts/extensions/stata-token/README.md). However, assets not directly connected to the Aave ecosystem (such as various LP or staked/restaked tokens) may also be utilized. This system employs a series of contracts designed to semi-automatically address reserve deficits while providing additional rewards to `StakeToken` holders.\n\n
\n\n## Umbrella key components\n\nThe `Umbrella` system comprises three main components:\n\n- [`Umbrella`](/src/contracts/umbrella/README.md): The central contract that orchestrates the system and serves as the entry point for addressing deficits through the slashing mechanism. It incorporates logic for estimating required funds to cover debt, managing system configurations, and creating new `StakeToken`s. The `Umbrella` contract is connected to each `Pool` across all networks to monitor reserve deficits and semi-automatically mitigate them when they occur.\n\n- [`StakeToken`](/src/contracts/stakeToken/README.md): An upgraded version of the `Aave Stake Token`, responsible for holding reserve assets. These assets can be slashed to cover deficits. Each `StakeToken` maintains an exchange rate tied to its underlying assets, which adjusts based on slashing events. The `StakeToken` is integrated with the reward system via a hook and the `RewardsController` contract. Additionally, it includes logic for fund withdrawals through a cooldown mechanism. For each market protected by the `Umbrella` system, one or more `StakeToken`s will be created.\n\n- [`RewardsController`](/src/contracts/rewards/README.md): A revised contract designed to allocate incentives to `StakeToken` holders. It facilitates the distribution of rewards and manages the claims process for these stakeholders. The contract supports the distribution of multiple types of rewards (up to eight in the current implementation) and operates as a single instance per network.\n\n
\n\n## Setup\n\n```sh\ncp .env.example .env\nforge install\n```\n\n
\n\n## Test\n\n```sh\nforge test\n```\n\n
\n\n## License\n\nCopyright © 2025, Aave DAO, represented by its governance smart contracts.\n\nThe [BUSL1.1](./LICENSE) license of this repository allows for any usage of the software, if respecting the Additional Use Grant limitations, forbidding any use case damaging anyhow the Aave DAO's interests.\nInterfaces and other components required for integrations are explicitly MIT licensed.\n","readmeFilename":"README.md"}