npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@spheron/desub-js

v2.6.8

Published

Typescript library for working with the decentralised subscription contracts in Spheron

Downloads

43

Readme

🧰 Desub Js is the ultimate solution for working with the Decentralized Subscription Contracts. Powered by Spheron.

Desub.JS

Typescript Lib for working with the Spheron Decentralized Subscription Contracts.

About Spheron

Spheron is a marketplace to access all your web3 infrasructures.

Getting Started

A simple guide for using the desub package to interacts with your contract. The smart contract can be found here. If you make any significant change to the contracts, then you'll have to make some some changes to the package and copy the ABIs to the constants/subscription.ts file. Contracts can be deployed on any EVM chain with support for solidity. If you are adopting the spheron contract without significant change, you can proceed to follow this quick guide. Note: ethers is a peer dependency of this library, so it is mandatory to install ethers separately along with the @spheron/desub-js library.

Installation

Using NPM

npm install @spheron/desub-js ethers

Using Yarn

yarn add @spheron/desub-js ethers

Usage

How to use desub-js functions

To use the desub-js functions, you will need to follow the steps outlined below:

Using the getUserTokenBalance function

  1. Import the required packages:
import * as paymentSmartContract from "@spheron/desub-js";
import { Wallet } from "@ethersproject/wallet";
  1. Provide the necessary input parameters to the function:
  • subContractData: an object with paymentContractAddress, dataContractAddress, tokenAddress, and tokenPrecision properties.
  • tokenAddress: the address of the token contract.
  • tokenPrecision: the number of decimals the token has.
  • walletAddress: the address of the wallet to check the balance for.
  1. Set the HTTP provider URL:
const httpProvider = "<insert  provider  URL>";

This URL should point to a node that can communicate with the EVM chain.

  1. Connect to the wallet using a signer:
const signer = Wallet.fromMnemonic("<Inser  wallet  mnemonic>").connect(httpProvider);

This step requires a mnemonic phrase that corresponds to the wallet being used.

  1. Create an instance of the Vendor class:
const vendor = new paymentSmartContract.Vendor(httpProvider, signer);

This class is used to interact with the payment contract.

  1. Create an instance of the Subscription class:
const subscription = new paymentSmartContract.Subscription(vendor);

This class is used to interact with the data contract.

  1. Call the subscriptionAt method to set the subscription data:
await subscription.subscriptionAt(paymentContractAddress, dataContractAddress, tokenAddress, tokenPrecision);
  1. Finally, call the getUserTokenBalance method on the subscription object, passing in the walletAddress parameter. This method retrieves the available balance of the user's token in the payment smart contract. The available balance is then returned by the function.
const  availableBalance  =  await subscription.getUserTokenBalance(walletAddress);

Following these steps will allow you to use the getUserTokenBalance function in desub-js.

Build desub-js

If you would like to build the Desub.JS package locally, follow the steps below. Please note that our current latest stable branch is Master. After cloning, make sure you are on the Master branch.

  1. Clone the Desub.JS code into your local repository by using git clone https://github.com/spheronFdn/desub-js.git.

  2. Install packages using either yarn or npm from the root folder. You can use yarn or npm install.

  3. Run yarn build or npm run build.

Run desub-js tests

If you would like to test the Desub.JS package, follow the steps below. Please note that you need to have all the necessary values in the .env file before running tests. You can ping us on Discord, and we will be happy to share our .env file with you.

  1. Clone the Desub.JS code into your local repository by using git clone https://github.com/spheronFdn/desub-js.git.
  2. Install packages using either yarn or npm from the root folder. You can use yarn or npm install.
  3. Make sure you add all the values in the .env file before running tests.
  4. Run yarn test or npm test.

A sample .env file would look like:


COINMARKETCAP_KEY="COINMARKET_CAP_API_KEY"

BICONOMY_KEY="BICONOMY_API_KEY"

MNEMONIC_TEST="MNEMONIC_FOR_ACCOUNT"

RPC_ENDPOINT="JSON_RPC_ENDPOINT_FOR_ETHEREUM_NETWORK"

Note: you can ping us on discord and we will be happy to share our .env file with you

Contribution

We encourage you to read the contribution guidelines to learn about our development process and how to propose bug fixes and improvements before submitting a pull request.

The Spheron community extends beyond issues and pull requests! You can support Spheron in many other ways as well.

Community

For help, discussions or any other queries: Join us on Discord