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

@origyn/perpetualos-context

v0.2.3

Published

Parses ORIGYN PerpetualOS URLs which access resources in an Internet Computer canister implementing the ORIGYN NFT Standard.

Downloads

49

Readme

ORIGYN PerpetualOS Context Library

Parses ORIGYN PerpetualOS URLs which access resources in an Internet Computer canister implementing the ORIGYN NFT Standard.

For an overview of the PerpetualOS see Welcome to the PerpetualOS.

🏁 Quickstart

npm install @origyn/perpetualos-context

Get a PerpetualOS Context Object from a URL

import { getPerpetualOSContext } from '@origyn/perpetualos-context';

const context = getPerpetualOSContext('https://abcde-biaaa-aaaal-qbhwa-cai.raw.ic0.app/-/epithalamus-amygdala-diencephalon/primary');

console.log('context', context);

Build a PerpetualOS Direct Canister URL

When you need to build a valid PerpetualOS URL in HTML rendering logic, you can use the following functions:

// returns: https://fghij-biaaa-aaaal-qbhwa-cai.raw.icp0.io
const directCanisterUrl = getDirectCanisterUrl('fghij-biaaa-aaaal-qbhwa-cai', true, false);

// returns: https://prptl.io/-/fghij-biaaa-aaaal-qbhwa-cai
const proxyCanisterUrl = getProxyCanisterUrl('fghij-biaaa-aaaal-qbhwa-cai', false);

You can also set the last parameter to true to build local URLs:

// returns: http://fghij-biaaa-aaaal-qbhwa-cai.localhost:8080
const localDirectCanisterUrl = getDirectCanisterUrl('fghij-biaaa-aaaal-qbhwa-cai', false, true);

// returns: http://localhost:3000/-/fghij-biaaa-aaaal-qbhwa-cai
const localProxyCanisterUrl = getProxyCanisterUrl('fghij-biaaa-aaaal-qbhwa-cai', true);

Lookup a Canister ID or Collection ID in the Origyn Phone Book

You can get the canister ID from a collection ID (the name of your NFT collection that can be used in a PerpetualOS URL in place of a canister ID).

The Origyn Phone Book canister provides a mapping between the canister IDs of deploy Origyn NFT canisters and their collection IDs (user friendly name of a collection).

By default, this library will query the mainnet Phone Book canister. This behavior can be overridden by providing another Phone Book canister ID, such as one running locally.

To deploy a full local network including Dfinity nns canisters and Origyn system canisters, see https://github.com/ORIGYN-SA/minting-starter.

Use mainnet Phone Book:

const nftCanisterId = await lookupCanisterId('my-cool-collection');
console.log(nftCanisterId);

const nftCollectionId = await lookupCollectionId('abcde-biaaa-aaaal-qbhwa-cai');
console.log(nftCollectionId);

Use an environment specific Phone Book canister (local or mainnet depending on environment variables):

const nftCanisterId = await lookupCanisterId('my-cool-collection', process.env.PHONE_BOOK_CANISTER_ID, process.env.IS_LOCAL);
console.log(nftCanisterId);

const nftCollectionId = await lookupCollectionId('abcde-biaaa-aaaal-qbhwa-cai', process.env.PHONE_BOOK_CANISTER_ID, process.env.IS_LOCAL);
console.log(nftCollectionId);

Build

npm ci
npm run build

PerpetualOS Context

PerpetualOS Context is created by parsing the PerpetualOS URL. It provides information about the canister, collection, token, library asset or other resource being requested by the URL.

Context Object

See the URLContext interface comments in types.ts.

Canister References:

A canister reference is the first part of the PerpetualOS URL that references a canister.

The following URLs are validated and parsed using the DirectCanisterUrl and ProxyCanisterUrl regular expressions in regex-patterns.ts.

  • Direct to Canister
    • Localhost
      • Direct to local canister
        • http://{canister_id}.localhost:8080
      • Webpack dev server to local canister
        • http://localhost:8081/-/{canister_id}
    • Mainnet
      • Canisters created before Apr 20, 2023
        • https://{canister_id}.raw.ic0.app
        • https://{canister_id}.ic0.app
      • Canisters created before or after Apr 20, 2023
        • https://{canister_id}.raw.icp0.io
        • https://{canister_id}.icp0.io
      • Webpack dev server to mainnet canister
        • http://localhost:9000/-/{canister_id}
  • Via Proxy
    • Localhost (uses local proxy)
      • http://localhost:3000/-/{canister_id}
    • Webpack dev server to Mainnet Canister (uses mainnet proxy)
      • http://localhost:9000/-/{canister_id}
    • Mainnet
      • Current domain
        • https://prptl.io/-/{canister_id}
      • Current direct proxy
        • https://icx-proxy.origyn.ch/-/{canister_id}
      • Legacy domain
        • https://exos.origyn.network/-/{canister_id}
  • Via Proxy + Phonebook (to Lookup Collection ID)
    • Localhost
      • http://localhost:3000/-/{collection_id} (lookup canister_id from collection_id)
    • Webpack dev server to Mainnet Canister (uses mainnet proxy)
      • http://localhost:9000/-/{collection_id} (lookup canister_id from collection_id)
    • Mainnet
      • Current domain
        • https://prptl.io/-/{collection_id} (lookup canister_id from collection_id)
      • Current direct proxy
        • https://icx-proxy.origyn.ch/-/{collection_id} (lookup canister_id from collection_id)
      • Legacy domain
        • https://exos.origyn.network/-/{collection_id} (lookup canister_id from collection_id)

Canister-Relative Path (PerpetualOS URL Paths):

A canister-relative path in this project refers to the part of the URL after the canister reference, but not including the query string or fragment (if provided).

This part of the URL specifies the resource that is being requested from the canister.

This is similar to a root-relative URL, but since canister references can either be a root-URL (direct to canister), or a root-URL with 2 additional segments (prptl.io domain with reverse proxy), we need a different term for this path following the canister reference.

For a list of all canister-relative paths, see the ResourceType enum comments in types.ts.

Note that hyphens in URLs are placeholders for future data and are currently ignored.

Examples

  • canister_id: abcde-biaaa-aaaal-qbhwa-cai
  • collection_id: brain-matters-dev (lookup function with that name returns canister_id abcde-biaaa-aaaal-qbhwa-cai)
  • token_id: epithalamus-amygdala-diencephalon
  • URL to the collection's preview image: https://abcde-biaaa-aaaal-qbhwa-cai.raw.ic0.app/collection/preview
  • URL to the marketplace dApp at the collection level: https://abcde-biaaa-aaaal-qbhwa-cai.raw.ic0.app/collection/-/marketplace#/epithalamus-amygdala-diencephalon
  • URL to the marketplace dApp at the token level: https://abcde-biaaa-aaaal-qbhwa-cai.raw.ic0.app/-/epithalamus-amygdala-diencephalon/-/marketplace#/thalamus-neocortex-brainstem
  • URL to an experience page: https://abcde-biaaa-aaaal-qbhwa-cai.raw.ic0.app/-/epithalamus-amygdala-diencephalon/ex
  • URL to a primary asset: https://abcde-biaaa-aaaal-qbhwa-cai.raw.ic0.app/-/epithalamus-amygdala-diencephalon/primary

Note: The ORIGYN Phone Book canister maps collection IDs to canister IDs.