juice-sdk-v1

🧃 A JavaScript SDK for the Juicebox V1 protocol.

⚠️ This library is experimental and we provide no guarantees. Use at your own risk.

Overview

juice-sdk-v1 helps you interact with the Juicebox V2 contracts using JavaScript.

Supports your favorite dev environment:

• ✅ Node.js
• ✅ Typescript
• ✅ Webpack (supports tree-shaking)
• ✅ Rollup (supports tree-shaking)
• ✅ Vite (supports tree-shaking)

Installation

npm install juice-sdk-v1

Usage

1. Import the factory function for a Juicebox contract.

   import { getProjects as getProjectsContract } from "juice-sdk-v1";

2. Create a JsonRpcProvider. The example below uses the ethers library.

   import { JsonRpcProvider } from "@ethersproject/providers";
   // ...);
   const provider = new JsonRpcProvider(YOUR_GATEWAY_HOST_URL);

3. Call the factory function to get an instance of the ethers.js Contract.

   const ProjectContract = getProjectsContract(provider);

4. Start interacting with the contract.

   const const terminals = await ProjectContract.uriOf(projectId);

Examples

Inspect the examples/ directory to learn how to use juice-sdk-v1 for your project.

| Environment | Example | | ------------------------------ | ---------------------------------------------------------------------------------------------------------------- | | node.js | ./examples/node | | node.js with Typescript | ./examples/typescript-node | | create-react-app (webpack) | ./examples/create-react-app | | Vue | ./examples/vue | | Svelte | ./examples/svelte | | Vanilla JavaScript (with Vite) | juice-tools/embed/project/balance |

Development

• Build process