Skip to content

Commit

Permalink
Merge branch 'feat/adjust-shard-size' of github.com:web3-storage/w3up…
Browse files Browse the repository at this point in the history
… into feat/adjust-shard-size
  • Loading branch information
Alan Shaw committed Sep 6, 2023
2 parents b76919a + c85ecff commit 6a1ebcf
Show file tree
Hide file tree
Showing 13 changed files with 4 additions and 1,143 deletions.
1 change: 1 addition & 0 deletions .github/workflows/reusable-deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ jobs:
registry-url: 'https://registry.npmjs.org'
cache: 'pnpm'
- run: pnpm install
- run: pnpm build
- run: pnpm run lint
- run: pnpm run docs
- uses: actions/configure-pages@v2
Expand Down
10 changes: 0 additions & 10 deletions packages/upload-client/src/car.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,6 @@ export class BlockStream extends ReadableStream {
let blocksPromise = null
const getBlocksIterable = () => {
if (blocksPromise) return blocksPromise
// FIXME: remove when resolved: https://github.com/nodejs/node/issues/48916
/* c8 ignore next 10 */
if (parseInt(globalThis.process?.versions?.node) > 18) {
blocksPromise = (async () => {
// @ts-expect-error
const bytes = await car.arrayBuffer()
return CarBlockIterator.fromBytes(new Uint8Array(bytes))
})()
return blocksPromise
}
blocksPromise = CarBlockIterator.fromIterable(toIterable(car.stream()))
return blocksPromise
}
Expand Down
4 changes: 3 additions & 1 deletion packages/w3up-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ questions!

This library is the user-facing "porcelain" client for interacting with w3up services from JavaScript. It wraps the lower-level [`@web3-storage/access`][access-client-github] and [`@web3-storage/upload-client`][upload-client-github] client packages, which target individual w3up services. We recommend using `w3up-client` instead of using those "plumbing" packages directly, but you may find them useful if you need more context on w3up's architecture and internals.

**`w3up-client` requires Node 18 or higher**.

> ⚠️❗ __Public Data__ 🌎: All data uploaded to w3up is available to anyone who requests it using the correct CID. Do not store any private or sensitive information in an unencrypted form using w3up.
> ⚠️❗ __Permanent Data__ ♾️: Removing files from w3up will remove them from the file listing for your account, but that doesn’t prevent nodes on the decentralized storage network from retaining copies of the data indefinitely. Do not use w3up for data that may need to be permanently deleted in the future.
Expand Down Expand Up @@ -47,7 +49,7 @@ npm install @web3-storage/w3up-client

[API Reference](#api)

Most users' usage of `w3up-client` will be for interacting with web3.storage, a hosted storage product that developed w3up for their upload APIs. However, any user that has an implementation of w3up ([specs](https://github.com/web3-storage/specs), [protocol](https://github.com/web3-storage/w3protocol/)) can configure `w3up-client` for their usage.
Most users' usage of `w3up-client` will be for interacting with web3.storage, a hosted storage product that developed w3up for their upload APIs. However, any user that has an implementation of w3up ([specs](https://github.com/web3-storage/specs), [protocol](https://github.com/web3-storage/w3up)) can configure `w3up-client` for their usage.

For authorization, w3up services use [ucanto][ucanto], a Remote Procedure Call (RPC) framework built around [UCAN](https://ucan.xzy), or User Controlled Authorization Networks. UCANs are a powerful capability-based authorization system that allows fine-grained sharing of permissions through a process called _delegation_ on top of [public key cryptography](https://en.wikipedia.org/wiki/Public-key_cryptography). See our [intro to UCAN blog post](https://blog.web3.storage/posts/intro-to-ucan) for an overview of UCAN.

Expand Down
305 changes: 0 additions & 305 deletions spec/access-identify.md

This file was deleted.

Loading

0 comments on commit 6a1ebcf

Please sign in to comment.