Skip to content

Commit

Permalink
clean up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
djviau committed Sep 21, 2023
1 parent 089b814 commit b528f7c
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Running this command deploys the example NFT contract, but it's a good way to ch

### Custom contract deployment tutorial

See [the full tutorial](docs/exampleNFTTutorial/Overview.md) for more detail on modifying the example contract, writing tests, deploying, and more.
See [the full tutorial](shipyardDocs/exampleNFTTutorial/Overview.md) for more detail on modifying the example contract, writing tests, deploying, and more.

### Reinitialize Submodules
When working across branches with different dependencies, submodules may need to be reinitialized. Run
Expand Down
2 changes: 1 addition & 1 deletion shipyardDocs/exampleNFTTutorial/CustomNFTFunctionality.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ TraitLabel memory myFirstDynamicTrait {(

Look at `TraitLabelLib.sol` to get a better sense of how to set those values up.

Then I just call `setTrait` with `bytes32(uint256(0x6d6174657269616c))` as the `traitKey` argument, `1` as the `tokenID` argument, and `bytes32(uint256(0x416c756d696e756d))`. The `_setTrait` function will store the value (`_traits[tokenId][traitKey] = value;`) and emit a `TraitUpdated` event, to put the world on notice that token ID 1 now has a new trait on it.
Then I just call `setTrait` with `bytes32(uint256(0x6d6174657269616c))` as the `traitKey` argument, `1` as the `tokenID` argument, and `bytes32(uint256(<bytes32_value_of_my_trait>))` as the `trait` argument. The `_setTrait` function will store the value (`_traits[tokenId][traitKey] = value;`) and emit a `TraitUpdated` event, to put the world on notice that token ID 1 now has a new trait on it.

## Next up:

Expand Down
2 changes: 1 addition & 1 deletion shipyardDocs/exampleNFTTutorial/EnvironmentSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ forge create --rpc-url $GOERLI_RPC \
src/reference/ExampleNFT.sol:ExampleNFT
```

I mean, you could just make a `.env` file based on the sample, source it (`. .env` or `source .env`), and run that command. You could be an NFT creator in like the next 10 minutes. Forge would compile the necessary files (`Compiler run successful!`), log the address you deployed from (`Deployer: <your_address>`), show you the transaction hash of the deployment transaction (`Transaction hash: 0x...`), and then automatically verify it on Etherscan. You'd have a contract to your name. You'd be able to link your friends and coworkers to it on Etherscan. You could even yeet a contract straight to mainnet just by switching out `$GOERLI_RPC` with `$ETH_RPC`!
I mean, you could just make a `.env` file based on the sample, source it (`. .env` or `source .env`), and run that command. You could be an NFT creator in like the next 3 minutes. Forge would compile the necessary files (`Compiler run successful!`), log the address you deployed from (`Deployer: <your_address>`), show you the transaction hash of the deployment transaction (`Transaction hash: 0x...`), and then automatically verify it on Etherscan. You'd have a contract to your name. You'd be able to link your friends and coworkers to it on Etherscan. You could even yeet a contract straight to mainnet just by switching out `$GOERLI_RPC` with `$ETH_RPC`!

But hold out, it's not time yet! Or go ahead, we're not the deploy police. But you'll definitely feel better about the contract if you run some test, make some innovative or at least fun changes, write some new tests, run them some more, and *then* deploy. Or do it right now. It's comforting to know that it actually works before you invest real time. For real, doing something at your terminal and then seeing a corresponding change on a block explorer is magical. Do it! Or don't. Either way.

Expand Down

0 comments on commit b528f7c

Please sign in to comment.