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

@fileverse/heartbit-core

v2.4.0

Published

## Introduction

Downloads

32

Readme

HeartBit Core

Introduction

This is the core of the HeartBit functionality. It exposes the APIs that are crucial for implementing HeartBit functionalities.

Getting Started

Installation

You can install the package using either npm or yarn:

npm install --save @fileverse/heartbit-core

// or

yarn add @fileverse/heartbit-core

Import and Use the Package

import { HeartBitCore } from "@fileverse/heartbit-core";

Configure the Package

The SDK utilizes coreOption to configure the network for user interactions.

const coreSDK = new HeartBitCore({
  chain: "0xaa36a7",
});

Example Usage - mintHeartBit (Signed Mint)

This minimal example demonstrates how to use HeartBitCore for minting and querying data.

async function main() {
  const message = "Hello World!";
  const signature = "0x...signed message";
  const startTime = 1706898250;
  const endTime = 1706898251;
  const hash = "ipfs://somecid"; // unique identifier for token. eg ipfs://somecid

  // Mint HeartBit

  await coreSDK.mintHeartBit({
    message,
    signature,
    startTime,
    endTime,
    hash,
  });

  // Get TotalSupply for a hash

  const totalSupply = await coreSDK.getTotalHeartBitCountByHash({ hash });

  // Get Total Mints By User
  const account = "0x...ethaddress";
  const mintsByUser = await coreSDK.getHeartBitByUser({
    hash,
    account,
  });
}

Here is a link to a working example using HeartBitCore.

Example Usage - unSignedMintHeartBit (Unsigned Mint)

This minimal example demonstrates how to use HeartBitCore for minting heartbit without signature.

async function main() {
  const startTime = 1706898250;
  const endTime = 1706898251;
  const hash = "ipfs://cid"; // unique identifier for token. eg ipfs://somecid
  const apiKey = "hello";
  const account = "0x...ethaddress";

  // Mint HeartBit

  await coreSDK.unSignedMintHeartBit({
    startTime,
    endTime,
    hash,
    account,
    apiKey,
  });

  // Get TotalSupply for a hash

  const totalSupply = await coreSDK.getTotalHeartBitCountByHash({ hash });

  // Get Total Mints By User
  const mintsByUser = await coreSDK.getHeartBitByUser({
    hash,
    account,
  });
}

Interfaces

type SupportedChain = "0xaa36a7" | "0x2105" | "0x64";

interface HeartBitCoreOptions {
  chain: SupportedChain;
  rpcUrl?: string;
}

interface TotalHeartBitCountArgs {
  hash: string; // unique identifier for token. eg ipfs://somecid
}

interface HeartBitCountByUserArgs {
  hash: string; // unique identifier for token. eg ipfs://somecid
  account: string; // ethereum wallet address
}

interface MintHeartBitArgs {
  message: string;
  signature: string;
  startTime: number; // in seconds
  endTime: number; // in seconds
  hash: string; // unique identifier for token. eg ipfs://somecid
}

interface UnSignedMintArgs {
  startTime: number;
  endTime: number;
  hash: string; // unique identifier for token. eg ipfs://somecid
  account: string; // target wallet address to which heartbits should be minted
  apiKey: string; // Api Key
}

Checkout HeartBit React which uses the HeartBitCore to integrate HeartBit functionality in a react app.