Audit Start - improve documentation

Improve the commenting and in-repo docs

What's Changed

• docs for protocol by @jake-nyquist in #42
• Remove the distribute asset parameter on settlement by @jake-nyquist in #43
• [Deploy] deployment script by @jake-nyquist in #41

Full Changelog: v0.0.2...v0.0.3

v0.0.2 - audit code freeze

Code freeze for protocol audits

What's Changed

• Allow call option writers to bid on spread by @regynald in #3
• Migrate natspec docs to interfaces by @regynald in #7
• [Feature] [Security] Add a specific role to upgrade the covered call implementation by @jake-nyquist in #8
• [Feature] implement a more generic vault interface by @jake-nyquist in #9
• [Feature] Create a new mintWithVault method that allows the minting of an option based on an existing vault by @jake-nyquist in #11
• [Feature] [Security] implement a flashloan architecture by @jake-nyquist in #12
• [Feature] Allow for signatureless entitlements and call minting by @jake-nyquist in #15
• block null address for new beneficial owner by @jake-nyquist in #16
• [feature] [perms] move vault feature flags to the protocol level by @jake-nyquist in #17
• [Config] implement MARKET_CONF permissions onto the covered call options by @jake-nyquist in #18
• [Feature] [Events] add protocol state events by @jake-nyquist in #19
• migrate to assetId on the vault interface; by @jake-nyquist in #20
• Merge 05-17-update_covered_call_impl_to_support_multiple_token_ids into 05-17-migrate_to_assetId_on_the_vault_interface_ by @jake-nyquist in #21
• [Feature] [Gas] create a multi-asset ERC-721 vault by @jake-nyquist in #22
• [warnings] fix warnings for the tests by @jake-nyquist in #23
• [Feature] migrate hook insturment nft-related functions to an abstract contract by @jake-nyquist in #13
• [Feature] support automatic approvals for 0x in the protocol by @jake-nyquist in #14
• [simplify] combine all of the equivalent beacons into one implementation by @jake-nyquist in #25
• Verify that hook vaults are created non-maliciously (i.e. are created by the protocol) by @jake-nyquist in #26
• Fix foundry gh action by @regynald in #35
• Hardhat code coverage tests by @jake-nyquist in #27
• Pausable reclaim asset and burn expired option by @regynald in #39
• use multi vault to create the single vault by @jake-nyquist in #40

Full Changelog: v0.0.1...v0.0.2

v0.0.1 - ropsten deploy

HookProtocol: 0x6f2155cab168d77e3ac0a6ebed8113b065d99ebf
HookERC721VaultImplV1: 0xd55fff9e1d879c79efd583ed80dff190617f0082
HookERC721VaultBeacon: 0x4848961b90d6074e6702f0dbbe26986cc2e28ea7
HookERC721VaultFactory: 0x3c49a3a4c589a21122e6a0c90633d7f8285925c2
HookCoveredCallImplV1: 0x326c2e0e2475374601d3c40bf12affb90790522b
HookCoveredCallBeacon: 0x6996e78b34746af0351d1b2955903b5987d6c88a
HookCoveredCallFactory: 0xa74f6fa54019bd7c8f2479dfefd4c04ca5d7ee3d

What's Changed

• Same solidity version for all hook files by @regynald in #2
• Add linting and remove some existing warnings by @regynald in #1
• Fix vulnerability that allows bidders to block people who will outbid by @jake-nyquist in #4
• hook 824 run protocol through static analyzer by @EliecerC in #5
• chicott/hook-830-create-github-action-for-slither by @EliecerC in #6

New Contributors

• @regynald made their first contribution in #2
• @jake-nyquist made their first contribution in #4
• @EliecerC made their first contribution in #5

Full Changelog: https://github.com/hookart/protocol/commits/v0.0.1