@zoralabs/coins 0.4.0 → 0.6.0

package/.env.example

@@ -0,0 +1,7 @@
+# Turnkey authentication and private key information
+TURNKEY_API_PUBLIC_KEY=""
+TURNKEY_API_PRIVATE_KEY=""
+TURNKEY_ORGANIZATION_ID=""
+TURNKEY_PRIVATE_KEY_ID="xxxx-xxx-xxxx-xxxx-xxxxxxxx"
+TURNKEY_TARGET_ADDRESS="xxxxxxxx"
+DEPLOYER="xxxxxx"

package/.turbo/turbo-build.log

@@ -1,20 +1,32 @@
 
-> @zoralabs/coins@0.4.0 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@0.6.0 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
 > pnpm run wagmi:generate && pnpm run copy-abis && pnpm run prettier:write && tsup
 
 
-> @zoralabs/coins@0.4.0 wagmi:generate /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@0.6.0 wagmi:generate /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
 > FOUNDRY_PROFILE=dev forge build && wagmi generate && pnpm exec rename-generated-abi-casing ./package/wagmiGenerated.ts
 
-Compiling 79 files with Solc 0.8.23
-Solc 0.8.23 finished in 198.33s
+Compiling 93 files with Solc 0.8.28
+Solc 0.8.28 finished in 106.36s
 Compiler run successful with warnings:
 Warning (9302): Return value of low-level calls not used.
-   --> test/Coin.t.sol:377:9:
+   --> test/Coin.t.sol:527:9:
     |
-377 |         address(coin).call{value: 1 ether}("");
+527 |         address(coin).call{value: 1 ether}("");
     |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+Warning (2072): Unused local variable.
+   --> test/Coin.t.sol:446:10:
+    |
+446 |         (address newCoinAddr, ) = factory.deploy(
+    |          ^^^^^^^^^^^^^^^^^^^
+
+Warning (2072): Unused local variable.
+   --> test/Coin.t.sol:464:10:
+    |
+464 |         (address newCoinAddr, ) = factory.deploy(
+    |          ^^^^^^^^^^^^^^^^^^^
+
 - Validating plugins
 ✔ Validating plugins
 - Resolving contracts
@@ -28,36 +40,38 @@ Warning (9302): Return value of low-level calls not used.
 ✅ Updated ./package/wagmiGenerated.ts (2 replacements)
 ✨ All files processed successfully!
 
-> @zoralabs/coins@0.4.0 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@0.6.0 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
 > pnpm exec bundle-abis
 
 
-> @zoralabs/coins@0.4.0 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
+> @zoralabs/coins@0.6.0 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins
 > prettier --write 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'
 
-src/Coin.sol 728ms (unchanged)
-src/interfaces/ICoin.sol 36ms (unchanged)
-src/interfaces/ICoinComments.sol 3ms (unchanged)
-src/interfaces/IERC7572.sol 1ms (unchanged)
-src/interfaces/INonfungiblePositionManager.sol 21ms (unchanged)
-src/interfaces/IProtocolRewards.sol 6ms (unchanged)
-src/interfaces/ISwapRouter.sol 9ms (unchanged)
-src/interfaces/IUniswapV3Pool.sol 4ms (unchanged)
-src/interfaces/IUniswapV3SwapCallback.sol 3ms (unchanged)
-src/interfaces/IWETH.sol 8ms (unchanged)
-src/interfaces/IZoraFactory.sol 12ms (unchanged)
-src/proxy/ZoraFactory.sol 13ms (unchanged)
-src/utils/CoinConstants.sol 6ms (unchanged)
-src/utils/MultiOwnable.sol 88ms (unchanged)
-src/utils/TickMath.sol 138ms (unchanged)
-src/version/ContractVersionBase.sol 2ms (unchanged)
-src/ZoraFactoryImpl.sol 86ms (unchanged)
-test/Coin.t.sol 378ms (unchanged)
-test/Factory.t.sol 155ms (unchanged)
-test/MultiOwnable.t.sol 109ms (unchanged)
-test/utils/BaseTest.sol 108ms (unchanged)
-test/utils/ProtocolRewards.sol 407ms (unchanged)
-script/Deploy.s.sol 4ms (unchanged)
+src/Coin.sol 1610ms (unchanged)
+src/interfaces/ICoin.sol 66ms (unchanged)
+src/interfaces/ICoinComments.sol 8ms (unchanged)
+src/interfaces/IERC7572.sol 4ms (unchanged)
+src/interfaces/INonfungiblePositionManager.sol 19ms (unchanged)
+src/interfaces/IProtocolRewards.sol 14ms (unchanged)
+src/interfaces/ISwapRouter.sol 6ms (unchanged)
+src/interfaces/IUniswapV3Pool.sol 14ms (unchanged)
+src/interfaces/IUniswapV3SwapCallback.sol 7ms (unchanged)
+src/interfaces/IWETH.sol 16ms (unchanged)
+src/interfaces/IZoraFactory.sol 11ms (unchanged)
+src/proxy/ZoraFactory.sol 30ms (unchanged)
+src/utils/CoinConstants.sol 10ms (unchanged)
+src/utils/MultiOwnable.sol 223ms (unchanged)
+src/utils/TickMath.sol 417ms (unchanged)
+src/version/ContractVersionBase.sol 7ms (unchanged)
+src/ZoraFactoryImpl.sol 234ms (unchanged)
+test/Coin.t.sol 1368ms (unchanged)
+test/Factory.t.sol 470ms (unchanged)
+test/MultiOwnable.t.sol 280ms (unchanged)
+test/utils/BaseTest.sol 238ms (unchanged)
+test/utils/ProtocolRewards.sol 1003ms (unchanged)
+script/CoinsDeployerBase.sol 96ms (unchanged)
+script/Deploy.s.sol 12ms (unchanged)
+script/GenerateDeterministicParams.s.sol 54ms (unchanged)
 CLI Building entry: package/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v7.3.0
@@ -66,9 +80,9 @@ CLI Target: es2021
 CLI Cleaning output folder
 CJS Build start
 ESM Build start
-ESM dist/index.js     30.86 KB
-ESM dist/index.js.map 56.19 KB
-ESM ⚡️ Build success in 20ms
-CJS dist/index.cjs     31.91 KB
-CJS dist/index.cjs.map 56.30 KB
-CJS ⚡️ Build success in 21ms
+ESM dist/index.js     31.00 KB
+ESM dist/index.js.map 56.45 KB
+ESM ⚡️ Build success in 47ms
+CJS dist/index.cjs     32.06 KB
+CJS dist/index.cjs.map 56.56 KB
+CJS ⚡️ Build success in 49ms

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @zoralabs/coins
 
+## 0.6.0
+
+### Minor Changes
+
+- 55bc4bf3: Update WETH tick and use as the minimum
+
+## 0.5.0
+
+### Minor Changes
+
+- 39ffa77c: Add coin refunds for large sells with little liquidity
+
 ## 0.4.0
 
 ### Minor Changes

package/README.md

@@ -0,0 +1,29 @@
+# Coins
+
+## Deployment
+
+The `ZoraFactory` contract is deployed deterministically using a turnkey account. The deployment process uses a helper contract, [DeterministicDeployerAndCaller](../../packages/shared-contracts/src/deployment/DeterministicDeployerAndCaller.sol).
+
+### Prerequisites
+
+- Ensure you have [Forge](https://book.getfoundry.sh/getting-started/installation) installed.
+- Familiarity with [turnkey accounts](https://docs.turnkey.com/) is recommended.
+
+### Setting up environment variables
+
+In the `packages/coins` directory:
+
+1. Copy `.env.example` to `.env`
+2. Populate the parameters in `.env`
+
+### Deploying the Coins Factory
+
+1. Deploy the `ZoraFactory` contract, you must pass the `--ffi` flag to enable calling an external script to sign the deployment with turnkey:
+
+```bash
+forge script script/Deploy.s.sol $(chains {chainName} --deploy) --broadcast --verify --ffi
+```
+
+where `{chainName}` is the emdash name of the chain you want to deploy on.
+
+2. Verify the factory contract. Since it is deployed with create2, foundry won't always recognize the deployed contract; verification instructions will be printed out in the logs.

package/abis/Coin.json

@@ -288,6 +288,11 @@
       }
     ],
     "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
       {
         "name": "",
         "type": "uint256",
@@ -748,6 +753,11 @@
       }
     ],
     "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
       {
         "name": "",
         "type": "uint256",

package/abis/CoinTest.json

@@ -308,6 +308,19 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "test_buy_validate_return_amounts",
+    "inputs": [
+      {
+        "name": "orderSize",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "test_buy_with_eth",
@@ -412,6 +425,20 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "test_invalid_currency_tick",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "test_invalid_weth_tick",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "test_market_slippage",
@@ -503,6 +530,20 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "test_sell_for_eth_direct_and_claim_secondary",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "test_sell_for_eth_direct_and_claim_secondary_push_eth",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "test_sell_for_eth_fuzz",
@@ -523,6 +564,13 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "test_sell_partial_execution",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "test_set_contract_uri",

package/abis/Create2.json

@@ -0,0 +1,28 @@
+[
+  {
+    "type": "error",
+    "name": "Create2EmptyBytecode",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "Create2FailedDeployment",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "Create2InsufficientBalance",
+    "inputs": [
+      {
+        "name": "balance",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "needed",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ]
+  }
+]

package/abis/DeployScript.json

@@ -0,0 +1,9 @@
+[
+  {
+    "type": "function",
+    "name": "run",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  }
+]

package/abis/DeterministicDeployerAndCaller.json

@@ -0,0 +1,315 @@
+[
+  {
+    "type": "constructor",
+    "inputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "eip712Domain",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "fields",
+        "type": "bytes1",
+        "internalType": "bytes1"
+      },
+      {
+        "name": "name",
+        "type": "string",
+        "internalType": "string"
+      },
+      {
+        "name": "version",
+        "type": "string",
+        "internalType": "string"
+      },
+      {
+        "name": "chainId",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "verifyingContract",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "salt",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "extensions",
+        "type": "uint256[]",
+        "internalType": "uint256[]"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "hashDigest",
+    "inputs": [
+      {
+        "name": "salt",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "code",
+        "type": "bytes",
+        "internalType": "bytes"
+      },
+      {
+        "name": "postCreateCall",
+        "type": "bytes",
+        "internalType": "bytes"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "permitSafeCreate2AndCall",
+    "inputs": [
+      {
+        "name": "signature",
+        "type": "bytes",
+        "internalType": "bytes"
+      },
+      {
+        "name": "salt",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "code",
+        "type": "bytes",
+        "internalType": "bytes"
+      },
+      {
+        "name": "postCreateCall",
+        "type": "bytes",
+        "internalType": "bytes"
+      },
+      {
+        "name": "_expectedAddress",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "stateMutability": "payable"
+  },
+  {
+    "type": "function",
+    "name": "proxyConstructorArgs",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bytes",
+        "internalType": "bytes"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "proxyCreationCode",
+    "inputs": [
+      {
+        "name": "proxyCode",
+        "type": "bytes",
+        "internalType": "bytes"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bytes",
+        "internalType": "bytes"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "proxyShim",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "contract ProxyShim"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "safeCreate2AndCall",
+    "inputs": [
+      {
+        "name": "salt",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "code",
+        "type": "bytes",
+        "internalType": "bytes"
+      },
+      {
+        "name": "postCreateCall",
+        "type": "bytes",
+        "internalType": "bytes"
+      },
+      {
+        "name": "_expectedAddress",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "stateMutability": "payable"
+  },
+  {
+    "type": "event",
+    "name": "EIP712DomainChanged",
+    "inputs": [],
+    "anonymous": false
+  },
+  {
+    "type": "error",
+    "name": "CallFailed",
+    "inputs": [
+      {
+        "name": "returnData",
+        "type": "bytes",
+        "internalType": "bytes"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "Create2EmptyBytecode",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "Create2FailedDeployment",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "Create2InsufficientBalance",
+    "inputs": [
+      {
+        "name": "balance",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "needed",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "ECDSAInvalidSignature",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "ECDSAInvalidSignatureLength",
+    "inputs": [
+      {
+        "name": "length",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "ECDSAInvalidSignatureS",
+    "inputs": [
+      {
+        "name": "s",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "FactoryProxyAddressMismatch",
+    "inputs": [
+      {
+        "name": "expected",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "actual",
+        "type": "address",
+        "internalType": "address"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "InvalidSalt",
+    "inputs": [
+      {
+        "name": "signer",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "salt",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "InvalidShortString",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "StringTooLong",
+    "inputs": [
+      {
+        "name": "str",
+        "type": "string",
+        "internalType": "string"
+      }
+    ]
+  }
+]