# fluxus-sdk

> Typescript SDK for Fluxus

Latest version **1.0.1** (published 2023-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install fluxus-sdk
pnpm add fluxus-sdk
yarn add fluxus-sdk
bun add fluxus-sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-04-14 |
| First published | 2023-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 70.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Saicharan Pogul |
| Maintainers | saicharanpogul |
| Keywords | Solana, Payments |

## Links

- npm: https://www.npmjs.com/package/fluxus-sdk
- Repository: https://github.com/saicharanpogul/fluxus
- Issues: https://github.com/saicharanpogul/fluxus/issues
- npm.io page: https://npm.io/package/fluxus-sdk

## Dependencies (3)

- [@solana/web3.js](https://npm.io/package/@solana/web3.js.md) ^1.75.0
- [@solana/spl-token](https://npm.io/package/@solana/spl-token.md) ^0.3.7
- [@project-serum/anchor](https://npm.io/package/@project-serum/anchor.md) ^0.26.0

## Recent versions

- 1.0.1 (latest) — 2023-04-14
- 1.0.0 — 2023-04-14
- 0.0.1 — 2023-04-06

## README

## Fluxus

[Capstone Demo](https://www.saicharanpogul.xyz/videos/FluxusDemo.mp4)

Devnet Address - [4XvNtZ1Z9GZ5YyZDJaAxC5TSFGHx1McbL5G2YphGQ1EG](https://explorer.solana.com/address/4XvNtZ1Z9GZ5YyZDJaAxC5TSFGHx1McbL5G2YphGQ1EG?cluster=devnet)

### **Overview:**

Fluxus is a decentralized finance (DeFi) protocol built on the Solana blockchain. It enables users to create and participate in token streams, where tokens can be gradually released over time to a recipient(s). These streams can be used for a variety of purposes, such as salary payments, crowdfunding, or regular payments for services.

Users can interact with the protocol using the `Fluxus SDK` or can perform CPIs to the `Fluxus Program` or [Frontend](https://fluxus.saicharanpogul.xyz/) which provides an easy-to-use interface for creating, managing, and participating in token streams.

### **Getting Started:**

1. **Fluxus SDK**

Install the `Fluxus SDK` from [NPM](https://www.npmjs.com/package/fluxus-sdk)
or from [GitHub](https://github.com/saicharanpogul/fluxus)

using npm:

```bash
npm i fluxus-sdk
```

using yarn

```bash
yarn install fluxus-sdk
```

Creating `fluxus` with `FluxusWithWallet` Class on Node Environment using Keypair.

```ts
const connection = new Connection("http://localhost:8899");
const wallet = new Wallet(payer); // payer: Keypair
const fluxus = new FluxusWithWallet(connection, payer);
```

Creating `fluxus` with `Fluxus` Class on Browser Environment using [Wallet Adapter](https://github.com/solana-labs/wallet-adapter)

```ts
const fluxus = new Fluxus(connection as Connection);
```

### **API References:**

1. Constant Flux

- Provides a steady stream of funds over a specified period.
- Offers flexibility to both payers and payees.
- Reduces the need for manual transaction processing.
- Ensures consistent cash flow.
- There are 3 functions `create`, `claim` and `cancel`.

> Create Constant Flux

```ts
// with wallet: makes sure the transaction is send to network and returns signature.
const { signature } = await fluxus.createConstantFluxWithWallet(
  authority: PublicKey,  // sender
  mint: PublicKey,       // SPL Token Mint
  receiver: PublicKey,   // recipient
  fluxId: string,        // unique identifier per user
  amount: number,        // amount to stream
  decimals: number,      // decimals of SPL Mint
  days: number           // number of days to stream
);
```

```ts
// with adapter: returns transaction
const { transaction } = await fluxus.createConstantFlux(
  authority: PublicKey,  // sender
  mint: PublicKey,       // SPL Token Mint
  receiver: PublicKey,   // recipient
  fluxId: string,        // unique identifier per user
  amount: number,        // amount to stream
  decimals: number,      // decimals of SPL Mint
  days: number           // number of days to stream
);
```

_Note_: You can send the transaction to the network using wallet adapter as shown below

```ts
const sig = await walletAdapter.sendTransaction(transaction, connection, {
  signers: [],
});
```

> Claim Constant Flux

```ts
// with wallet
const { signature } = await fluxus.claimConstantFluxWithWallet(
  mint: PublicKey,                  // SPL Token Mint
  authority: PublicKey,             // sender
  receiver: PublicKey,              // recipient
  fluxId: string,                   // unique identifier used to create constant flux
  receiverTokenAccount: PublicKey   // recipient mint token account
);
```

```ts
// with adapter
const { transaction } = await fluxus.claimConstantFlux(
  mint: PublicKey,                  // SPL Token Mint
  authority: PublicKey,             // sender
  receiver: PublicKey,              // recipient
  fluxId: string,                   // unique identifier used to create constant flux
  receiverTokenAccount: PublicKey   // recipient mint token account
);
```

> Cancel Constant Flux

```ts
// with wallet
const { signature } = await fluxus.cancelConstantFluxWithWallet(
  authority: PublicKey,     // sender
  mint: PublicKey,          // SPL Token Mint
  receiver: PublicKey,      // recipient
  fluxId: string            // unique identifier used to create constant flux
);
```

```ts
// with adapter
const { transaction } = await fluxus.cancelConstantFlux(
  authority: PublicKey,     // sender
  mint: PublicKey,          // SPL Token Mint
  receiver: PublicKey,      // recipient
  fluxId: string            // unique identifier used to create constant flux
);
```

2. Instant Distribution Flux

- Distributes funds instantly to multiple recipients.
- Eliminates the need for manual distribution.
- Offers real-time transparency on payments.
- Increases efficiency and reduces costs

```ts
// with wallet
const { signature } = await fluxus.instantDistributionFluxWithWallet(
  authority: PublicKey,      // sender
  mint: PublicKey,           // SPL Token Mint
  receivers: PublicKey[],    // receivers (max 5)
  amount: number,            // amount to distribute
  decimals: number,          // decimals of SPL Mint
  shares: number[]           // share of each recipient (equals to receivers)
);
```

```ts
// with adapter
const { transaction } = await fluxus.instantDistributionFlux(
  authority: PublicKey,      // sender
  mint: PublicKey,           // SPL Token Mint
  receivers: PublicKey[],    // receivers (max 5)
  amount: number,            // amount to distribute
  decimals: number,          // decimals of SPL Mint
  shares: number[]           // share of each recipient (equals to receivers)
);
```

2. **Fluxus Program**

- Fluxus Accounts

![accounts](https://fluxus.saicharanpogul.xyz/FluxusAccounts.png)

For more details check [program](https://github.com/saicharanpogul/fluxus/tree/main/programs/fluxus)

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