Skip to content

Commit

Permalink
Transition from @bundlr-network/client to @irys/sdk (#91)
Browse files Browse the repository at this point in the history
* refactor: 🚚 Rename umi-uploader-bundlr -> umi-uploader-irys

* feat: ✨ Transition umi-uploader-bundlr to umi-uploader-irys

* feat: 🚚 Restore umi-uploader-bundlr

* chore: 📝 Add changeset for umi-uploader-irys

* chore: 📝 Update PNPM lock, add Bundlr back to implementations list

* chore: 🔥 Remove umi-uploader-irys changelog

* chore: 🎨 Apply linting & formatting
  • Loading branch information
JesseTheRobot authored Nov 10, 2023
1 parent e84a4ed commit 44d33c5
Show file tree
Hide file tree
Showing 16 changed files with 1,097 additions and 40 deletions.
5 changes: 5 additions & 0 deletions .changeset/rich-camels-roll.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@metaplex-foundation/umi-uploader-irys': patch
---

Add new Irys uploader to replace the deprecated Bundlr uploader
3 changes: 2 additions & 1 deletion docs/implementations.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ The page aims to list all the available implementations of [the interfaces defin
| Description | Maintainer | Links |
| --- | --- | --- |
| Uses AWS | Metaplex | [GitHub](https://github.com/metaplex-foundation/umi/tree/main/packages/umi-uploader-aws) / [NPM](https://www.npmjs.com/package/@metaplex-foundation/umi-uploader-aws) |
| Uses Bundlr Network | Metaplex | [GitHub](https://github.com/metaplex-foundation/umi/tree/main/packages/umi-uploader-bundlr) / [NPM](https://www.npmjs.com/package/@metaplex-foundation/umi-uploader-bundlr) |
| Uses Irys.xyz | Metaplex | [GitHub](https://github.com/metaplex-foundation/umi/tree/main/packages/umi-uploader-irys) / [NPM](https://www.npmjs.com/package/@metaplex-foundation/umi-uploader-irys) |
| Uses NFT.Storage | Metaplex | [GitHub](https://github.com/metaplex-foundation/umi/tree/main/packages/umi-uploader-nft-storage) / [NPM](https://www.npmjs.com/package/@metaplex-foundation/umi-uploader-nft-storage) |
| Uses a local cache to mock uploads and downloads | Metaplex | [GitHub](https://github.com/metaplex-foundation/umi/tree/main/packages/umi-storage-mock) / [NPM](https://www.npmjs.com/package/@metaplex-foundation/umi-storage-mock) |
| Uses Bundlr.network (Deprecated - use `umi-uploader-irys`) | Metaplex | [GitHub](https://github.com/metaplex-foundation/umi/tree/main/packages/umi-uploader-bundlr) / [NPM](https://www.npmjs.com/package/@metaplex-foundation/umi-uploader-bundlr) |

## Downloader Interface

Expand Down
9 changes: 9 additions & 0 deletions packages/umi-uploader-irys/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# umi-uploader-irys

An uploader implementation relying on Irys.

## Installation

```sh
npm install @metaplex-foundation/umi-uploader-irys
```
3 changes: 3 additions & 0 deletions packages/umi-uploader-irys/babel.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "../../babel.config.json"
}
72 changes: 72 additions & 0 deletions packages/umi-uploader-irys/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
{
"name": "@metaplex-foundation/umi-uploader-irys",
"version": "0.8.9",
"description": "An uploader implementation relying on Irys",
"license": "MIT",
"sideEffects": false,
"module": "dist/esm/index.mjs",
"main": "dist/cjs/index.cjs",
"types": "dist/types/index.d.ts",
"exports": {
".": {
"types": "./dist/types/index.d.ts",
"import": "./dist/esm/index.mjs",
"require": "./dist/cjs/index.cjs"
}
},
"files": [
"/dist/cjs",
"/dist/esm",
"/dist/types",
"/src"
],
"scripts": {
"lint": "eslint --ext js,ts,tsx src",
"lint:fix": "eslint --fix --ext js,ts,tsx src",
"clean": "rimraf dist",
"build": "pnpm clean && tsc && tsc -p test/tsconfig.json && rollup -c",
"test": "ava"
},
"dependencies": {
"@irys/sdk": "^0.0.2",
"@metaplex-foundation/umi-web3js-adapters": "workspace:^",
"bignumber.js": "^9.0.2",
"buffer": "^6.0.3"
},
"peerDependencies": {
"@metaplex-foundation/umi": "workspace:^",
"@solana/web3.js": "^1.72.0"
},
"devDependencies": {
"@ava/typescript": "^3.0.1",
"@metaplex-foundation/umi": "workspace:^",
"@metaplex-foundation/umi-downloader-http": "workspace:^",
"@metaplex-foundation/umi-eddsa-web3js": "workspace:^",
"@metaplex-foundation/umi-http-fetch": "workspace:^",
"@metaplex-foundation/umi-rpc-web3js": "workspace:^",
"@solana/web3.js": "^1.72.0",
"ava": "^5.1.0"
},
"publishConfig": {
"access": "public"
},
"author": "Metaplex Maintainers <[email protected]>",
"homepage": "https://metaplex.com",
"repository": {
"url": "https://github.com/metaplex-foundation/umi.git"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"displayName": "umi-uploader-irys"
},
"ava": {
"typescript": {
"compile": false,
"rewritePaths": {
"src/": "dist/test/src/",
"test/": "dist/test/test/"
}
}
}
}
16 changes: 16 additions & 0 deletions packages/umi-uploader-irys/rollup.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { createConfigs } from '../../rollup.config';
import pkg from './package.json';

export default createConfigs({
pkg,
builds: [
{
dir: 'dist/esm',
format: 'es',
},
{
dir: 'dist/cjs',
format: 'cjs',
},
],
});
Loading

0 comments on commit 44d33c5

Please sign in to comment.