Merge pull request #265 from metaplex-foundation/doc/renaming

MTG-628 renaming

doc/batch_mint.md

@@ -0,0 +1,5 @@
+# Batch mint
+
+## 0.1
+
+![sequence diagram](./img/create_batch_mint-0.1.svg)

doc/puml/metagrid-sequence_diagram.puml

@@ -1,5 +1,5 @@
 @startuml
-title Metagrid 0.1 - Merkel tree rollup
+title Aura 0.1 - Merkel tree batch mint
 scale 1.5
 ' ##################
 ' ### components ###
@@ -26,15 +26,15 @@ participant "DAS Node\nOperator" as DASNode #yellow
 
 Staker -> StakingContract : Make a stake
 note right
- Rollup operation requires a stake in MPLX
+ Batch mint operation requires a stake in MPLX
 end note
 
 
 TreeCreator -> SplAccountCompression : Prepare uninitialized tree\n(spl::prepare_tree)
 Bubblegum -> Solana : Create_account\n(spl_acount_compression)
 
 TreeCreator -> TreeCreator : Generate tree\n(Rolled Mint Instruction)
-TreeCreator -> Arweave : Upload rollup tree in form of JSON
+TreeCreator -> Arweave : Upload batch minted tree in form of JSON
 
 loop
  TreeCreator -> Bubblegum: append_canopy_nodes
@@ -49,7 +49,7 @@ Bubblegum -> StakingContract : Check stake
 Bubblegum -> SplAccountCompression : init_merkle_tree_with_root
 Bubblegum -> RewardPool : Adding fee to the reward pool
 
-Bubblegum -> DASNode : Event create_rollup_tree
+Bubblegum -> DASNode : Event create_batch_mint_tree
 DASNode -> Arweave : Raw JSON request
 
 note over Bubblegum

doc/puml/staking-reward.puml

@@ -9,8 +9,8 @@ actor "Staker" as Staker
 control "MPLX staking\ncontract" as StakingContract
 control "MPLX reward\ncontract" as RewardContract
 database "Reward\npool" as RewardPool
-database "Rollup\nfees" as RollupFees
-control "Rollup fees\ncontract" as RollupFeesContract
+database "Batch mint\nfees" as BatchMintFees
+control "Batch mint fees\ncontract" as BatchMintFeesContract
 control "Bubblegum\ncontract" as Bubblegum
 actor "NFT tree creator" as TreeCreator
 actor "Metaplex DAO" as Metaplex
@@ -29,10 +29,10 @@ note right
  Reward share multiplier depends on the stake period: 5 days - 1X, 3 months - 2X, 6 months - 4X, 1 year - 6X
 end note
 
-== Reward fund from Rollups ==
+== Reward fund from batch mints ==
 
 TreeCreator -> Bubblegum : Create tree,\npay fee in SOL
-Bubblegum -> RollupFees : Collect fees from Rollups
+Bubblegum -> BatchMintFees : Collect fees from batch mints
 
 == Reward fund from Metaplex foundation ==
 
@@ -44,16 +44,16 @@ end note
 
 == Forming rewarding ==
 
-Metaplex -> RollupFeesContract : initiate rewards funding from rollup fees
+Metaplex -> BatchMintFeesContract : initiate rewards funding from batch mint fees
 note left
- Fill up the rewards pool funded from the collected rollup fees.
+ Fill up the rewards pool funded from the collected batch mint fees.
  The pool will be filled up for some time, ie for a month.
  And it will be refilled periodically (e.g. monthly)
 end note
-activate RollupFeesContract
- RollupFeesContract <-> RollupFees : Conver SOL into MPLX
- RollupFeesContract -> RewardPool : Fund rewards with MPLX
-deactivate RollupFeesContract
+activate BatchMintFeesContract
+ BatchMintFeesContract <-> BatchMintFees : Conver SOL into MPLX
+ BatchMintFeesContract -> RewardPool : Fund rewards with MPLX
+deactivate BatchMintFeesContract
 
 == Perfrom rewarding ==
 

scripts/run-ingest-persisted.sh

@@ -5,7 +5,7 @@ cargo b --release --package nft_ingester --bin raw_backfiller
 # This group of parameters has to be changed depending on the server where we are running it
 # or range of slots we are going to persist.
 export INGESTER_ROCKS_DB_PATH_CONTAINER="/rocksdb-data"
-export INGESTER_BIG_TABLE_CONFIG='{creds="/utility-chain/creds.json", timeout=1000}'
+export INGESTER_BIG_TABLE_CONFIG='{creds="/aura/creds.json", timeout=1000}'
 export INGESTER_MIGRATION_STORAGE_PATH="/migration_storage"
 export INGESTER_METRICS_PORT=9091
 

scripts/run-slots-persisting.sh

@@ -5,7 +5,7 @@ cargo b --release --package nft_ingester --bin raw_backfiller
 # This group of parameters has to be changed depending on the server where we are running it
 # or range of slots we are going to persist.
 export INGESTER_ROCKS_DB_PATH_CONTAINER="/rocksdb-data"
-export INGESTER_BIG_TABLE_CONFIG='{creds="/utility-chain/creds.json", timeout=1000}'
+export INGESTER_BIG_TABLE_CONFIG='{creds="/aura/creds.json", timeout=1000}'
 export INGESTER_SLOT_UNTIL=275642000
 export INGESTER_SLOT_START_FROM=276960411
 export INGESTER_MIGRATION_STORAGE_PATH="/migration_storage"