@zoralabs/coins 0.4.0 → 0.5.1-sdkalpha.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,74 +1,93 @@
-
-> @zoralabs/coins@0.4.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
-> 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
-Compiler run successful with warnings:
-Warning (9302): Return value of low-level calls not used.
-   --> test/Coin.t.sol:377:9:
-    |
-377 |         address(coin).call{value: 1 ether}("");
-    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- Validating plugins
-✔ Validating plugins
-- Resolving contracts
-✔ Resolving contracts
-- Running plugins
-✔ Running plugins
-- Writing to package/wagmiGenerated.ts
-✔ Writing to package/wagmiGenerated.ts
-🔄 Processing 1 file(s) to replace 'Abi' with 'ABI'...
-📝 Processing ./package/wagmiGenerated.ts...
-✅ 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
-> pnpm exec bundle-abis
-
-
-> @zoralabs/coins@0.4.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)
-CLI Building entry: package/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v7.3.0
-CLI Using tsup config: /home/runner/work/zora-protocol-private/zora-protocol-private/packages/coins/tsup.config.ts
-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
+
+
+> @zoralabs/coins@0.5.0 build /Users/iain/zora/zora-protocol-private/packages/coins
+> pnpm run wagmi:generate && pnpm run copy-abis && pnpm run prettier:write && tsup
+
+
+> @zoralabs/coins@0.5.0 wagmi:generate /Users/iain/zora/zora-protocol-private/packages/coins
+> FOUNDRY_PROFILE=dev forge build && wagmi generate && pnpm exec rename-generated-abi-casing ./package/wagmiGenerated.ts
+
+
+
+
+Compiler run successful with warnings:
+Warning (9302): Return value of low-level calls not used.
+   --> test/Coin.t.sol:527:9:
+    |
+527 |         address(coin).call{value: 1 ether}("");
+    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Warning (2072): Unused local variable.
+  --> script/DeployCoinImpl.s.sol:14:9:
+   |
+14 |         DeterministicDeployerAndCaller deployer = createOrGetDeployerAndCaller();
+   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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(
+    |          ^^^^^^^^^^^^^^^^^^^
+
+[?25l⠋ Validating plugins✔ Validating plugins
+[?25h[?25l⠙ Resolving contracts✔ Resolving contracts
+[?25h[?25l⠹ Running plugins✔ Running plugins
+[?25h[?25l⠸ Writing to package/wagmiGenerated.ts[?25l⠼ Writing to package/wagmiGenerated.ts✔ Writing to package/wagmiGenerated.ts
+[?25h🔄 Processing 1 file(s) to replace 'Abi' with 'ABI'...
+📝 Processing ./package/wagmiGenerated.ts...
+✅ Updated ./package/wagmiGenerated.ts (2 replacements)
+✨ All files processed successfully!
+
+> @zoralabs/coins@0.5.0 copy-abis /Users/iain/zora/zora-protocol-private/packages/coins
+> pnpm exec bundle-abis
+
+
+> @zoralabs/coins@0.5.0 prettier:write /Users/iain/zora/zora-protocol-private/packages/coins
+> prettier --write 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'
+
+src/Coin.solsrc/Coin.sol 364ms (unchanged)
+src/interfaces/ICoin.solsrc/interfaces/ICoin.sol 19ms (unchanged)
+src/interfaces/ICoinComments.solsrc/interfaces/ICoinComments.sol 2ms (unchanged)
+src/interfaces/IERC7572.solsrc/interfaces/IERC7572.sol 1ms (unchanged)
+src/interfaces/INonfungiblePositionManager.solsrc/interfaces/INonfungiblePositionManager.sol 8ms (unchanged)
+src/interfaces/IProtocolRewards.solsrc/interfaces/IProtocolRewards.sol 3ms (unchanged)
+src/interfaces/ISwapRouter.solsrc/interfaces/ISwapRouter.sol 2ms (unchanged)
+src/interfaces/IUniswapV3Pool.solsrc/interfaces/IUniswapV3Pool.sol 2ms (unchanged)
+src/interfaces/IUniswapV3SwapCallback.solsrc/interfaces/IUniswapV3SwapCallback.sol 1ms (unchanged)
+src/interfaces/IWETH.solsrc/interfaces/IWETH.sol 2ms (unchanged)
+src/interfaces/IZoraFactory.solsrc/interfaces/IZoraFactory.sol 3ms (unchanged)
+src/proxy/ZoraFactory.solsrc/proxy/ZoraFactory.sol 7ms (unchanged)
+src/utils/CoinConstants.solsrc/utils/CoinConstants.sol 4ms (unchanged)
+src/utils/MultiOwnable.solsrc/utils/MultiOwnable.sol 47ms (unchanged)
+src/utils/TickMath.solsrc/utils/TickMath.sol 89ms (unchanged)
+src/version/ContractVersionBase.solsrc/version/ContractVersionBase.sol 1ms (unchanged)
+src/ZoraFactoryImpl.solsrc/ZoraFactoryImpl.sol 45ms (unchanged)
+test/Coin.t.soltest/Coin.t.sol 276ms (unchanged)
+test/Factory.t.soltest/Factory.t.sol 131ms (unchanged)
+test/MultiOwnable.t.soltest/MultiOwnable.t.sol 68ms (unchanged)
+test/utils/BaseTest.soltest/utils/BaseTest.sol 69ms (unchanged)
+test/utils/ProtocolRewards.soltest/utils/ProtocolRewards.sol 255ms (unchanged)
+script/CoinsDeployerBase.solscript/CoinsDeployerBase.sol 30ms (unchanged)
+script/Deploy.s.solscript/Deploy.s.sol 4ms (unchanged)
+script/DeployCoinImpl.s.solscript/DeployCoinImpl.s.sol 4ms (unchanged)
+script/GenerateDeterministicParams.s.solscript/GenerateDeterministicParams.s.sol 11ms (unchanged)
+CLI Building entry: package/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v7.3.0
+CLI Using tsup config: /Users/iain/zora/zora-protocol-private/packages/coins/tsup.config.ts
+CLI Target: es2021
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+CJS dist/index.cjs     32.06 KB
+CJS dist/index.cjs.map 56.56 KB
+CJS ⚡️ Build success in 12ms
+ESM dist/index.js     31.00 KB
+ESM dist/index.js.map 56.45 KB
+ESM ⚡️ Build success in 12ms

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @zoralabs/coins
 
+## 0.5.1-sdkalpha.0
+
+### Patch Changes
+
+- 29a34eaf: Introduce Coins SDK
+
+## 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",
@@ -405,6 +418,13 @@
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "test_fork_buy_with_eth",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "test_initialize_validation",
@@ -412,6 +432,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 +537,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 +571,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"
+  }
+]