Skip to content

Commit

Permalink
chore: package renames
Browse files Browse the repository at this point in the history
  • Loading branch information
alanshaw committed Nov 1, 2024
1 parent b43804c commit 0f797ed
Show file tree
Hide file tree
Showing 257 changed files with 846 additions and 848 deletions.
18 changes: 9 additions & 9 deletions .github/release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"packages/access-client": "20.1.0",
"packages/blob-index": "1.0.4",
"packages/filecoin-api": "7.3.2",
"packages/filecoin-client": "3.3.4",
"packages/capabilities": "17.4.0",
"packages/upload-api": "18.1.0",
"packages/upload-client": "17.1.0",
"packages/w3up-client": "16.4.0",
"packages/did-mailto": "2.0.2"
"packages/access-client": "0.0.0",
"packages/blob-index": "0.0.0",
"packages/filecoin-api": "0.0.0",
"packages/filecoin-client": "0.0.0",
"packages/capabilities": "0.0.0",
"packages/upload-api": "0.0.0",
"packages/upload-client": "0.0.0",
"packages/w3up-client": "0.0.0",
"packages/did-mailto": "0.0.0"
}
8 changes: 4 additions & 4 deletions .github/workflows/access-client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
cache: 'pnpm'
- run: pnpm install
- run: pnpm run build
- run: pnpm -r --filter @web3-storage/access run lint
- run: pnpm -r --filter @web3-storage/access run test
- run: pnpm -r --filter @web3-storage/access exec depcheck
- run: pnpm --filter '@web3-storage/access' attw
- run: pnpm -r --filter @storacha/access run lint
- run: pnpm -r --filter @storacha/access run test
- run: pnpm -r --filter @storacha/access exec depcheck
- run: pnpm --filter '@storacha/access' attw
6 changes: 3 additions & 3 deletions .github/workflows/blob-index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ jobs:
node-version: 18
registry-url: https://registry.npmjs.org/
cache: 'pnpm'
- run: pnpm --filter '@web3-storage/blob-index...' install
- run: pnpm --filter '@web3-storage/blob-index' lint
- run: pnpm --filter '@web3-storage/blob-index' test
- run: pnpm --filter '@storacha/blob-index...' install
- run: pnpm --filter '@storacha/blob-index' lint
- run: pnpm --filter '@storacha/blob-index' test
6 changes: 3 additions & 3 deletions .github/workflows/capabilities.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ jobs:
cache: 'pnpm'
- run: pnpm install
- run: pnpm run build
- run: pnpm -r --filter @web3-storage/capabilities run lint
- run: pnpm -r --filter @web3-storage/capabilities run test
- run: pnpm -r --filter @web3-storage/capabilities exec depcheck
- run: pnpm -r --filter @storacha/capabilities run lint
- run: pnpm -r --filter @storacha/capabilities run test
- run: pnpm -r --filter @storacha/capabilities exec depcheck
6 changes: 3 additions & 3 deletions .github/workflows/did-mailto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ jobs:
node-version: 18
registry-url: https://registry.npmjs.org/
cache: 'pnpm'
- run: pnpm --filter '@web3-storage/did-mailto...' install
- run: pnpm --filter '@web3-storage/did-mailto' lint
- run: pnpm --filter '@web3-storage/did-mailto' test
- run: pnpm --filter '@storacha/did-mailto...' install
- run: pnpm --filter '@storacha/did-mailto' lint
- run: pnpm --filter '@storacha/did-mailto' test
4 changes: 2 additions & 2 deletions .github/workflows/filecoin-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ jobs:
pnpm run --if-present build
- name: Lint
run: pnpm -r --filter @web3-storage/filecoin-api run lint
run: pnpm -r --filter @storacha/filecoin-api run lint
- name: Test
run: pnpm -r --filter @web3-storage/filecoin-api run test
run: pnpm -r --filter @storacha/filecoin-api run test
6 changes: 3 additions & 3 deletions .github/workflows/filecoin-client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ jobs:
cache: 'pnpm'
- run: pnpm install
- run: pnpm run build
- run: pnpm -r --filter @web3-storage/filecoin-client run lint
- run: pnpm -r --filter @web3-storage/filecoin-client run test
- run: pnpm -r --filter @web3-storage/filecoin-client run attw
- run: pnpm -r --filter @storacha/filecoin-client run lint
- run: pnpm -r --filter @storacha/filecoin-client run test
- run: pnpm -r --filter @storacha/filecoin-client run attw
12 changes: 6 additions & 6 deletions .github/workflows/manual.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ jobs:
registry-url: 'https://registry.npmjs.org'
cache: 'pnpm'
- run: pnpm install
- run: pnpm -r --filter @web3-storage/access build
- run: pnpm -r --filter @web3-storage/access run rc || true # this fails because npm does not support workspace protocol so we force it to exit 0
- run: pnpm -r --filter @storacha/access build
- run: pnpm -r --filter @storacha/access run rc || true # this fails because npm does not support workspace protocol so we force it to exit 0
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: 'chore(access): Bump access sdk pre release version'
- run: pnpm -r --filter @web3-storage/access publish --tag next --access public
- run: pnpm -r --filter @storacha/access publish --tag next --access public
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
deploy-upload-client:
Expand All @@ -57,11 +57,11 @@ jobs:
registry-url: 'https://registry.npmjs.org'
cache: 'pnpm'
- run: pnpm install
- run: pnpm -r --filter @web3-storage/upload-client build
- run: pnpm -r --filter @web3-storage/upload-client run rc || true # this fails because npm does not support workspace protocol so we force it to exit 0
- run: pnpm -r --filter @storacha/upload-client build
- run: pnpm -r --filter @storacha/upload-client run rc || true # this fails because npm does not support workspace protocol so we force it to exit 0
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: 'chore(client): Bump client pre release version'
- run: pnpm -r --filter @web3-storage/upload-client publish --tag next --access public
- run: pnpm -r --filter @storacha/upload-client publish --tag next --access public
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
4 changes: 2 additions & 2 deletions .github/workflows/upload-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ jobs:
pnpm run --if-present build
- name: Test
run: pnpm -r --filter @web3-storage/upload-api run test
run: pnpm -r --filter @storacha/upload-api run test

- name: Dependency check
run: pnpm -r --filter @web3-storage/upload-api exec depcheck
run: pnpm -r --filter @storacha/upload-api exec depcheck
6 changes: 3 additions & 3 deletions .github/workflows/upload-client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ jobs:
cache: 'pnpm'
- run: pnpm install
- run: pnpm run build
- run: pnpm -r --filter @web3-storage/upload-client run lint
- run: pnpm -r --filter @web3-storage/upload-client run test
- run: pnpm -r --filter @web3-storage/upload-client exec depcheck
- run: pnpm -r --filter @storacha/upload-client run lint
- run: pnpm -r --filter @storacha/upload-client run test
- run: pnpm -r --filter @storacha/upload-client exec depcheck
4 changes: 2 additions & 2 deletions .github/workflows/w3up-client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ jobs:
node-version: ${{ matrix.node_version }}
registry-url: https://registry.npmjs.org/
cache: 'pnpm'
- run: pnpm --filter '@web3-storage/w3up-client...' install
- run: pnpm --filter '@web3-storage/w3up-client' attw
- run: pnpm --filter '@storacha/client' install
- run: pnpm --filter '@storacha/client' attw
- uses: ./packages/w3up-client/.github/actions/test
with:
w3up-client-dir: ./packages/w3up-client/
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

Join in. All welcome! web3.storage is open-source. The code is dual-licensed under [MIT + Apache 2.0](license.md)
Join in. All welcome! storacha.network is open-source. The code is dual-licensed under [MIT + Apache 2.0](license.md)

This project uses node v18 and `pnpm`. It's a monorepo that use [pnpm workspaces](https://pnpm.io/workspaces) to handle resolving dependencies between the local `packages/*` folders.

Expand All @@ -13,8 +13,6 @@ We use `pnpm` in this project and commit the `pnpm-lock.yaml` file.
```bash
# install all dependencies in the mono-repo
pnpm install
# setup git hooks
npx simple-git-hooks
# setup environment variables
cp .env.tpl .env
```
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# `w3up`
# Upload Service

This repo implements the web3.storage UCAN protocol [specifications](https://github.com/storacha/specs).
This repo implements the storacha.network UCAN protocol [specifications](https://github.com/storacha/specs).

It's the core of the web3.storage server and client implementations.
It's the core of the storacha.network server and client implementations.

## Usage

Store your files with web3.storage and retrieve them via their unique Content ID. Our tools make it simple to hash your content locally, so you can verify the service only ever stores the exact bytes you asked us to. Pick the method of using web3.storage that works for you!
Store your files with storacha.network and retrieve them via their unique Content ID. Our tools make it simple to hash your content locally, so you can verify the service only ever stores the exact bytes you asked us to. Pick the method of using storacha.network that works for you!

### Website

Visit https://console.web3.storage and upload right from the website.
Visit https://console.storacha.network and upload right from the website.

Under the hood it uses the web3.storage client that we publish to npm to chunk and hash your files to calculate the root IPFS CID **in your browser** before sending them to https://up.web3.storage.
Under the hood it uses the storacha.network client that we publish to npm to chunk and hash your files to calculate the root IPFS CID **in your browser** before sending them to https://up.storacha.network.

Once uploaded you can fetch your data from any IPFS gateway via [`https://w3s.link/ipfs/<root cid>`](https://w3s.link/ipfs/bafkreigh2akiscaildcqabsyg3dfr6chu3fgpregiymsck7e7aqa4s52zy)

### Command Line

Install [`@web3-storage/w3cli`](https://github.com/storacha/w3cli#readme) globally, authorize it to act on your behalf, create a space and upload your files. It calculates the root CID for your files locally before sending them to web3.storage.
Install [`@web3-storage/w3cli`](https://github.com/storacha/w3cli#readme) globally, authorize it to act on your behalf, create a space and upload your files. It calculates the root CID for your files locally before sending them to storacha.network.

**shell**
```shell
Expand All @@ -38,14 +38,14 @@ Run `w3 --help` or have a look at https://github.com/storacha/w3cli to find out

### JS Client

Add the [`@web3-storage/w3up-client`](https://www.npmjs.com/package/@web3-storage/w3up-client) module into your project with `npm i @web3-storage/w3up-client` and upload a single file with [`client.uploadFile`](https://github.com/storacha/w3up/blob/main/packages/w3up-client/README.md#uploadfile) or many with [`client.uploadDirectory`](https://github.com/storacha/w3up/blob/main/packages/w3up-client/README.md#uploaddirectory).
Add the [`@storacha/client`](https://www.npmjs.com/package/@storacha/client) module into your project with `npm i @storacha/client` and upload a single file with [`client.uploadFile`](https://github.com/storacha/upload-service/blob/main/packages/w3up-client/README.md#uploadfile) or many with [`client.uploadDirectory`](https://github.com/storacha/upload-service/blob/main/packages/w3up-client/README.md#uploaddirectory).

If you've already got a space you can upload like this:

**node.js**
```js
import { filesFromPaths } from 'files-from-path'
import * as Client from '@web3-storage/w3up-client'
import * as Client from '@storacha/client'

const [,,yourEmail, pathToAdd] = process.argv

Expand All @@ -61,13 +61,13 @@ console.log(`IPFS CID: ${cid}`)
console.log(`Gateway URL: https://w3s.link/ipfs/${cid}`)
```

See https://web3.storage/docs/w3up-client for a guide to using the js client for the first time.
See https://docs.storacha.network/w3up-client for a guide to using the js client for the first time.

For an interactive command line adventure into the using w3up check out `learnyouw3up` here https://github.com/storacha/learnyouw3up

### GitHub Action

The Action [`add-to-web3`](https://github.com/marketplace/actions/add-to-web3) wraps [`w3cli`](https://github.com/storacha/w3cli) to let you add files to web3.storage from your GitHub Workflows.
The Action [`add-to-web3`](https://github.com/marketplace/actions/add-to-web3) wraps [`w3cli`](https://github.com/storacha/w3cli) to let you add files to storacha.network from your GitHub Workflows.

**github-workflow.yaml**
```yaml
Expand All @@ -90,9 +90,9 @@ To generate a `secret_key` and delegate permissions to it as a `proof` to use in

## Contributing

All welcome! web3.storage is open-source. See the [contributing guide](./CONTRIBUTING.md)
All welcome! storacha.network is open-source. See the [contributing guide](./CONTRIBUTING.md)

This project uses node v18 and `pnpm`. It's a monorepo that uses [pnpm workspaces](https://pnpm.io/workspaces) to handle resolving dependencies between the local [`packages`](https://github.com/storacha/w3up/tree/main/packages)
This project uses node v18 and `pnpm`. It's a monorepo that uses [pnpm workspaces](https://pnpm.io/workspaces) to handle resolving dependencies between the local [`packages`](https://github.com/storacha/upload-service/tree/main/packages)

## License

Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
// to generate docusaurus-compatible markdown from typedoc output.

const config = {
title: 'Web3.Storage Documentation',
title: 'Storacha Documentation',
tagline: 'The simple file storage service for IPFS and Filecoin',
url: 'https://docs.web3.storage',
url: 'https://docs.storacha.network',
baseUrl: '/',
onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
Expand Down
20 changes: 10 additions & 10 deletions packages/access-client/package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "@web3-storage/access",
"version": "20.1.0",
"description": "w3access client",
"homepage": "https://web3.storage",
"name": "@storacha/access",
"version": "0.0.0",
"description": "access client",
"homepage": "https://storacha.network",
"repository": {
"type": "git",
"url": "https://github.com/storacha/w3up.git",
"url": "https://github.com/storacha/upload-service.git",
"directory": "packages/access-client"
},
"author": "Hugo Dias <hugomrdias@gmail.com> (hugodias.me)",
Expand Down Expand Up @@ -108,8 +108,8 @@
"@ucanto/principal": "^9.0.1",
"@ucanto/transport": "^9.1.1",
"@ucanto/validator": "^9.0.2",
"@web3-storage/capabilities": "workspace:^",
"@web3-storage/did-mailto": "workspace:^",
"@storacha/capabilities": "workspace:^",
"@storacha/did-mailto": "workspace:^",
"bigint-mod-arith": "^3.1.2",
"conf": "11.0.2",
"multiformats": "^12.1.2",
Expand All @@ -126,7 +126,7 @@
"@types/varint": "^6.0.1",
"@types/ws": "^8.5.4",
"@ucanto/server": "^10.0.0",
"@web3-storage/eslint-config-w3up": "workspace:^",
"@storacha/eslint-config": "workspace:^",
"assert": "^2.0.0",
"mocha": "^10.2.0",
"playwright-test": "^12.3.4",
Expand All @@ -136,7 +136,7 @@
},
"eslintConfig": {
"extends": [
"@web3-storage/eslint-config-w3up"
"@storacha/eslint-config"
],
"parserOptions": {
"project": "./tsconfig.json"
Expand All @@ -158,7 +158,7 @@
"ignores": [
"@types/*",
"assert",
"@web3-storage/eslint-config-w3up"
"@storacha/eslint-config"
]
}
}
22 changes: 11 additions & 11 deletions packages/access-client/readme.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
<h1 align="center">⁂<br/>web3.storage</h1>
<p align="center">The access client for <a href="https://web3.storage">https://web3.storage</a></p>
<h1 align="center">⁂<br/>storacha.network</h1>
<p align="center">The access client for <a href="https://storacha.network">https://storacha.network</a></p>

## About

The `@web3-storage/access` package provides an API for creating and managing "agents," which are software entities that control private signing keys and can invoke capabilities on behalf of a user (or another agent).
The `@storacha/access` package provides an API for creating and managing "agents," which are software entities that control private signing keys and can invoke capabilities on behalf of a user (or another agent).

Agents are used to invoke capabilities provided by the w3up service layer, using the [ucanto](https://github.com/storacha/ucanto) RPC framework. Agents are created locally on an end-user's device, and users are encouraged to create new agents for each device (or browser) that they want to use, rather than sharing agent keys between devices.

An Agent can create "spaces," which are namespaces for content stored on the w3up platform. Each space has its own keypair, the public half of which is used to form a `did:key:` URI that uniquely identifies the space. The space's private key is used to delegate capabilities to a primary agent, which then issues ucanto requests related to the space.

Although agents (and spaces) are created locally by generating keypairs, the w3up services will only act upon spaces that have been registered with the w3up access service. By default, a newly-created agent will be configured to use the production access service for remote operations, including registration.

Please note that the `@web3-storage/access` package is a fairly "low level" component of the w3up JavaScript stack, and most users will be better served by [`@web3-storage/w3up-client`](https://github.com/storacha/w3up-client), which combines this package with a client for the upload and storage service and presents a simpler API.
Please note that the `@storacha/access` package is a fairly "low level" component of the w3up JavaScript stack, and most users will be better served by [`@storacha/client`](https://github.com/storacha/upload-service/tree/main/packages/w3up-client), which combines this package with a client for the upload and storage service and presents a simpler API.

## Install

Install the package:

```bash
npm install @web3-storage/access
npm install @storacha/access
```

## Usage
Expand All @@ -34,8 +34,8 @@ If you're running in a web browser, use [`StoreIndexedDB`](https://web3-storage.
Agents in a browser use RSA keys, which can be generated using the async `generate` function from `@ucanto/principal/rsa`.

```js
import { Agent } from '@web3-storage/access/agent'
import { StoreIndexedDB } from '@web3-storage/access/stores/store-indexeddb'
import { Agent } from '@storacha/access/agent'
import { StoreIndexedDB } from '@storacha/access/stores/store-indexeddb'
import { generate } from '@ucanto/principal/rsa'

async function createAgent() {
Expand Down Expand Up @@ -63,8 +63,8 @@ On node.js, use [`StoreConf`](https://web3-storage.github.io/w3up/classes/_web3_
Agents on node should use Ed25519 keys:

```js
import { Agent } from '@web3-storage/access/agent'
import { StoreConf } from '@web3-storage/access/stores/store-conf'
import { Agent } from '@storacha/access/agent'
import { StoreConf } from '@storacha/access/stores/store-conf'
import { generate } from '@ucanto/principal/ed25519'

async function createAgent() {
Expand Down Expand Up @@ -164,9 +164,9 @@ The [`importSpaceFromDelegation` method](https://web3-storage.github.io/w3up/cla

## Contributing

Feel free to join in. All welcome. Please [open an issue](https://github.com/storacha/w3up/issues)!
Feel free to join in. All welcome. Please [open an issue](https://github.com/storacha/upload-service/issues)!

## License

Dual-licensed under [MIT + Apache 2.0](https://github.com/storacha/w3up/blob/main/license.md)
Dual-licensed under [MIT + Apache 2.0](https://github.com/storacha/upload-service/blob/main/license.md)

2 changes: 1 addition & 1 deletion packages/access-client/src/access.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import * as Access from '@web3-storage/capabilities/access'
import * as Access from '@storacha/capabilities/access'
import * as API from './types.js'
import { Failure, fail, DID } from '@ucanto/core'
import { Agent, importAuthorization } from './agent.js'
Expand Down
2 changes: 1 addition & 1 deletion packages/access-client/src/agent-data.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Signer as EdSigner } from '@ucanto/principal/ed25519'
import { importDAG } from '@ucanto/core/delegation'
import * as Ucanto from '@ucanto/interface'
import { CID } from 'multiformats'
import { UCAN } from '@web3-storage/capabilities'
import { UCAN } from '@storacha/capabilities'
import { isExpired } from './delegations.js'
import { uint8ArrayToArrayBuffer } from './utils/buffers.js'

Expand Down
Loading

0 comments on commit 0f797ed

Please sign in to comment.