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

@minka/bridge-sdk

v2.17.1

Published

## Components

Downloads

608

Readme

Bridge SDK

Components

Bridge SDK provides two main components:

  • Server
  • Processor

Server

Server implements two-phase protocol for the ledger. Incoming requests are persisted in the bridge database as entries, intents and commands. When processing is requred, job is created which will be assigned to an available processor for processing.

Server provides proxy to the ledger in order for 3rd party system to be able to communicate with the ledger. Proxy will establish secure communication when calling the ledger and sign payload with the bridge key when needed.

Effects can also be registered in the server. Effects are used to extend the ledger core functionalities by observing and reacting on events raised when a change occurs with ledger data.

Exposed two-phase commit endpoints:

| Method | Path | Description | | ------ | ----------------------------- | ----------------------------- | | POST | /v2/credits | prepares credit transaction | | POST | /v2/credits/<handle>/abort | aborts credit transaction | | POST | /v2/credits/<handle>/commit | commits credit transaction | | POST | /v2/debits | prepares debit transaction | | POST | /v2/debits/<handle>/abort | aborts debit transaction | | POST | /v2/debits/<handle>/commit | commits debit transaction | | PUT | /v2/intents/<handle> | updates intent record |

Exposed job endpoints:

| Method | Path | Description | | ------ | ---------------------------- | ---------------------------------------- | | POST | /v2/jobs/<handle>/continue | schedules suspended job for processing |

Exposed proxy endpoints:

| Method | Path | Description | | ------ | ------------------------------------- | ----------------------- | | POST | /v2/proxy/intents | create an intent | | GET |  /v2/proxy/intents |  fetch intents | | GET | /v2/proxy/intents/<handle> | fetch an intent | | POST | /v2/proxy/signers | create a signer | | PUT | /v2/proxy/signers/<handle> | update a signer | | GET |  /v2/proxy/signers | fetch signers | | GET | /v2/proxy/signers/<handle> | fetch a signer | | POST | /v2/proxy/wallets | create a wallet | | PUT | /v2/proxy/wallets/<handle> | update a wallet | | GET |  /v2/proxy/wallets | fetch wallets | | GET | /v2/proxy/wallets/<handle> | fetch a wallet | | GET | /v2/proxy/wallets/<handle>/balances | fetch wallet balances |

Exposed effects endpoints: | Method | Path | Description | | ------ | ------------------------------------- | ------------------------------- | | POST | /v2/effects/<handle> | executes a registered effect |

Processor

Processor listens for pending jobs in the system and executes them. Each processor must have unique handle in the system which is used for job balancing across processors. Processing of a job can be suspended for predefined time (e.g. 5 minutes, waiting for banking core) or indefinitely which requires manual job continuation.

Running unit tests

Run nx test bridge-sdk to execute the unit tests via Jest.

Running lint

Run nx lint bridge-sdk to execute the lint via ESLint.