Renaming for consistency for other projects.

metaplex-foundation · Feb 2, 2024 · 4ab1292 · 4ab1292
1 parent 1ca9ba9
commit 4ab1292
Show file tree

Hide file tree

Showing 28 changed files with 20 additions and 19 deletions.
diff --git a/.github/.env b/.github/.env
@@ -1,6 +1,6 @@
 CARGO_TERM_COLOR=always
 NODE_VERSION=16.x
-PROGRAMS=["mpl-inscription"]
+PROGRAMS=["inscription"]
 RUST_VERSION=1.70.0
 SOLANA_VERSION=1.16.18
 COMMIT_USER_NAME=github-actions

diff --git a/.github/file-filters.yml b/.github/file-filters.yml
@@ -13,7 +13,7 @@ program_common: &program_common
 
 mpl_inscription: &mpl_inscription
   - *program_common
-  - "programs/mpl-inscription/**"
+  - "programs/inscription/**"
 
 programs: &programs
   - *mpl_inscription

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,6 +1,6 @@
 {
-    "rust-analyzer.linkedProjects": [
-        "./clients/rust/Cargo.toml",
-        "./programs/mpl-inscription/Cargo.toml",
-    ]
-}
+  "rust-analyzer.linkedProjects": [
+    "./clients/rust/Cargo.toml",
+    "./programs/inscription/Cargo.toml"
+  ]
+}
diff --git a/README.md b/README.md
@@ -3,12 +3,13 @@
 Inscribing is the practice of treating the Solana blockchain as a form of data storage, much like Arweave or IPFS. While other data storage providers provide their own immutability and data integrity guarantees, there is demand for data directly on the native chain of the underlying NFT. Features such as dynamic metadata and images, on-chain attribute orders, and trait locked smart contracts all become possible with inscribed metadata.
 
 Metaplex inscriptions have two operating modes:
-* Metadata inscribing
-* Direct data storage
+
+- Metadata inscribing
+- Direct data storage
 
 In both modes binary data of any format can be directly written to the chain through the Metaplex Inscription program. In addition, the Metaplex SDKs provide direct support for inscribing schemas commonly used for NFTs (i.e. JSON and Image formats).
 
-The Metadata inscribing method creates a PDA attached to a mint account, the same way Metadata is attached to a token mint. The JSON and image data of the NFT can then be written directly to the chain in the PDA. This method provides a backup of the NFT data in the event that current data storage providers should ever go down and means the asset is “fully on Solana.” 
+The Metadata inscribing method creates a PDA attached to a mint account, the same way Metadata is attached to a token mint. The JSON and image data of the NFT can then be written directly to the chain in the PDA. This method provides a backup of the NFT data in the event that current data storage providers should ever go down and means the asset is “fully on Solana.”
 
 Mint inscriptions also include a ranking, which offers a FCFS rarity claim when inscribing an NFT. Using a sharded counter to prevent resource contention, the Mint inscriptions are globally ranked based on their minting order.
 The direct data storage can be used as a direct alternative to providers like Arweave and IPFS, rather than as a backup. JSON and Image data can be written directly to the chain. One small caveat of this method is that a gateway is required to enable maximum ecosystem support, much like ar.io, arweave.net, gateway.ipfs.io, etc.
@@ -19,7 +20,7 @@ The Metaplex Inscription program is queued up for a full audit to prevent any se
 
 This project contains the following programs:
 
-- [Mpl Inscription](./programs/mpl-inscription/README.md) `1NSCRfGeyo7wPUazGbaPBUsTM49e1k2aXewHGARfzSo`
+- [Mpl Inscription](./programs/inscription/README.md) `1NSCRfGeyo7wPUazGbaPBUsTM49e1k2aXewHGARfzSo`
 
 You will need a Rust version compatible with BPF to compile the program, currently we recommend using Rust 1.68.0.
 

diff --git a/configs/kinobi.cjs b/configs/kinobi.cjs
@@ -6,7 +6,7 @@ const clientDir = path.join(__dirname, "..", "clients");
 const idlDir = path.join(__dirname, "..", "idls");
 
 // Instanciate Kinobi.
-const kinobi = k.createFromIdls([path.join(idlDir, "mpl_inscription.json")]);
+const kinobi = k.createFromIdls([path.join(idlDir, "mpl_inscription_program.json")]);
 
 // Update programs.
 kinobi.update(

diff --git a/configs/shank.cjs b/configs/shank.cjs
@@ -7,9 +7,9 @@ const programDir = path.join(__dirname, "..", "programs");
 
 generateIdl({
   generator: "shank",
-  programName: "mpl_inscription",
+  programName: "mpl_inscription_program",
   programId: "1NSCRfGeyo7wPUazGbaPBUsTM49e1k2aXewHGARfzSo",
   idlDir,
   binaryInstallDir,
-  programDir: path.join(programDir, "mpl-inscription"),
+  programDir: path.join(programDir, "inscription"),
 });
diff --git a/idls/mpl_inscription.json → idls/mpl_inscription_program.json b/idls/mpl_inscription.json → idls/mpl_inscription_program.json
@@ -1,6 +1,6 @@
 {
   "version": "0.1.0",
-  "name": "mpl_inscription",
+  "name": "mpl_inscription_program",
   "instructions": [
     {
       "name": "Initialize",

diff --git a/programs/mpl-inscription/Cargo.lock → programs/inscription/Cargo.lock b/programs/mpl-inscription/Cargo.lock → programs/inscription/Cargo.lock
diff --git a/programs/mpl-inscription/Cargo.toml → programs/inscription/Cargo.toml b/programs/mpl-inscription/Cargo.toml → programs/inscription/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "mpl-inscription"
+name = "mpl-inscription-program"
 version = "0.1.0"
 edition = "2021"
 readme = "./README.md"
@@ -17,6 +17,6 @@ num-traits = "^0.2"
 solana-program = "~1.16"
 thiserror = "^1.0"
 mpl-utils = "0.3.1"
-serde_json = { version = "1.0.108", features = ["std"]}
+serde_json = { version = "1.0.108", features = ["std"] }
 mpl-token-metadata = "3.2.3"
-spl-token = { version = "4.0.0", features = ["no-entrypoint"] }
+spl-token = { version = "4.0.0", features = ["no-entrypoint"] }
diff --git a/programs/mpl-inscription/README.md → programs/inscription/README.md b/programs/mpl-inscription/README.md → programs/inscription/README.md
diff --git a/programs/mpl-inscription/rustfmt.toml → programs/inscription/rustfmt.toml b/programs/mpl-inscription/rustfmt.toml → programs/inscription/rustfmt.toml
diff --git a/programs/mpl-inscription/src/entrypoint.rs → programs/inscription/src/entrypoint.rs b/programs/mpl-inscription/src/entrypoint.rs → programs/inscription/src/entrypoint.rs
diff --git a/programs/mpl-inscription/src/error.rs → programs/inscription/src/error.rs b/programs/mpl-inscription/src/error.rs → programs/inscription/src/error.rs
diff --git a/...ms/mpl-inscription/src/instruction/mod.rs → programs/inscription/src/instruction/mod.rs b/...ms/mpl-inscription/src/instruction/mod.rs → programs/inscription/src/instruction/mod.rs
diff --git a/programs/mpl-inscription/src/lib.rs → programs/inscription/src/lib.rs b/programs/mpl-inscription/src/lib.rs → programs/inscription/src/lib.rs
diff --git a/...nscription/src/processor/add_authority.rs → ...nscription/src/processor/add_authority.rs b/...nscription/src/processor/add_authority.rs → ...nscription/src/processor/add_authority.rs
diff --git a/...mpl-inscription/src/processor/allocate.rs → ...ams/inscription/src/processor/allocate.rs b/...mpl-inscription/src/processor/allocate.rs → ...ams/inscription/src/processor/allocate.rs
diff --git a/...l-inscription/src/processor/clear_data.rs → ...s/inscription/src/processor/clear_data.rs b/...l-inscription/src/processor/clear_data.rs → ...s/inscription/src/processor/clear_data.rs
diff --git a/...ms/mpl-inscription/src/processor/close.rs → programs/inscription/src/processor/close.rs b/...ms/mpl-inscription/src/processor/close.rs → programs/inscription/src/processor/close.rs
diff --git a/...inscription/src/processor/create_shard.rs → ...inscription/src/processor/create_shard.rs b/...inscription/src/processor/create_shard.rs → ...inscription/src/processor/create_shard.rs
diff --git a/...l-inscription/src/processor/initialize.rs → ...s/inscription/src/processor/initialize.rs b/...l-inscription/src/processor/initialize.rs → ...s/inscription/src/processor/initialize.rs
diff --git a/...ssor/initialize_associated_inscription.rs → ...ssor/initialize_associated_inscription.rs b/...ssor/initialize_associated_inscription.rs → ...ssor/initialize_associated_inscription.rs
diff --git a/...ion/src/processor/initialize_from_mint.rs → ...ion/src/processor/initialize_from_mint.rs b/...ion/src/processor/initialize_from_mint.rs → ...ion/src/processor/initialize_from_mint.rs
diff --git a/...rams/mpl-inscription/src/processor/mod.rs → programs/inscription/src/processor/mod.rs b/...rams/mpl-inscription/src/processor/mod.rs → programs/inscription/src/processor/mod.rs
diff --git a/...ription/src/processor/remove_authority.rs → ...ription/src/processor/remove_authority.rs b/...ription/src/processor/remove_authority.rs → ...ription/src/processor/remove_authority.rs
diff --git a/...mpl-inscription/src/processor/set_mint.rs → ...ams/inscription/src/processor/set_mint.rs b/...mpl-inscription/src/processor/set_mint.rs → ...ams/inscription/src/processor/set_mint.rs
diff --git a/...l-inscription/src/processor/write_data.rs → ...s/inscription/src/processor/write_data.rs b/...l-inscription/src/processor/write_data.rs → ...s/inscription/src/processor/write_data.rs
diff --git a/programs/mpl-inscription/src/state.rs → programs/inscription/src/state.rs b/programs/mpl-inscription/src/state.rs → programs/inscription/src/state.rs