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

use-cardano-blockfrost-proxy

v1.0.0

Published

A next.js API route that is designed to be used with use-cardano for the blockfrost-proxy node provider

Downloads

34

Readme

use-cardano Blockfrost Next Proxy API

A next.js API route that is designed to be used with use-cardano for the blockfrost-proxy node provider.

Installation

this package can only be used in the context of a next.js project

  • npm i http-proxy
  • npm i use-cardano-blockfrost-proxy

Usage

1. Add env variables to your .env file

BLOCKFROST_PROJECT_ID_TESTNET=testnetMySecretBlockFrostProjectId
BLOCKFROST_PROJECT_ID_PREVIEW=previewMySecretBlockFrostProjectId
BLOCKFROST_PROJECT_ID_PREPROD=preprodMySecretBlockFrostProjectId
BLOCKFROST_PROJECT_ID_MAINNET=mainnetMySecretBlockFrostProjectId

2. Create an API route under pages/api/blockfrost/[[...all]].ts

export { blockfrostProxy as default } from "use-cardano-blockfrost-proxy"

Or, f you which to execute some additional logic before proxying the request to blockfrost

import { blockfrostProxy } from "use-cardano-blockfrost-proxy"

export default async (req, res) => {
  // do something before proxying the request to blockfrost
  return await blockfrostProxy(req, res)
}

3. Configure use-cardano to use the proxy

import { CardanoProvider, UseCardanoOptions } from "use-cardano"

const options: UseCardanoOptions = {
  node: {
    provider: "blockfrost-proxy",
    proxyUrl: "/api/blockfrost",
  },
}

const App = () => {
  return (
    <CardanoProvider options={options}>
      <div>...</div>
    </CardanoProvider>
  )
}

Why not use a middleware?

While I think it would be technically possible to implement this as a middleware, and that it potentially could be done more elegantly, I don't think it's logically sound to do so, since a middleware is executed for every request in the application, while this approach allows us to only handle the blockfrost requests specifically, at the small cost of the user having to add the file pages/api/blockfrost/[[...all]].ts.

Attribution

This package is based on (read copied) from https://www.npmjs.com/package/next-http-proxy-middleware. I chose to copy the code instead of using the package directly, since I wanted to be able to package the code as an es module and I had issues with typescript that I wanted to avoid.

LICENSE

MIT, see LICENSE for more information.