Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@pinata/ipfs-gateway-tools
Advanced tools
IPFS Gateway Tools
This toolkit contains helper functions for working with IPFS gateway URLs and transforming them as desired.
This package comes with a distributions for the browser and for NodeJS. Take care to ensure you are importing or requiring in the right version.
npm install --save @pinata/ipfs-gateway-tools
To require this in your project simply include the library at the top of your file like so:
import IPFSGatewayTools from '@pinata/ipfs-gateway-tools/dist/browser';
const gatewayTools = new IPFSGatewayTools();
const IPFSGatewayTools = require('@pinata/ipfs-gateway-tools/dist/node');
const gatewayTools = new IPFSGatewayTools();
The IPFS gateway toolkit currently contains the following functions:
ipfsGatewayTools.containsCID(url)
url
- A gateway url that should take one of the following forms:
ipfs://CID
ipfs://ipfs/CID
https://example-gateway.com/ipfs/CID
https://example-gateway.com/ipfs/CID/exampleFile.json
https://example-gateway.com/ipns/CID
{
containsCid: (Boolean) - True if the url contains a CID,
cid: (string) - The CID that the url contains if "containsCid" is true
}
ipfsGatewayTools.convertToDesiredGateway(sourceUrl, desiredGatewayPrefix)
sourceUrl
- A gateway url that should take one of the following forms:
ipfs://CID
ipfs://ipfs/CID
https://example-gateway.com/ipfs/CID
https://example-gateway.com/ipfs/CID/exampleFile.json
https://example-gateway.com/ipns/CID
desiredGatewayPrefix
- The desired gateway you want to convert your source URL to. A few examples of this would be:
https://mygateway.mypinata.cloud
https://ipfs.io
Returns a string that uses the desired source gateway prefix.
Example code:
const sourceUrl = 'https://exampleGateway.com/ipfs/bafybeifx7yeb55armcsxwwitkymga5xf53dxiarykms3ygqic223w5sk3m';
const desiredGatewayPrefix = 'https://mygateway.mypinata.cloud'
const convertedGatewayUrl = ipfsGatewayTools.convertToDesiredGateway(sourceUrl, desiredGatewayPrefix);
//In the example above, the resulting value for convertedGatewayUrl would be: https://mygateway.mypinata.cloud/ipfs/bafybeifx7yeb55armcsxwwitkymga5xf53dxiarykms3ygqic223w5sk3m
Feel free to file a github issue or email us at team@pinata.cloud
We'd love to hear from you!
FAQs
Toolkit for working with IPFS Gateways and CIDs
The npm package @pinata/ipfs-gateway-tools receives a total of 543 weekly downloads. As such, @pinata/ipfs-gateway-tools popularity was classified as not popular.
We found that @pinata/ipfs-gateway-tools demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
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.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.