@streamable-finance/sdk-core
v0.5.5-rc.9
Published
SDK Core for building with StreamPay Protocol
Downloads
284
Readme
Introduction
SDK-Core is an application framework for interacting with the StreamPay Protocol without Solidity knowledge.
More specifically, SDK-Core is a wrapper library around @streamable-finance/ethereum-contracts
which allows web developers to interact with the StreamPay 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
andprovider
) - 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 StreamPay Operations in one transaction
Notable Used Technologies
- TypeScript
- Ethers
- GraphQL
Prerequisites
To get the package up and running you'll need to install the necessary dependencies and build the project:
yarn install && yarn build
NOTE:
yarn build
has a prerequisite that the contracts inethereum-contracts
have been built.