From 574f15e060086ed2d5bf5f7ebabb7459dbba00d9 Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Mon, 23 Jun 2025 15:18:51 +0100 Subject: [PATCH 1/8] improve base readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2e74716..852ae20 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,11 @@ This repository holds shell scripts that Intersect uses to engage in Cardano on- ## Navigation +### 2025 Budget Scripts + +- [check-budget-metadata.sh](./scripts/check-budget-metadata.sh) + - Runs correctness and validity checks for budget treasury withdrawal CIP108 metadata. + ### Scripts - [create-author-witness.sh](./scripts/create-author-witness.sh) @@ -11,17 +16,15 @@ This repository holds shell scripts that Intersect uses to engage in Cardano on- - [create-human-readable-from-json.sh](./scripts/create-human-readable-from-json.sh) - Creates a markdown file from CIP108 metadata - [hash.sh](./scripts/hash.sh) - - Performs a blake2b-256 hash + - Performs a blake2b-256 hash on provided file - [ipfs.sh](./scripts/ipfs.sh) - Checks if a file is accessible via IPFS - Allows user to pin a file on a number of pinning services -- [validate-cip-108.sh](./scripts/ipfs.sh) +- [validate-cip-108.sh](./scripts/validate-cip-108.sh) - Compares CIP108 metadata against the established schema - Applies a spell check to CIP108 metadata - [verify-author-witness.sh](./scripts/verify-author-witness.sh) - Checks the correctness of CIP108 metadata with a author(s) witness(es) -- [check-budget-metadata.sh](./scripts/check-budget-metadata.sh) - - Runs correctness and validity checks for budget treasury withdrawal CIP108 metadata. ### Documentation From 5324d5f9c948638c8c1f0b89af0e35a3a26e5bf6 Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Mon, 23 Jun 2025 16:43:19 +0100 Subject: [PATCH 2/8] rename ipfs scripts --- README.md | 16 +++++++++++----- scripts/{check-ipfs.sh => ipfs-check.sh} | 0 scripts/{pin-to-ipfs.sh => ipfs-pin.sh} | 4 ++-- 3 files changed, 13 insertions(+), 7 deletions(-) rename scripts/{check-ipfs.sh => ipfs-check.sh} (100%) rename scripts/{pin-to-ipfs.sh => ipfs-pin.sh} (98%) diff --git a/README.md b/README.md index 852ae20..901c65b 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,21 @@ This repository holds shell scripts that Intersect uses to engage in Cardano on- ## Navigation -### 2025 Budget Scripts +### Scripts + + +#### 2025 Budget Scripts - [check-budget-metadata.sh](./scripts/check-budget-metadata.sh) - Runs correctness and validity checks for budget treasury withdrawal CIP108 metadata. -### Scripts +#### IPFS Scripts + +- [ipfs.sh](./scripts/ipfs.sh) + - Checks if a file is accessible via IPFS + - Allows user to pin a file on a number of pinning services + +#### Other Scripts - [create-author-witness.sh](./scripts/create-author-witness.sh) - Adds an author witness to CIP100/CIP108 metadata @@ -17,9 +26,6 @@ This repository holds shell scripts that Intersect uses to engage in Cardano on- - Creates a markdown file from CIP108 metadata - [hash.sh](./scripts/hash.sh) - Performs a blake2b-256 hash on provided file -- [ipfs.sh](./scripts/ipfs.sh) - - Checks if a file is accessible via IPFS - - Allows user to pin a file on a number of pinning services - [validate-cip-108.sh](./scripts/validate-cip-108.sh) - Compares CIP108 metadata against the established schema - Applies a spell check to CIP108 metadata diff --git a/scripts/check-ipfs.sh b/scripts/ipfs-check.sh similarity index 100% rename from scripts/check-ipfs.sh rename to scripts/ipfs-check.sh diff --git a/scripts/pin-to-ipfs.sh b/scripts/ipfs-pin.sh similarity index 98% rename from scripts/pin-to-ipfs.sh rename to scripts/ipfs-pin.sh index 3182aad..d9d63d8 100755 --- a/scripts/pin-to-ipfs.sh +++ b/scripts/ipfs-pin.sh @@ -92,9 +92,9 @@ echo "CID: $ipfs_cid" # If user wants to check if file is discoverable on IPFS if [ "$check_discoverable" = "true" ]; then - echo "Using ./scripts/check-ipfs.sh script to check if file is discoverable on IPFS..." + echo "Using ./scripts/ipfs-check.sh script to check if file is discoverable on IPFS..." # check if file is discoverable on IPFS - if ! ./scripts/check-ipfs.sh "$input_path"; then + if ! ./scripts/ipfs-check.sh "$input_path"; then echo "File is not discoverable on IPFS. Proceeding to pin it." else echo "File is already discoverable on IPFS. No need to pin it." From edfe63f4fa3690a2a3d1f9d795a793025a60c95e Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Mon, 23 Jun 2025 16:50:16 +0100 Subject: [PATCH 3/8] regorangise base readme, rename budget script --- README.md | 27 +++++++++++-------- ...t-metadata.sh => budget-check-metadata.sh} | 0 2 files changed, 16 insertions(+), 11 deletions(-) rename scripts/{verify-budget-metadata.sh => budget-check-metadata.sh} (100%) diff --git a/README.md b/README.md index 901c65b..ebe2042 100644 --- a/README.md +++ b/README.md @@ -6,31 +6,36 @@ This repository holds shell scripts that Intersect uses to engage in Cardano on- ### Scripts - #### 2025 Budget Scripts -- [check-budget-metadata.sh](./scripts/check-budget-metadata.sh) +- [budget-check-metadata.sh](./scripts/budget-check-metadata.sh) - Runs correctness and validity checks for budget treasury withdrawal CIP108 metadata. + - Uses a combination of the other scripts #### IPFS Scripts -- [ipfs.sh](./scripts/ipfs.sh) - - Checks if a file is accessible via IPFS - - Allows user to pin a file on a number of pinning services +- [ipfs-check.sh](./scripts/ipfs-check.sh) + - Checks if a file is accessible via free IPFS gateways +- [ipfs-pin.sh](./scripts/ipfs-check.sh) + - Allows user to pin a file on a number of pinning services + - Optionally allows the user to check file's discoverability first -#### Other Scripts +#### CIP-108 Scripts -- [create-author-witness.sh](./scripts/create-author-witness.sh) - - Adds an author witness to CIP100/CIP108 metadata - [create-human-readable-from-json.sh](./scripts/create-human-readable-from-json.sh) - Creates a markdown file from CIP108 metadata -- [hash.sh](./scripts/hash.sh) - - Performs a blake2b-256 hash on provided file - [validate-cip-108.sh](./scripts/validate-cip-108.sh) - Compares CIP108 metadata against the established schema - Applies a spell check to CIP108 metadata + +#### Other Scripts + +- [create-author-witness.sh](./scripts/create-author-witness.sh) + - Adds an author witness to CIP100/CIP108 metadata - [verify-author-witness.sh](./scripts/verify-author-witness.sh) - - Checks the correctness of CIP108 metadata with a author(s) witness(es) + - Checks the correctness of CIP100/CIP108 metadata with a author(s) witness(es) +- [hash.sh](./scripts/hash.sh) + - Performs a blake2b-256 hash on provided file ### Documentation diff --git a/scripts/verify-budget-metadata.sh b/scripts/budget-check-metadata.sh similarity index 100% rename from scripts/verify-budget-metadata.sh rename to scripts/budget-check-metadata.sh From 4305eea8983ec58d845fd6ed1b3b8d6b594ca4fe Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Mon, 23 Jun 2025 16:51:51 +0100 Subject: [PATCH 4/8] rename cip-108 related scripts --- README.md | 6 +++--- ...adable-from-json.sh => cip-108-create-human-readable.sh} | 0 scripts/{validate-cip-108.sh => cip-108-validate.sh} | 0 3 files changed, 3 insertions(+), 3 deletions(-) rename scripts/{create-human-readable-from-json.sh => cip-108-create-human-readable.sh} (100%) rename scripts/{validate-cip-108.sh => cip-108-validate.sh} (100%) diff --git a/README.md b/README.md index ebe2042..61941ba 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ This repository holds shell scripts that Intersect uses to engage in Cardano on- #### CIP-108 Scripts -- [create-human-readable-from-json.sh](./scripts/create-human-readable-from-json.sh) +- [cip-108-create-human-readable.sh](./scripts/cip-108-create-human-readable.sh) - Creates a markdown file from CIP108 metadata -- [validate-cip-108.sh](./scripts/validate-cip-108.sh) - - Compares CIP108 metadata against the established schema +- [cip-108-validate.sh](./scripts/cip-108-validate.sh) + - Compares CIP-108 metadata against the established schema - Applies a spell check to CIP108 metadata #### Other Scripts diff --git a/scripts/create-human-readable-from-json.sh b/scripts/cip-108-create-human-readable.sh similarity index 100% rename from scripts/create-human-readable-from-json.sh rename to scripts/cip-108-create-human-readable.sh diff --git a/scripts/validate-cip-108.sh b/scripts/cip-108-validate.sh similarity index 100% rename from scripts/validate-cip-108.sh rename to scripts/cip-108-validate.sh From 9f188bfc50cfcff3c2a4b25ee736fd99967b2341 Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Mon, 23 Jun 2025 16:54:02 +0100 Subject: [PATCH 5/8] rename author scripts --- README.md | 9 ++++++--- ...create-author-witness.sh => author-create-witness.sh} | 0 ...verify-author-witness.sh => author-verify-witness.sh} | 0 3 files changed, 6 insertions(+), 3 deletions(-) rename scripts/{create-author-witness.sh => author-create-witness.sh} (100%) rename scripts/{verify-author-witness.sh => author-verify-witness.sh} (100%) diff --git a/README.md b/README.md index 61941ba..b484c9a 100644 --- a/README.md +++ b/README.md @@ -28,12 +28,15 @@ This repository holds shell scripts that Intersect uses to engage in Cardano on- - Compares CIP-108 metadata against the established schema - Applies a spell check to CIP108 metadata -#### Other Scripts +#### CIP-100 Author Scripts -- [create-author-witness.sh](./scripts/create-author-witness.sh) +- [author-create-witness.sh](./scripts/author-create-witness.sh) - Adds an author witness to CIP100/CIP108 metadata -- [verify-author-witness.sh](./scripts/verify-author-witness.sh) +- [author-verify-witness.sh](./scripts/author-verify-witness.sh) - Checks the correctness of CIP100/CIP108 metadata with a author(s) witness(es) + +#### Other Scripts + - [hash.sh](./scripts/hash.sh) - Performs a blake2b-256 hash on provided file diff --git a/scripts/create-author-witness.sh b/scripts/author-create-witness.sh similarity index 100% rename from scripts/create-author-witness.sh rename to scripts/author-create-witness.sh diff --git a/scripts/verify-author-witness.sh b/scripts/author-verify-witness.sh similarity index 100% rename from scripts/verify-author-witness.sh rename to scripts/author-verify-witness.sh From 44ad4449d19a84b4cb2383ac155b07e0c42b3a34 Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Mon, 23 Jun 2025 16:55:13 +0100 Subject: [PATCH 6/8] update budget script --- scripts/budget-check-metadata.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/budget-check-metadata.sh b/scripts/budget-check-metadata.sh index 413338d..902d8a1 100755 --- a/scripts/budget-check-metadata.sh +++ b/scripts/budget-check-metadata.sh @@ -62,10 +62,10 @@ if [ -d "$input_path" ]; then echo "Author witnesses will be checked..." echo " " echo "Running validation $file" - ./scripts/validate-cip-108.sh "$file" + ./scripts/cip-108-validate.sh "$file" echo " " echo "Checking author for $file" - ./scripts/verify-author-witness.sh "$file" + ./scripts/author-verify-witness.sh "$file" echo " " # todo add more checks here From 2809dfa18e0b0c2fba3d2b6b57841e1d16c4dd1a Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Mon, 23 Jun 2025 16:57:39 +0100 Subject: [PATCH 7/8] add note on secrets --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b484c9a..4a0f12e 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,12 @@ In order to run all of these scripts you will need - [ipfs](https://docs.ipfs.eth.link/install/command-line/) - jq +## Secrets + +Secrets can be stored via `./scripts/.env` and based on `./scripts/.env.example`. + +The only script that uses secrets is `ipfs-pin.sh`. + ## License See [License](./LICENSE). From 5a8c35f98352996dff07c9bb9635cccc9b33ea2c Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Mon, 23 Jun 2025 16:59:39 +0100 Subject: [PATCH 8/8] fix weird whitespace that was breaking markdown rendering --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4a0f12e..04565f6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository holds shell scripts that Intersect uses to engage in Cardano on- ## Navigation -### Scripts +### Scripts #### 2025 Budget Scripts @@ -12,7 +12,7 @@ This repository holds shell scripts that Intersect uses to engage in Cardano on- - Runs correctness and validity checks for budget treasury withdrawal CIP108 metadata. - Uses a combination of the other scripts -#### IPFS Scripts +#### IPFS Scripts - [ipfs-check.sh](./scripts/ipfs-check.sh) - Checks if a file is accessible via free IPFS gateways