Skip to content

Commit

Permalink
Merge pull request #175 from ardriveapp/PE-740_add_manifest_field
Browse files Browse the repository at this point in the history
docs(create-manifest): Add example for manifest json output PE-740
  • Loading branch information
fedellen authored Dec 9, 2021
2 parents 2a2e21a + e626b7f commit 373b7db
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 11 deletions.
10 changes: 5 additions & 5 deletions .pnp.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,30 @@ Creating a `.json` file of your manifest links output can be accomplished here w
ardrive create-manifest -w /path/to/wallet -f "6c312b3e-4778-4a18-8243-f2b346f5e7cb" | jq '{links}' > links.json
```

If you'd like to preview the contents of your manifest before uploading, you can perform a dry run and do some lightweight post processing to isolate the data:

```shell
ardrive create-manifest -w /path/to/wallet -f "6c312b3e-4778-4a18-8243-f2b346f5e7cb" --dry-run | jq '{manifest}.manifest'
```

```json
{
"manifest": "arweave/paths",
"version": "0.1.0",
"index": {
"path": "index.html"
},
"paths": {
"hello_world.txt": {
"id": "Y7GFF8r9y0MEU_oi1aZeD87vrmai97JdRQ2L0cbGJ68"
},
"index.html": {
"id": "pELonjVebHyBsdxVymvxbGTmHD96v9PuuUXj8GUHGoY"
}
}
}
```

The manifest data transaction is tagged with a unique content-type, `application/x.arweave-manifest+json`, which tells the gateway to treat this file as a manifest. The manifest file itself is a `.json` file that holds the paths (the data transaction ids) to each file within the specified folder.

When your folder is later changed by adding files or updating them with new revisions, the original manifest will NOT be updated on its own. A manifest is a permanent record of your files in their current state.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
},
"types": "./lib/index.d.ts",
"dependencies": {
"ardrive-core-js": "1.0.5",
"ardrive-core-js": "1.1.0",
"arweave": "^1.10.16",
"axios": "^0.21.1",
"commander": "^8.2.0",
Expand Down
10 changes: 5 additions & 5 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -998,7 +998,7 @@ __metadata:
"@types/source-map-support": ^0
"@typescript-eslint/eslint-plugin": ^4.18.0
"@typescript-eslint/parser": ^4.18.0
ardrive-core-js: 1.0.5
ardrive-core-js: 1.1.0
arweave: ^1.10.16
axios: ^0.21.1
chai: ^4.3.4
Expand All @@ -1024,9 +1024,9 @@ __metadata:
languageName: unknown
linkType: soft

"ardrive-core-js@npm:1.0.5":
version: 1.0.5
resolution: "ardrive-core-js@npm:1.0.5"
"ardrive-core-js@npm:1.1.0":
version: 1.1.0
resolution: "ardrive-core-js@npm:1.1.0"
dependencies:
arweave: ^1.10.16
arweave-bundles: ^1.0.3
Expand All @@ -1042,7 +1042,7 @@ __metadata:
smartweave: ^0.4.45
utf8: ^3.0.0
uuid: ^8.3.2
checksum: 02490de5ea3e806f1a793389b3dbf8dc89b6caa116870b0d32b8a0591eb3cd7c02dc16ff6c4c15c418b2d7734fcdd2379f20a640ac30292d4f6db629370b3941
checksum: 8f15a57d20ba84a9801008453e27eeb2569909d0841c7bf5ffea7da1fd23af80414a12d4cc13976a2916c4d01e6c02a9ac0a0d1d5037fe2cc6703ca77ec8d85a
languageName: node
linkType: hard

Expand Down

0 comments on commit 373b7db

Please sign in to comment.