# @superfluid-finance/sdk-core

> SDK Core for building with Superfluid Protocol

Latest version **0.9.0** (published 2024-12-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @superfluid-finance/sdk-core
pnpm add @superfluid-finance/sdk-core
yarn add @superfluid-finance/sdk-core
bun add @superfluid-finance/sdk-core
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; large bundle; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.9.0 |
| Published | 2024-12-16 |
| First published | 2021-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12 |
| Dependencies | 5 |
| Unpacked size | 34.6 MB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 904 |
| Maintainers | superfluid_finance, miao.decentral.ee |

## Links

- npm: https://www.npmjs.com/package/@superfluid-finance/sdk-core
- Repository: https://github.com/superfluid-finance/protocol-monorepo
- Homepage: https://github.com/superfluid-finance/protocol-monorepo/tree/dev/packages/sdk-core#readme
- Issues: https://github.com/superfluid-finance/protocol-monorepo/issues
- npm.io page: https://npm.io/package/@superfluid-finance/sdk-core

## Dependencies (5)

- [tsify](https://npm.io/package/tsify.md) 5.0.4
- [lodash](https://npm.io/package/lodash.md) 4.17.21
- [graphql-request](https://npm.io/package/graphql-request.md) 6.1.0
- [@superfluid-finance/metadata](https://npm.io/package/@superfluid-finance/metadata.md) ^1.5.2
- [@superfluid-finance/ethereum-contracts](https://npm.io/package/@superfluid-finance/ethereum-contracts.md) 1.12.0

## Recent versions

- 0.9.0 (latest) — 2024-12-16
- 0.9.1-dev.0567de2.0 (dev) — 2026-09-30
- 0.9.1-dev.e0d24ae.0 — 2026-09-30
- 0.9.1-dev.0d396fd.0 — 2026-09-29
- 0.9.1-dev.c7d4a7d.0 — 2026-09-25
- 0.9.1-dev.f267b49.0 — 2026-09-16
- 0.9.1-dev.b1dc74b.0 — 2026-09-16
- 0.9.1-dev.3e1bb8b.0 — 2026-08-21
- 0.9.1-dev.a92f0d2.0 — 2026-08-21
- 0.9.1-dev.b2d6d9b.0 — 2026-08-07
- 0.9.1-dev.65eb168.0 — 2026-08-04
- 0.9.1-dev.ec5998d.0 — 2026-08-04
- 0.9.1-dev.72704f8.0 — 2026-08-03
- 0.9.1-dev.4141096.0 — 2026-06-26
- 0.9.1-dev.50a013d.0 — 2026-06-26
- … 644 more at https://npm.io/package/@superfluid-finance/sdk-core/versions

## README

<h1 align="center">Welcome to @superfluid-finance/sdk-core 👋
</h1>
<div align="center">
<img  width="300" padding="0 0 10px" alt="Superfluid logo" src="https://github.com/superfluid-finance/protocol-monorepo/raw/dev/sf-logo.png" />
<p>
  <a href="https://www.npmjs.com/package/@superfluid-finance/sdk-core" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/@superfluid-finance/sdk-core.svg">
  </a>
  <a href="https://codecov.io/gh/superfluid-finance/protocol-monorepo/tree/dev/packages/sdk-core">
    <img src="https://codecov.io/gh/superfluid-finance/protocol-monorepo/branch/dev/graph/badge.svg?token=LJW5NDGEJ9&flag=sdk-core"/>
  </a>
  <a href="#" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
  </a>
  <a href="https://twitter.com/Superfluid_HQ/" target="blank">
    <img alt="Twitter: Superfluid_HQ" src="https://img.shields.io/twitter/follow/Superfluid_HQ.svg?style=social" />
  </a>
</p>
</div>

### 🏠 [Homepage](https://superfluid.finance)

### ✨ [Superfluid App](https://app.superfluid.finance/)

### 📖 [Docs](https://docs.superfluid.finance)

# Introduction
SDK-Core is an application framework for interacting with the Superfluid Protocol without Solidity knowledge.

More specifically, SDK-Core is a wrapper library around `@superfluid-finance/ethereum-contracts` which allows web developers to interact with the Superfluid contracts.
Under the hood, SDK-Core leverages TypeScript, ethers.js and The Graph and GraphQL.

## Important Disclaimer
SDK-Core is in early active development and can have breaking releases without warning and without consideration for semantic versioning.

# Features
* Minimal Framework initialization (`chainId` and `provider`)
* New Operation syntax for transactions
* Create/Update/Delete Agreement Operations (Constant Flow Agreement and Instant Distribution Agreement)
* SuperToken Operations
* Subgraph-powered GraphQL querying with ordering and pagination
* Event subscription
* CFA/IDA/SuperToken Web3 Getters
* Batch Call functionality for batching multiple Superfluid Operations in one transaction

# Notable Used Technologies
* TypeScript
* Ethers
* GraphQL

# 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
yarn install && yarn build
```

> NOTE: `yarn build` has a prerequisite that the contracts in `ethereum-contracts` have been built.

# Tutorial

For the best and most immersive experience of learning how to use the main sdk-core features, I would highly recommend heading over to our [interactive tutorials](https://docs.superfluid.finance/superfluid/protocol-developers/interactive-tutorials/sdk-initialization).

---
_Source: https://npm.io/package/@superfluid-finance/sdk-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._