ypricemagic 4.7.2.dev0__tar.gz → 4.7.3.dev0__tar.gz

ypricemagic-4.7.3.dev0/.github/ISSUE_TEMPLATE/add_a_chain.yml

@@ -0,0 +1,128 @@
+name: "Add New Blockchain"
+description: "A checklist for adding support for a new blockchain to ypricemagic"
+title: "[Blockchain] Add: "
+labels: [blockchain, enhancement]
+body:
+  - type: input
+    id: blockchain_name
+    attributes:
+      label: Blockchain Name
+      description: "What is the name of the blockchain?"
+      placeholder: "ExampleChain"
+    validations:
+      required: true
+
+  - type: input
+    id: documentation
+    attributes:
+      label: Documentation / Website URL
+      description: "Link to official docs, developer portal, etc."
+      placeholder: "https://docs.examplechain.org"
+    validations:
+      required: true
+
+  - type: checkboxes
+    id: integration_files
+    attributes:
+      label: Integration File Checklist
+      description: |
+        For each file, check off when the main work is done.  
+        **Subtasks for each file are shown as Markdown for reference.**
+      options:
+          
+        - label: "Add network details to `./y/networks.py`"
+          description: |
+            - [ ] Add the chainid to the `Network` enum
+            - [ ] Add a short label for the chain to `Network.label`
+            - [ ] Add the network name to `Network.name`
+          
+        - label: "Add contract addresses for common tokens to `./y/constants.py`"
+          description: |
+            Define the Contract for each of the tokens below. If the new blockchain does not have one of the tokens, simply assign `None`. Follow the same format as the others.
+            - [ ] WETH
+            - [ ] WBTC
+            - [ ] USDC
+            - [ ] USDT
+            - [ ] DAI
+
+            - [ ] Add the contract addresses for any "safe" stablecoins to the `_STABLECOINS` mapping
+            - [ ] Add the contract address for the wrapped form of the network's gas token to `WRAPPED_GAS_COINS`. For example, on Ethereum, Optimism, and Arbitrum it would be the WETH address but on Polygon it is the WMATIC address
+
+        - label: "Add chainlink feeds to `./y/prices/chainlink.py`"
+          description: |
+            - [ ] Map any tokens with all chainlink feeds from https://docs.chain.link/data-feeds/price-feeds/addresses that show a green indicator
+            
+        - label: "Update `./y/classes/common.py`"
+          description: |
+            - [ ] Add the symbol for the wrapped form of the network's gas token. For example, on Ethereum, Optimism, and Arbitrum it would be "WETH" but on Polygon it is "WMATIC"
+
+        - label: "Add Uniswap V2 deployment details and any forks to `./y/prices/dex/uniswap/v2_forks.py`"
+          description:
+            - [ ] Add the factory and router addresses for Uniswap V2 and all known direct forks
+
+        - label: "Add Uniswap V3 deployment details to `./y/prices/dex/uniswap/v3.py`"
+          description: |
+            - [ ] Add the factory address for the new chain
+            - [ ] Add the quoter address for the new chain
+            - [ ] Add the fee tiers that Uniswap V3 supports on the new chain
+
+        - label: "Add any Uniswap V3 fork deployment details to `forked_deployments` in `./y/prices/dex/uniswap/v3.py`"
+          description: |
+            - [ ] Add the factory address for the new chain
+            - [ ] Add the quoter address for the new chain
+            - [ ] Add the fee tiers that Uniswap V3 supports on the new chain
+
+        - label: "Add Balancer V2 and any forks to `./y/prices/dex/balancer/v2.py`"
+          description: |
+            - [ ] Add the Vault address for Balancer V2 and all known direct forks, if applicable
+            
+        - label: "Add multicall address to `./y/utils/multicall.py`"
+          description: |
+            - [ ] Add the multicall3 address for the new chain. This will typically be `0xcA11bde05977b3631167028862bE2a173976CA11`
+
+  - type: textarea
+    id: extra
+    attributes:
+      label: Additional Information
+      description: "Add any extra details, context, links, or considerations here."
+      placeholder: "Anything else reviewers should know?"
+
+
+- in ./yearn/prices/chainlink.py:
+  - [ ] specify any chainlink feeds available on the chain in `feeds`.
+  - [ ] specify the chainlink registry address in `registries` if applicable, or specify None if not applicable.
+
+- in ./yearn/ironbank.py:
+  - [ ] add ironbank deployment address
+
+- in ./yearn/prices/compound.py:
+  - [ ] add ib comptroller
+
+- in ./yearn/v2/registry.py:
+  - [ ] add v2 vault registry
+
+- in yearn/yearn.py:
+  - [ ] add v2 vault registry and 
+  - [ ]ironbank registry
+
+- in ./yearn/prices/constants.py:
+  - [ ] specify `ib_snapshot_block_by_network`, if any, the start block of Ironbank on this network or specify '1' if not applicable.
+
+- in ./yearn/prices/uniswap/v2.py:
+  - [ ] specify the factory and router address for any important uni v2 forks on the chain.
+
+in ./yearn/prices/uniswap/v3.py:
+  - [ ] add info about uni v3 deployed on network
+
+- in ./yearn/utils.py:
+  - [ ] specify `BINARY_SEARCH_BARRIER` as 0 if all historical data is available. If historical data not available due to a network upgrade/etc, specify the first block of the available historical data.
+
+- in ./yearn/middleware/middleware.py:
+  - [ ] specify `BATCH_SIZE` of approx 1 day based on avg block times on the chain.
+
+
+It's important to test to make sure everything works!
+
+Once you've handled everything above, type `make up <network>` into your terminal replacing network with your network name at the project root. The network specific exporters will start running in docker and any exceptions will show in your terminal. If there are no exceptions, and everything appears to be running smoothly then it should be working correctly.
+
+- [ ] yes I have tested it and it is running as expected

{ypricemagic-4.7.2.dev0/ypricemagic.egg-info → ypricemagic-4.7.3.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ypricemagic
-Version: 4.7.2.dev0
+Version: 4.7.3.dev0
 Summary: Use this tool to extract historical on-chain price data from an archive node. Shoutout to @bantg and @nymmrx for their awesome work on yearn-exporter that made this library possible.
 Home-page: https://github.com/BobTheBuidler/ypricemagic
 Author: BobTheBuidler

{ypricemagic-4.7.2.dev0 → ypricemagic-4.7.3.dev0}/y/classes/common.py

@@ -253,6 +253,7 @@ class ERC20(ContractBase):
                 Network.Arbitrum: "ETH",
                 Network.Optimism: "ETH",
                 Network.Base: "ETH",
+                Network.Berachain: "BERA",
             }.get(chain.id, "ETH")
         import y._db.utils.token as db
 

{ypricemagic-4.7.2.dev0 → ypricemagic-4.7.3.dev0}/y/constants.py

@@ -285,6 +285,19 @@ elif CHAINID == Network.Base:
         This is a temporary placeholder and may not represent the actual WBTC contract on Base.
     """
 
+elif CHAINID == Network.Berachain:
+
+    weth = Contract("0x2F6F07CDcf3588944Bf4C42aC74ff24bF56e7590")
+    """Wrapped Ether (WETH) contract on Berachain."""
+
+    usdc = Contract("0x549943e04f40284185054145c6E4e9568C1D3241")  # usdbc
+    """USD Coin (USDC) contract on Berachain."""
+
+    wbtc = Contract("0x0555E30da8f98308EdB960aa94C0Db47230d2B9c")
+    """Wrapped Bitcoin (WBTC) contract on Berachain."""
+
+    usdt, dai = None, None
+
 else:
     weth, dai, wbtc, usdc, usdt = None, None, None, None, None
 
@@ -356,6 +369,9 @@ _STABLECOINS: Final[Dict[Network, Dict[ChecksumAddress, str]]] = {
         "0xd9aAEc86B65D86f6A7B5B1b0c42FFA531710b6CA": "usdbc",
         "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913": "usdc",
     },
+    Network.Berachain: {
+        "0x549943e04f40284185054145c6E4e9568C1D3241": "usdc",
+    },
 }
 
 STABLECOINS: Final[Dict[ChecksumAddress, str]] = _STABLECOINS.get(CHAINID, {})
@@ -384,6 +400,7 @@ WRAPPED_GAS_COINS: Final[Dict[Network, ChecksumAddress]] = {
     Network.Cronos: "0x5C7F8A570d578ED84E63fdFA7b1eE72dEae1AE23",
     Network.Optimism: "0x4200000000000000000000000000000000000006",
     Network.Base: "0x4200000000000000000000000000000000000006",
+    Network.Berachain: "0x6969696969696969696969696969696969696969",
 }
 
 WRAPPED_GAS_COIN: Final[ChecksumAddress] = WRAPPED_GAS_COINS[CHAINID]

{ypricemagic-4.7.2.dev0 → ypricemagic-4.7.3.dev0}/y/networks.py

@@ -76,6 +76,9 @@ class Network(IntEnum):
     Aurora = 1313161554
     """The Chain ID for Aurora"""
 
+    Berachain = 80094
+    """The Chain ID for Berachain"""
+
     @staticmethod
     def label(chain_id: Optional[int] = None) -> str:
         """
@@ -128,6 +131,8 @@ class Network(IntEnum):
             return "OPTI"
         elif chain_id == Network.Base:
             return "BASE"
+        elif chain_id == Network.Berachain:
+            return "BERA"
 
     @staticmethod
     def name(chain_id: Optional[int] = None) -> str:
@@ -181,6 +186,8 @@ class Network(IntEnum):
             return "Optimism"
         elif chain_id == Network.Base:
             return "Base"
+        elif chain_id == Network.Berachain:
+            return "Berachain"
 
     @staticmethod
     def printable(chain_id: Optional[int] = None) -> str:

{ypricemagic-4.7.2.dev0 → ypricemagic-4.7.3.dev0}/y/prices/dex/balancer/v2.py

@@ -58,6 +58,9 @@ BALANCER_V2_VAULTS = {
     Network.Base: [
         "0xBA12222222228d8Ba445958a75a0704d566BF2C8",
     ],
+    Network.Berachain: [
+        "0x4Be03f781C497A489E3cB0287833452cA9B9E80B",  # BEX Exchange https://docs.bex.berachain.com/developers/
+    ],
 }.get(CHAINID, [])
 
 MESSED_UP_POOLS = {

{ypricemagic-4.7.2.dev0 → ypricemagic-4.7.3.dev0}/y/prices/dex/uniswap/v3.py

@@ -93,6 +93,14 @@ forked_deployments: Final = {
             "fee_tiers": (3000, 500, 10_000, 100),
         },
     ],
+    Network.Berachain: [
+        {
+            # kodiak exchange https://documentation.kodiak.finance/overview/kodiak-contracts
+            "factory": "0xD84CBf0B02636E7f53dB9E5e45A616E05d710990",
+            "quoter": "0x644C8D6E501f7C994B74F5ceA96abe65d0BA662B",  # quoter v2
+            "fee_tiers": (3000, 500, 10_000, 20_000),
+        },
+    ],
 }
 
 _FEE_DENOMINATOR: Final = Decimal(1_000_000)

{ypricemagic-4.7.2.dev0 → ypricemagic-4.7.3.dev0}/y/utils/multicall.py

@@ -36,6 +36,7 @@ MULTICALL2 = {
     Network.Cronos: "0x5e954f5972EC6BFc7dECd75779F10d848230345F",
     Network.Optimism: "0xcA11bde05977b3631167028862bE2a173976CA11",  # Multicall 3
     Network.Base: "0xcA11bde05977b3631167028862bE2a173976CA11",  # mc3
+    Network.Berachain: "0xcA11bde05977b3631167028862bE2a173976CA11",
 }.get(brownie.chain.id)
 
 multicall = None

{ypricemagic-4.7.2.dev0 → ypricemagic-4.7.3.dev0/ypricemagic.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ypricemagic
-Version: 4.7.2.dev0
+Version: 4.7.3.dev0
 Summary: Use this tool to extract historical on-chain price data from an archive node. Shoutout to @bantg and @nymmrx for their awesome work on yearn-exporter that made this library possible.
 Home-page: https://github.com/BobTheBuidler/ypricemagic
 Author: BobTheBuidler

{ypricemagic-4.7.2.dev0 → ypricemagic-4.7.3.dev0}/ypricemagic.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ requirements-dev.txt
 requirements.txt
 setup.cfg
 setup.py
+.github/ISSUE_TEMPLATE/add_a_chain.yml
 .github/workflows/black.yaml
 .github/workflows/codeql-analysis.yml
 .github/workflows/compile.yaml