@web3-storage/blob-index

v1.0.4

An index for slices that may be sharded across multiple blobs. For more information about how to use this package see README

Latest version published 4 months ago

License: Apache-2.0 OR MIT

NPM

GitHub

Package Health Score

81 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

indexeddb
42

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.0.4	\|	07/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0 OR MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,756)

GitHub Stars: 61
Forks: 22
Contributors: 30

Direct Usage Popularity

The npm package @web3-storage/blob-index receives a total of 1,756 downloads a week. As such, we scored @web3-storage/blob-index popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @web3-storage/blob-index, we found that it has been starred 61 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the @web3-storage/blob-index repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @web3-storage/blob-index is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 167
Open PR: 32
Last Release: 4 months ago
Last Commit: 11 days ago

Further analysis of the maintenance status of @web3-storage/blob-index based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @web3-storage/blob-index demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=16.15

Age: 6 months
Dependencies: 8 Direct
Versions: 5
Install Size: 126 kB
Dist-tags: 1
# of Files: 44
Maintainers: 5
TS Typings: No

@web3-storage/blob-index has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

`@web3-storage/blob-index`

An index for slices that may be sharded across multiple blobs.

Install

npm install @web3-storage/blob-index

Usage

Create:

import { ShardedDAGIndex } from '@web3-storage/blob-index'

// Create a brand new index
const index = ShardedDAGIndex.create(rootCID)

// Add index data for slices within a shard
index.setSlice(shardMultihash, sliceMultihash, [offset, length])
// ...

// Create CAR archive
const result = index.archive()

console.log(result.ok) // a Uint8Array

Read:

import { ShardedDAGIndex } from '@web3-storage/blob-index'
import { base58btc } from 'multiformats/bases/base58'

const index = ShardedDAGIndex.extract(car)

console.log(index.content)

for (const [shard, slices] of index.shards.entries()) {
  console.log(`Shard ${base58btc.encode(shard.bytes)}`)
  console.log('  Slices:')
  for (const [slice, [offset, length]] of slices.entries()) {
    console.log(`    ${base58btc.encode(slice.bytes)} @ ${offset} -> ${offset + length}`)
  }
}

// Output:
// Shard zQmQKw6B745GGL3eeTcEE5kAoLAJgkBQydJPC5fWv5HA68A
//  Slices:
//    zQmeHPRNRDxHU5YMPewcBCbPYxzA3jBcadAZQwpQXm3jFFt @ 96 -> 128
// ...

Contributing

Feel free to join in. All welcome. Please open an issue!

License

Dual-licensed under MIT + Apache 2.0

@web3-storage/blob-index dependencies

@ipld/dag-cbor @storacha/one-webcrypto @ucanto/core @ucanto/interface carstream multiformats uint8arrays @web3-storage/capabilities

@web3-storage/blob-index development dependencies

@ucanto/transport c8 entail typescript @web3-storage/eslint-config-w3up

FAQs

What is @web3-storage/blob-index?

An index for slices that may be sharded across multiple blobs. Visit Snyk Advisor to see a full health score report for @web3-storage/blob-index, including popularity, security, maintenance & community analysis.

Is @web3-storage/blob-index popular?

The npm package @web3-storage/blob-index receives a total of 1,756 weekly downloads. As such, @web3-storage/blob-index popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @web3-storage/blob-index well maintained?

We found that @web3-storage/blob-index demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @web3-storage/blob-index safe to use?

The npm package @web3-storage/blob-index was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 16 November-2024, at 22:44 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,756)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@web3-storage/blob-index

Install

Usage

Contributing

License

@web3-storage/blob-index dependencies

@web3-storage/blob-index development dependencies

FAQs

What is @web3-storage/blob-index?

Is @web3-storage/blob-index popular?

Is @web3-storage/blob-index well maintained?

Is @web3-storage/blob-index safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`@web3-storage/blob-index`