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

@rsksmart/rif-scheduler-sdk

v2.0.2

Published

RIF Scheduler SDK

Downloads

12

Readme

With the RIF Scheduler SDK you can schedule transactions in the RSK network.

Features:

  • Query and purchase plans
  • Schedule transactions
  • Schedule recurrent transactions
  • Cancel a scheduling
  • Query transactions scheduled and statuses

This is the official SDK for @rsksmart/rif-scheduler-contracts smart contract. Use it to interact with the RIFScheduler smart contract in a more simple way.

Getting Started

@rsksmart/rif-scheduler-sdk is built on top of ethers.

Installation

npm i @rsksmart/rif-scheduler-sdk ethers

Use 0x0372F6F8C7b2353b546F842Da0C44749664d1203 for RSK Testnet

You can run your own instance following this guide

Initialization

First, you will need an ethers provider or signer instance.

In order to create an instance of RifScheduler you will need an ethers provider or signer.

Using a provider will only allow read-only operations, such as getPlan. Using a signer will allow all operations, such as purchasePlan, schedule, etc.

For example, to connect the SDK to Metamask

import { RIFScheduler } from "@rsksmart/rif-scheduler-sdk";
import { providers } from "ethers";

const provider = new providers.Web3Provider(web3.currentProvider);

// Creates instance with provider, you can execute read-only operations
const rifScheduler = new RifScheduler({
    contractAddress: serviceProviderContractAddress,
    providerOrSigner: provider
});

const signer = provider.getSigner();

// Creates instance with signer, you can execute any kind of operation
const rifScheduler = new RifScheduler({
    contractAddress: serviceProviderContractAddress,
    providerOrSigner: signer
});

What you can do with this sdk?

How to contribute

If you want to contribute, here are the steps you need to run this project locally.

Run for development

Install dependencies:

npm i
npm run build

Build to generate types:

npm run build

Run unit tests

npm test

Coverage report with:

npm run test:coverage

Run linter

npm run lint

Auto-fix:

npm run lint:fix

Build for production

npm run build

Branching model

  • main has latest release. Merge into main will deploy to npm. Do merge commits.
  • develop has latest approved PR. PRs need to pass ci and scan. Do squash & merge.
  • Use branches pointing to develop to add new PRs.
  • Do external PRs against latest commit in develop.