Streamr Network contracts
Solidity files plus Typescript interfaces for the Streamr Network smart contracts.
Contracts
Listed by file path:
- StreamRegistry: Streams are added here along with metadata how to join them
- NodeRegistry: Storage nodes can register themselves here
- StreamStorageRegistry: Connects storage nodes to streams that they store
- OperatorTokenomics: Operator and Sponsorship contracts that govern how to pay for better service in the Network, and how to get paid for providing it
- Spoiler: you '''sponsor''' streams by deploying a Sponsorship and sending DATA tokens to it, and operators '''stake''' into that Sponsorship to receive that DATA over time
- if operators stake but don't actually provide service, they get kicked out and their stake gets slashed
- additionally, 3rd parties can '''delegate''' their DATA tokens to the Operator contracts and receive a share of the operator's earnings. This way the operator gets more DATA to stake to more Sponsorships, in order to more fully utilize their network resources to earn more DATA.
Usage from Typescript
Snippet from the Operator client:
import { operatorABI, sponsorshipABI } from "@streamr/network-contracts"
import type { Operator, Sponsorship } from "@streamr/network-contracts"
...
const contract = new Contract(operatorContractAddress, operatorABI, this.provider) as unknown as Operator
contract.on("Staked", async (sponsorship: string) => {
log(`got Staked event ${sponsorship}`)
})
Developer notes
To deploy StreamRegistry and deploy the subgraph, run:
npm ci
npm run build
npm run localDeploy
to deploy the contracts into a locally running eth environment.
Then follow the README in the streamregistry-thegraph-subgraph folder.
Proxy contracts
The proxy enables upgradability of contract code without the need to change all addresses in software that talks to the contract and without the need to migrate data that is inside the old contract, that is being upgraded. Also the upgrade can only be controlled by a ProxyAdmin contract. To find out more visit
https://docs.openzeppelin.com/contracts/3.x/api/proxy and
https://docs.openzeppelin.com/upgrades-plugins/1.x/proxies
To deploy the contract with a proxy into a locally running eth environment run
npm run localDeployProxy
then copy the Proxy and Proxyadmin addresses to the upgradeProxy.ts script and run it with
npm run localUpgradeImpl