🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

use-cardano-blockfrost-proxy

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

use-cardano-blockfrost-proxy

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

1.0.0
latest
Version published
Maintainers
1
Created

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.

FAQs

Package last updated on 30 Dec 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts