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

@bundly/ares-core

v0.2.0

Published

Client library for interacting with the Internet Computer

Downloads

63

Readme

ares-core

A JavaScript frontend library for interacting with ICP Backend Canisters and Identity Providers.

NOTE: This is a Beta version

How to use

To create a Client instance you must call the static method create and later you must call the init method:

const client = Client.create({});
await client.init();

Implement Identity Providers

Most implementations use Identity Providers to call canisters with autenticated identities, so its necesary to declare which Identity Providers you want to use:

const client = Client.create({
  providers: [
    new InternetIdentity({
      providerUrl: process.env.NEXT_PUBLIC_INTERNET_IDENTITY_URL!,
    }),
  ],
});

See following example to start an authentication process:

const provider = client.getProvider("internet-identity");
provider.connect();

Then, you can get all the authenticated identities:

const identities = client.getIdentities();

Register Canisters

Ares Client supports two kind of Canisters:

  • Candid Canisters: Traditional Canisters that you can build according the Internet Computer Protocol
  • Http Canisters: Canisters Build according the HTTP Gateway Protocol, this is an Experimental feature.

To use candid canisters you can follow the example below:


import { _SERVICE, idlFactory } from "path_to_canister_declarations/test.did.js";

export const candidTest: Canister = {
	idlFactory,
	configuration: {
		canisterId: "TEST_CANDID_CANISTER_ID",
	},
};

const client = Client.create({
  agentConfig: {
    host: "IC_HOST_URL",
  },
  ...
  candidCanisters: {
    candidTest
  }
});

const candidActor = client.getCandidActor("candidTest");

To use http canisters you can follow the example below:

export const httpTest: Canister = {
  baseUrl: "API_REST_URL"
};

const client = Client.create({
  ...
  restCanisters: {
    httpTest
  }
});

const candidActor = client.getRestActor("httpTest");

You can use both canisters (candid and http) at the same time:

const client = Client.create({
  agentConfig: {
    host: "IC_HOST_URL",
  },
  ...
  candidCanisters: {
    candidTest
  },
  restCanisters: {
    httpTest
  }
});

Advanced features

Build CustomProviders

Ares defines some prebuild Identity Providers, but if you like to implement your own, you neet to create a class that implements the IdentityProvider interface:

export class MyCustomIdentityProvider implements IdentityProvider {}

For a complete implementation you can see how the InternetIdentity provider is built.

Use Custom Storage

You can define custom storage (where identities and some configurations will be stored), for that, yo need to create a class that implements the ClientStorageInterface:

class MyCustomStorage implements ClientStorageInterface {}