Merge pull request #15 from projectNEWM/v0.2.2

Candidate for v0.2.2

Author: AndrewWestberg

.env

@@ -0,0 +1,17 @@
+# network magic. either --testnet-magic # or --mainnet
+network="--mainnet"
+
+#path to cardano-cli
+cli="cardano-cli"
+
+#path to cardano-hw-cli
+hwcli="cardano-hw-cli"
+
+#path to a node socket
+socket="/home/westbam/haskell/local/db/socket"
+
+export CARDANO_NODE_SOCKET_PATH=$socket
+
+# get params
+mkdir -p tmp
+${cli} query protocol-parameters ${network} --out-file tmp/protocol.json

.env.mainnet

@@ -0,0 +1,17 @@
+# network magic. either --testnet-magic # or --mainnet
+network="--mainnet"
+
+#path to cardano-cli
+cli="cardano-cli"
+
+#path to cardano-hw-cli
+hwcli="cardano-hw-cli"
+
+#path to a node socket
+socket="/home/westbam/haskell/local/db/socket"
+
+export CARDANO_NODE_SOCKET_PATH=$socket
+
+# get params
+mkdir -p tmp
+${cli} query protocol-parameters ${network} --out-file tmp/protocol.json

.env.preprod

@@ -0,0 +1,17 @@
+# network magic. either --testnet-magic # or --mainnet
+network="--testnet-magic 1"
+
+#path to cardano-cli
+cli="cardano-cli"
+
+#path to cardano-hw-cli
+hwcli="cardano-hw-cli"
+
+#path to a node socket
+socket="/home/westbam/haskell/pprod/db/socket"
+
+export CARDANO_NODE_SOCKET_PATH=$socket
+
+# get params
+mkdir -p tmp
+${cli} query protocol-parameters ${network} --out-file tmp/protocol.json

.env.preview

@@ -0,0 +1,17 @@
+# network magic. either --testnet-magic # or --mainnet
+network="--testnet-magic 2"
+
+#path to cardano-cli
+cli="cardano-cli"
+
+#path to cardano-hw-cli
+hwcli="cardano-hw-cli"
+
+#path to a node socket
+socket="/home/westbam/haskell/prev/db/socket"
+
+export CARDANO_NODE_SOCKET_PATH=$socket
+
+# get params
+mkdir -p tmp
+${cli} query protocol-parameters ${network} --out-file tmp/protocol.json

.gitignore

@@ -25,4 +25,7 @@ result*
 .envrc
 .vim
 scripts/wallet
-status.json
+status.json
+__pycache__
+tmp
+*.metadata.json

README.md

@@ -1,64 +1,31 @@
-# Project Newm Contracts
+# Project NEWM
 
-A collection of contracts used my Project Newm.
+A collection of smart contracts for Project NEWM.
 
-# E2E Testing
+# v0.2.x
 
-The initial testing will assume Newm holds a special wallet that will regulate all token minting. In the future, this will be expanded into more decentralized solutions.
+The v0.2.x contract versions assume NEWM holds a special wallet that will regulate token minting and burning. In the future, this centralized signing mechanism will be replaced with a decentralized solution.
 
-The example in the repo is with test wallets. A recompile with proper wallets will need to occur during the initial production phase.
+### useful-funcs
 
-## Flow
-
-An artist comes to Newm wishing to tokenize an piece of art then fractionalize the tokenization. First, Newm will create the initial tokenized version of the art by minting a token on the official Newm catalog policy id. An artist may keep the original tokenized version of their art or they may fractionalize the original token.
-
-The fractionalization of a token is the splitting of the ownership rights of the original tokenized art into 100 million pieces. The original tokenized art is locked into a smart contract and the resulting fractions are given to the artist. From here the artist my do what they wish with the fractions.
+A library for useful functions for inside the contracts.
 
-This entire process is reversible. At any point, an artist my obtain the original tokenized by burning the 100 million fractional tokens.
+https://github.com/logicalmechanism/useful-funcs
 
-## Tokenization
-
-Each UTxO inside the tokenization contract is a unique Newm catalog, completely determined by the token prefix name like "Newm_", "paintings_", or "songs_". The contract behaves as a sequential NFT generator, minting tokens using the concatentation of the prefix with the current token counter. The sequence of NFTs will continue forever or at least until the size of the token name exceeds 32 characters.
+## Flow
 
-### Process
+An artist comes to NEWM wishing to tokenize a piece of art, digitalizing a real-world object onto the blockchain. The artist may decide to split the ownership rights of the tokenized object by fractionalization, splitting a tokeninzed object into 100,000,000 fractions. First, NEWM will create the initial tokenized object by minting an NFT on the official NEWM catalog policy id. At this point, the artist may keep the original tokenized version of their art or they may fractionalize the original NFT into a fungible token.
 
-- Create catalog UTxO inside the tokenization contract.
-- Mint sequential NFT for artist.
-- (Optional) If required, any catalog NFT may be burned.
-- (Optional) If required, any catalog may be removed.
+The fractionalization of a token is the splitting of the ownership rights of the original tokenized art into 100 million pieces. The original tokenized art is locked into a smart contract and the resulting fractions are given to the artist. From here the artist may do as they wish with their fractions.
 
-** Each prefix and thus each UTxO must be unique.
+This entire process is reversible. At any point, an artist may obtain the original tokenized object by burning the 100 million fractional tokens.
 
-### Example
+## Tokenization
 
-```bash
-./createCatalogUTxO.sh
-./MintNFT.sh
+Each UTxO inside the tokenization contract is a unique NEWM catalog, holding a unique datum with a token prefix like "NEWM_", "paintings_", or "songs_" and the current NFT counter. The contract behaves as a sequential NFT generator, minting tokens using the concatenation of the prefix with the current token counter. The sequence of NFTs will continue forever or at least until the size of the token name exceeds 32 characters. The resulting NFTs will have a token name like "NEWM_0" or "NEWM_414".
 
-# if required
-./burnNFT.sh
-./removedCatalogUTxO.sh
-```
 ## Fractionalization
 
-Each fractionalization of a token must be prepped by Newm or the artist. This ensures that only one token may be added onto an existing UTxO for fractionalization. There is no way to do entry validation for smart contracts on Cardano. Validation only occurs during a spending event thus forcing the artist or Newm to update an already existing UTxO means forcing on-chain validation. The fractionalized tokens will have the fractional Newm policy id but will share the same name as the original token. The token to be fractionalize may only be unlocked if and only if all 100 million fractions are burned together at once.
-
-### Process
-
-- Create fractional UTxO.
-- Lock and mint token fractions.
-- (Optional) If required, fractional tokens may be burned to unlock the original token.
-- (Optional) If required, the left over fractional UTxO may be removed after successful burning.
-
-** Fractionalization of tokens if the same names will result in two sets of fractions.
-
-### Example
+Each UTxO inside the fractionalization contract is a unique fractionalization of a NEWM NFT. The fractionalized tokens will have the fractional NEWM policy id but will share the same name as the original tokenized object. The minting of the fractions will only occur if the original NEWM NFT is sent into the fractional contract to be locked. This means the fractionalized UTxO may only be unlocked if all 100 million fractions are burned together in a single transaction. 
 
-```bash
-./createFractionalUTxO.sh
-./lockAndFractionalize.sh
 
-# if required
-./unlockAndSolidify.sh
-./removeFractionalUTxO.sh
-```