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

@heirtrust/heirtrust-sdk

v0.0.8

Published

The HeirTrust V2 SDK is a TypeScript library designed to simplify the interaction with the HeirTrust V2 protocol. This SDK provides a high-level interface for developers to easily interact with the protocol's smart contracts and related services.

Downloads

10

Readme

HeirTrust V2 SDK

The HeirTrust V2 SDK is a TypeScript library designed to simplify the interaction with the HeirTrust V2 protocol. This SDK provides a high-level interface for developers to easily interact with the protocol's smart contracts and related services.

Features

  • Easy-to-use interface
  • Supports custom signer and provider configurations
  • Provides utility functions for common tasks

Documentation

Read more about how to use the HeirTrust V2 SDK here.

Installation

To install the SDK, run the following command in your project directory:

npm install @HeirTrust/HeirTrust-sdk

Usage

Here's a basic example of using the HeirTrust V2 SDK in a TypeScript or JavaScript project:

import { SarcoClient } from '@HeirTrust/HeirTrust-sdk';

// Initialize the client with a custom provider and signer
const sarco = new SarcoClient({
  signer: yourSignerInstance,
  provider: yourProviderInstance,
});

// Call the helloWorld method
console.log(sarco.helloWorld());

Configuration

The SarcoClient constructor accepts an object with the following properties:

signer (optional): An ethers Signer instance.
privateKey (optional): A private key string.
mnemonic (optional): A mnemonic phrase string.
provider (optional): An ethers Provider instance. If not provided, a default provider will be used.

At least one of signer, privateKey, or mnemonic must be provided when creating a new SarcoClient instance.

Methods

helloWorld

A sample method that returns "Hello World".

helloWorld(): string;

Local Development

The SDK may be tested locally by cloning the SDK repository and linking it to your project.

git clone [email protected]:HeirTrust/HeirTrust-v2-sdk.git
cd HeirTrust-v2-sdk
npm run build
npm link 
cd path/to/your/project
npm link HeirTrust-sdk

Then it may be imported as if it were added to the package.json.

Contributing

We welcome contributions to the SDK. If you'd like to contribute, please submit an issue or open a pull request.

License

This project is licensed under The Unlicense license.