Skip to content

pryzm-finance/pryzmaticsjs

Repository files navigation

PryzmaticsJs: Javascript SDK for pryzm-finance/pryzmatics

PryzmaticsJs is a JavaScript software development kit (SDK) that enables the development of applications that interact with the Pryzm blockchain indexer (Pryzmatics) from both Node.js and web browsers.

Install

pnpm install @pryzm-finance/pryzmaticsjs

Usage

PryzmaticsClient

import { createPryzmaticsClient } from "@pryzm-finance/pryzmaticsjs";

const pryzmaticsClient = await createPryzmaticsClient({restEndpoint: PRISMATICS_ENDPOINT})

const syncInfo = (await pryzmaticsClient.pryzmatics.syncInfo()).sync_info

Example Project

example is a sample project that depends on @pryzm-finance/pryzmaticsjs and contains examples on how to query data.

Developing

When first cloning the repo:

pnpm install

Codegen

Proto files live in ./proto. Look inside of scripts/codegen.js and configure the settings for bundling your SDK into @pryzm-finance/pryzmaticsjs:

pnpm codegen

Publishing

Build the types and then publish:

pnpm compile
pnpm publish

Credits

🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️

Code built with the help of these related projects: