@stargatefinance/stg-evm-v2 0.0.14 → 0.0.15

package/.turbo/turbo-build.log

@@ -1,7 +1,7 @@
 installing solc version "0.8.22"
 Successfully installed solc 0.8.22
 Compiling 260 files with 0.8.22
-Solc 0.8.22 finished in 65.00s
+Solc 0.8.22 finished in 65.22s
 Compiler run successful with warnings:
 Warning (3628): This contract has a payable fallback function, but no receive ether function. Consider adding a receive ether function.
    --> src/usdc/FiatTokenProxyFlat.sol:215:1:
@@ -54,7 +54,7 @@ Generating typings for: 136 artifacts in dir: ./ts-src/typechain-types for targe
 Successfully generated 322 typings!
 Compiled 114 Solidity files successfully (evm target: paris).
 npm WARN exec The following package was not found and will be installed: @layerzerolabs/export-deployments@0.0.6
-info:    ✓ Generated 44 files:
+info:    ✓ Generated 47 files:
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/CreditMessaging.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/FeeLibV1BUSD.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/FeeLibV1ETH.ts
@@ -66,6 +66,7 @@ npm WARN exec The following package was not found and will be installed: @layerz
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/IntentOFTLUSD.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/IntentOFTUSDC.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/IntentOFTUSDT.ts
+info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/IntentPoolETH.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/IntentPoolLUSD.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/IntentPoolNative.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/IntentPoolUSDC.ts
@@ -79,6 +80,7 @@ npm WARN exec The following package was not found and will be installed: @layerz
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/OFTTokenUSDC.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/OFTTokenUSDT.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/Permit2Mock.ts
+info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/PoolTokenETH.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/PoolTokenLUSD.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/PoolTokenUSDC.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/PoolTokenUSDT.ts
@@ -90,6 +92,7 @@ npm WARN exec The following package was not found and will be installed: @layerz
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/StargateOFTLUSD.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/StargateOFTUSDC.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/StargateOFTUSDT.ts
+info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/StargatePoolETH.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/StargatePoolLUSD.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/StargatePoolNative.ts
 info:    	/home/runner/work/stargate-v2/stargate-v2/packages/stg-evm-v2/deployed/StargatePoolUSDC.ts

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @stargatefinance/stg-evm-v2
 
+## 0.0.15
+
+### Patch Changes
+
+- 61a9093: Localnet 2.1.25.4
+- c713b8b: Update asset deployment script
+
 ## 0.0.14
 
 ### Patch Changes

package/deploy/001-deploy-asset.ts

@@ -0,0 +1,129 @@
+import assert from 'assert'
+
+import { NativeTokenName, StargateType, TokenAddressConfig, getTokenNameEnv } from '@stargatefinance/stg-definitions-v2'
+import { HardhatRuntimeEnvironment } from 'hardhat/types'
+import { DeployFunction } from 'hardhat-deploy/dist/types'
+
+import { Chain, EndpointVersion, Network, networkToChain, networkToEndpointId } from '@layerzerolabs/lz-definitions'
+
+import { getOFTAssetDeploymentName, getPoolAssetDeploymentName, getTokenDeployName } from '../ops/util'
+import { CONTRACT_STARGATE_TAGS, ERC20 } from '../ts-src'
+
+import { getStargateTypeByNetwork } from './util'
+import { deployNativePoolAsset, deployOFTAsset, deployPoolAsset } from './utils/deploy-asset'
+
+// FIXME config
+const sharedDecimals = 6
+
+const deploy: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
+    const tokenName = getTokenNameEnv()
+    assert(tokenName, 'Missing token name')
+
+    const network = hre.network.name as Network
+    const chain: Chain = networkToChain(network)
+    const stargateType = await getStargateTypeByNetwork(hre.network.name as Network, tokenName)
+
+    // If we are deploying a native pool, it's quite straightforward
+    if (stargateType === StargateType.Native) {
+        return deployNativePoolAsset(hre, {
+            tokenSymbol: NativeTokenName[chain as keyof typeof NativeTokenName] ?? tokenName,
+            sharedDecimals,
+            tokenDecimals: 18,
+        })
+    }
+
+    // For the Pool & OFT we're gonna need some more information
+    const tokenAddress =
+        // We'll grab the token address either from a list of external token addresses
+        getExternalTokenAddress(network, tokenName) ??
+        // Or from local deployments if that fails
+        //
+        // For this we need to also grab the name under which this token should exist
+        (await getInternalTokenAddress(hre, getTokenDeployName(tokenName, stargateType)))
+    assert(tokenAddress, `Missing pool token address for ${tokenName} on ${network}`)
+
+    // Now let's get some symbols and decimals
+    const tokenProperties = await getTokenProperties(hre, tokenAddress)
+
+    // TODO You can't get rid of all conditionals at the same time can you
+    const isUsdc = tokenName === 'USDC'
+
+    switch (stargateType) {
+        case StargateType.Pool:
+            return deployPoolAsset(hre, {
+                contractName: isUsdc ? 'StargatePoolUSDC' : 'StargatePool',
+                deploymentName: getPoolAssetDeploymentName(tokenName),
+                sharedDecimals,
+                tokenAddress,
+                ...tokenProperties,
+            })
+
+        case StargateType.Oft:
+            return deployOFTAsset(hre, {
+                contractName: isUsdc ? 'StargateOFTUSDC' : 'StargateOFT',
+                deploymentName: getOFTAssetDeploymentName(tokenName),
+                sharedDecimals,
+                tokenAddress,
+                ...tokenProperties,
+            })
+    }
+}
+
+deploy.tags = CONTRACT_STARGATE_TAGS
+
+export default deploy
+
+/**
+ * Helper function that grabs a token address of an external token,
+ * configured using a static address config in `@stargatefinance/stg-definitions-v2`
+ *
+ * @param {Network} network
+ * @param {string} tokenName Short name of a token, e.g. USDC or USDT
+ * @returns {string | undefined} Address of an external token or `undefined` if the token has not been configured
+ */
+const getExternalTokenAddress = (network: Network, tokenName: string): string | undefined => {
+    const eid = networkToEndpointId(network, EndpointVersion.V2)
+
+    // FIXME This type assertion is quite nasty, especially since it reults in a non-nullable type for tokenConfig
+    const tokenConfig = TokenAddressConfig[eid as keyof typeof TokenAddressConfig]
+
+    // FIXME Another type assertion in a critical place
+    return tokenConfig?.[tokenName as keyof typeof tokenConfig]
+}
+
+/**
+ * Helper function that grabs a token address from local deployments
+ *
+ * @param {HardhatRuntimeEnvironment} hre
+ * @param {string} tokenDeploymentName The name under which this token should have been deployed
+ * @returns {promise<string | undefined>} Address of an external token or undefined if this token has not been deployed
+ */
+const getInternalTokenAddress = async (
+    hre: HardhatRuntimeEnvironment,
+    tokenDeploymentName: string
+): Promise<string | undefined> => {
+    const tokenDeployment = await hre.deployments.getOrNull(tokenDeploymentName)
+
+    return tokenDeployment?.address
+}
+
+/**
+ * Helper function that grabs token properties (symbol & decimals)
+ * from a deployed ERC20 token
+ *
+ * @param {HardhatRuntimeEnvironment} hre
+ * @param {string} tokenAddress
+ */
+const getTokenProperties = async (
+    hre: HardhatRuntimeEnvironment,
+    tokenAddress: string
+): Promise<{ tokenDecimals: number; tokenSymbol: string }> => {
+    const token = (await hre.ethers.getContractAt(
+        '@openzeppelin/contracts/token/ERC20/ERC20.sol:ERC20',
+        tokenAddress
+    )) as ERC20
+
+    const [tokenDecimals, tokenSymbol] = await Promise.all([token.decimals(), token.symbol()])
+
+    return { tokenDecimals, tokenSymbol }
+}

package/deploy/utils/deploy-asset.ts

@@ -0,0 +1,158 @@
+import { Network } from '@layerzerolabs/lz-definitions'
+
+import { getNativePoolAssetDeploymentName } from '../../ops/util'
+import { ENDPOINT_CONTRACT_PACKAGE } from '../../ts-src'
+import { getDeployment } from '../util'
+
+import type { HardhatRuntimeEnvironment } from 'hardhat/types'
+
+interface DeployOFTAssetOptions {
+    contractName: 'StargateOFTUSDC' | 'StargateOFT'
+    deploymentName: string
+    tokenAddress: string
+    sharedDecimals: number
+}
+
+export const deployOFTAsset = async (
+    hre: HardhatRuntimeEnvironment,
+    { contractName, deploymentName, tokenAddress, sharedDecimals }: DeployOFTAssetOptions
+) => {
+    const { deployments } = hre
+    const { deployer } = await hre.getNamedAccounts()
+
+    // Let's get em EndpointV2 deployment properties
+    //
+    // TODO Replace with native deployments.get once we have eid configured in hardhat networks
+    const endpointAddress = await getEndpointV2Address(hre)
+
+    // Let the world know we're doing something
+    console.table({
+        Asset: deploymentName,
+        Contract: contractName,
+        Deployer: deployer,
+        Endpoint: endpointAddress,
+        'Shared Decimals': sharedDecimals,
+    })
+
+    await deployments.deploy(deploymentName, {
+        contract: contractName,
+        from: deployer,
+        args: [tokenAddress, sharedDecimals, endpointAddress, deployer],
+        log: true,
+        waitConfirmations: 1,
+        skipIfAlreadyDeployed: true,
+        gasPrice: await hre.ethers.provider.getGasPrice(),
+    })
+}
+
+interface DeployNativePoolAssetOptions {
+    deploymentName?: string
+    tokenSymbol: string
+    sharedDecimals: number
+    tokenDecimals: number
+}
+
+export const deployNativePoolAsset = async (
+    hre: HardhatRuntimeEnvironment,
+    {
+        deploymentName = getNativePoolAssetDeploymentName(),
+        tokenSymbol,
+        sharedDecimals,
+        tokenDecimals,
+    }: DeployNativePoolAssetOptions
+) => {
+    const contractName = 'StargatePoolNative'
+    const { deployments } = hre
+    const { deployer } = await hre.getNamedAccounts()
+
+    // Let's get em EndpointV2 deployment properties
+    //
+    // TODO Replace with native deployments.get once we have eid configured in hardhat networks
+    const endpointAddress = await getEndpointV2Address(hre)
+
+    // Let the world know we're doing something
+    console.table({
+        Asset: deploymentName,
+        Contract: contractName,
+        Deployer: deployer,
+        Endpoint: endpointAddress,
+        'Token Symbol': tokenSymbol,
+        'Shared Decimals': sharedDecimals,
+        'Token Decimals': tokenDecimals,
+    })
+
+    await deployments.deploy(deploymentName, {
+        from: deployer,
+        contract: contractName,
+        args: [
+            `Stargate ${tokenSymbol} Vault-LP`,
+            `S*SG${tokenSymbol}`,
+            tokenDecimals,
+            sharedDecimals,
+            endpointAddress,
+            deployer,
+        ],
+        log: true,
+        waitConfirmations: 1,
+        skipIfAlreadyDeployed: true,
+        gasPrice: await hre.ethers.provider.getGasPrice(),
+    })
+}
+
+interface DeployPoolAssetOptions {
+    contractName: 'StargatePoolUSDC' | 'StargatePool'
+    deploymentName: string
+    tokenAddress: string
+    tokenSymbol: string
+    sharedDecimals: number
+    tokenDecimals: number
+}
+
+export const deployPoolAsset = async (
+    hre: HardhatRuntimeEnvironment,
+    { contractName, deploymentName, tokenAddress, tokenSymbol, sharedDecimals, tokenDecimals }: DeployPoolAssetOptions
+) => {
+    const { deployments } = hre
+    const { deployer } = await hre.getNamedAccounts()
+
+    // Let's get em EndpointV2 deployment properties
+    //
+    // TODO Replace with native deployments.get once we have eid configured in hardhat networks
+    const endpointAddress = await getEndpointV2Address(hre)
+
+    // Let the world know we're doing something
+    console.table({
+        Asset: deploymentName,
+        Contract: contractName,
+        Deployer: deployer,
+        Endpoint: endpointAddress,
+        'Token Address': tokenAddress,
+        'Token Symbol': tokenSymbol,
+        'Shared Decimals': sharedDecimals,
+        'Token Decimals': tokenDecimals,
+    })
+
+    await deployments.deploy(deploymentName, {
+        contract: contractName,
+        from: deployer,
+        args: [
+            `Stargate ${tokenSymbol} Vault-LP`,
+            `S*SG${tokenSymbol}`,
+            tokenAddress,
+            tokenDecimals,
+            sharedDecimals,
+            endpointAddress,
+            deployer,
+        ],
+        log: true,
+        waitConfirmations: 1,
+        skipIfAlreadyDeployed: true,
+        gasPrice: await hre.ethers.provider.getGasPrice(),
+    })
+}
+
+const getEndpointV2Address = async (hre: HardhatRuntimeEnvironment) => {
+    const deployment = await getDeployment(hre.network.name as Network, ENDPOINT_CONTRACT_PACKAGE, 'EndpointV2')
+
+    return deployment.address
+}