Merge remote-tracking branch 'origin/main' into root-format

.github/workflows/core.yaml

@@ -62,6 +62,42 @@ jobs:
             core/typechain/
           if-no-files-found: error
 
+  core-slither:
+    needs: [core-build]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v2
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: "core/.nvmrc"
+          cache: "pnpm"
+
+      - name: Install Dependencies
+        run: pnpm install --prefer-offline --frozen-lockfile
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Install Slither
+        env:
+          SLITHER_VERSION: 0.9.6
+        run: pip3 install slither-analyzer==$SLITHER_VERSION
+
+      - name: Download Build Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: core-build
+          path: core/
+
+      - name: Run Slither
+        run: slither --hardhat-ignore-compile .
+
   core-test:
     needs: [core-build]
     runs-on: ubuntu-latest

.gitignore

@@ -1 +1,9 @@
+# Node
 node_modules/
+pnpm-debug.log*
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store

.npmrc

@@ -0,0 +1 @@
+public-hoist-pattern[]=@chakra-ui/*

.nvmrc

@@ -0,0 +1 @@
+lts/iron

README.md

@@ -53,3 +53,24 @@ pre-commit run --all-files
 # Execute hooks for specific files (e.g. Acre.sol):
 pre-commit run --files ./core/contracts/Acre.sol
 ```
+
+### Slither
+
+[Slither](https://github.com/crytic/slither) is a static analysis framework used
+for Solidity contracts verification.
+
+#### Install
+
+To install Slither execute:
+
+```sh
+pip3 install slither-analyzer
+```
+
+#### Usage
+
+To run Slither execute:
+
+```sh
+slither .
+```

core/.gitignore

@@ -1,8 +1,6 @@
+# Hardhat
 build/
 cache/
 export.json
 export/
-node_modules/
 typechain/
-yarn-debug.log*
-yarn-error.log*

core/slither.config.json

@@ -1,4 +1,5 @@
 {
+  "detectors_to_exclude": "assembly,naming-convention,timestamp,pragma,solc-version",
   "hardhat_artifacts_directory": "build",
   "filter_paths": "node_modules/.*"
 }

dapp/.env

@@ -0,0 +1 @@
+VITE_USE_TESTNET=true

dapp/.gitignore

@@ -1,24 +1,2 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
-
-node_modules
-dist
-dist-ssr
-*.local
-
-# Editor directories and files
-.vscode/*
-!.vscode/extensions.json
-.idea
-.DS_Store
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?
+# Output
+dist/

dapp/README.md

@@ -1,10 +1,26 @@
 # Acre dApp
 
-## Installation
-
-1.  Install dependencies and start the app.
-    ```bash
-    yarn install
-    yarn start
-    ```
-2.  Open [http://localhost:5173](http://localhost:5173) to view it in the browser.
+The application is compatible with Ledger Live and allows people to earn yield on their Bitcoin via yield farming on Ethereum.
+
+This project was bootstrapped with [Create Vite](https://github.com/vitejs/vite/tree/main/packages/create-vite).
+
+## Quickstart
+
+Install dependencies and start the app.
+
+ ```bash
+    pnpm install
+    pnpm run start
+```
+
+Once the build is running, you can import the manifest on desktop:
+
+1. [Install Ledger Live Desktop](https://www.ledger.com/ledger-live)
+2. Enable the Developer mode
+
+    Go to the **Settings -> About** section, and click 10 times on the Ledger Live version. A new Developer section appears in the settings menu. Turn on **Enable platform dev** tools to use the developer tools window to inspect your app.
+3. Add your manifest
+
+    Click on Browse next to **Add a local app** and select the manifest file. The app is now visible in the menu.
+
+If you have any problems, take a look [here](https://developers.ledger.com/docs/non-dapp/tutorial/3-import/#desktop).

dapp/manifest-ledger-live-app.json

@@ -9,7 +9,7 @@
   "manifestVersion": "1",
   "branch": "stable",
   "categories": ["buy"],
-  "currencies": ["bitcoin", "bitcoin_testnet"],
+  "currencies": ["bitcoin", "bitcoin_testnet", "ethereum", "ethereum_goerli"],
   "content": {
     "shortDescription": {
       "en": "Bitcoin Liquid Staking"
@@ -18,6 +18,6 @@
       "en": "Bitcoin Liquid Staking"
     }
   },
-  "permissions": [],
+  "permissions": ["account.request"],
   "domains": ["http://*"]
 }

dapp/package.json

@@ -16,8 +16,6 @@
   },
   "dependencies": {
     "@chakra-ui/react": "^2.8.2",
-    "@chakra-ui/styled-system": "^2.9.2",
-    "@chakra-ui/theme-tools": "^2.1.2",
     "@emotion/react": "^11.11.1",
     "@emotion/styled": "^11.11.0",
     "@ledgerhq/wallet-api-client": "^1.2.1",

dapp/src/DApp.tsx

@@ -1,25 +1,33 @@
 import React from "react"
-import { ChakraProvider, Button, Box } from "@chakra-ui/react"
-import { useDetectThemeMode } from "./hooks"
-import { LedgerWalletAPIProvider } from "./providers"
+import { ChakraProvider, Box, Text } from "@chakra-ui/react"
+import { useDetectThemeMode, useWalletContext } from "./hooks"
 import theme from "./theme"
+import { LedgerWalletAPIProvider, WalletContextProvider } from "./contexts"
+import Navbar from "./components/Navbar"
 
 function DApp() {
   useDetectThemeMode()
+
+  const { btcAccount, ethAccount } = useWalletContext()
+
   return (
-    <Box p={4}>
+    <Box>
+      <Navbar />
       <h1>Ledger live - Acre dApp</h1>
-      <Button>Test button</Button>
+      {btcAccount && <Text>Account: {btcAccount.address}</Text>}
+      {ethAccount && <Text>Account: {ethAccount.address}</Text>}
     </Box>
   )
 }
 
 function DAppProviders() {
   return (
     <LedgerWalletAPIProvider>
-      <ChakraProvider theme={theme}>
-        <DApp />
-      </ChakraProvider>
+      <WalletContextProvider>
+        <ChakraProvider theme={theme}>
+          <DApp />
+        </ChakraProvider>
+      </WalletContextProvider>
     </LedgerWalletAPIProvider>
   )
 }

dapp/src/components/Navbar/ConnectWallet.tsx

@@ -0,0 +1,77 @@
+import React from "react"
+import { Box, Button, Image, Text } from "@chakra-ui/react"
+import { Account } from "@ledgerhq/wallet-api-client"
+import BitcoinIcon from "../../assets/bitcoin.svg"
+import EthereumIcon from "../../assets/ethereum.svg"
+import InfoIcon from "../../assets/info.svg"
+import { BITCOIN } from "../../constants"
+import {
+  useRequestBitcoinAccount,
+  useRequestEthereumAccount,
+  useWalletContext,
+} from "../../hooks"
+import { formatSatoshiAmount, truncateAddress } from "../../utils"
+
+export type ConnectButtonsProps = {
+  leftIcon: string
+  rightIcon: string
+  account: Account | undefined
+  requestAccount: () => Promise<void>
+}
+
+function ConnectButton({
+  leftIcon,
+  rightIcon,
+  account,
+  requestAccount,
+}: ConnectButtonsProps) {
+  const styles = !account ? { color: "error", borderColor: "error" } : undefined
+  return (
+    <Button
+      variant="outline"
+      sx={styles}
+      leftIcon={<Image src={leftIcon} />}
+      // TODO: Add a tooltip here
+      rightIcon={!account ? <Image src={rightIcon} /> : undefined}
+      onClick={requestAccount}
+    >
+      {account ? truncateAddress(account.address) : "Not connected"}
+    </Button>
+  )
+}
+
+export default function ConnectWallet() {
+  const { requestAccount: requestBitcoinAccount } = useRequestBitcoinAccount()
+  const { requestAccount: requestEthereumAccount } = useRequestEthereumAccount()
+  const { btcAccount, ethAccount } = useWalletContext()
+
+  return (
+    <Box display="flex" alignItems="center" gap="4">
+      <Box display="flex" gap="2">
+        <Text>Balance</Text>
+        <Text as="b">
+          {!btcAccount || btcAccount?.balance.isZero()
+            ? "0.00"
+            : formatSatoshiAmount(btcAccount.balance.toString())}
+        </Text>
+        <Text>{BITCOIN.symbol}</Text>
+      </Box>
+      <ConnectButton
+        leftIcon={BitcoinIcon}
+        rightIcon={InfoIcon}
+        account={btcAccount}
+        requestAccount={async () => {
+          await requestBitcoinAccount()
+        }}
+      />
+      <ConnectButton
+        leftIcon={EthereumIcon}
+        rightIcon={InfoIcon}
+        account={ethAccount}
+        requestAccount={async () => {
+          await requestEthereumAccount()
+        }}
+      />
+    </Box>
+  )
+}

dapp/src/components/Navbar/index.tsx

@@ -0,0 +1,11 @@
+import React from "react"
+import { Box } from "@chakra-ui/react"
+import ConnectWallet from "./ConnectWallet"
+
+export default function Navbar() {
+  return (
+    <Box p={4} display="flex" justifyContent="end">
+      <ConnectWallet />
+    </Box>
+  )
+}

dapp/src/constants/currency.ts

@@ -0,0 +1,19 @@
+import { Currency } from "../types"
+
+export const BITCOIN: Currency = {
+  name: "Bitcoin",
+  symbol: "BTC",
+  decimals: 8,
+}
+
+export const ETHEREUM: Currency = {
+  name: "Ethereum",
+  symbol: "ETH",
+  decimals: 18,
+}
+
+export const CURRENCY_ID_BITCOIN =
+  import.meta.env.VITE_USE_TESTNET === "true" ? "bitcoin_testnet" : "bitcoin"
+
+export const CURRENCY_ID_ETHEREUM =
+  import.meta.env.VITE_USE_TESTNET === "true" ? "ethereum_goerli" : "ethereum"

dapp/src/constants/index.ts

@@ -0,0 +1 @@
+export * from "./currency"

dapp/src/providers/LedgerWalletAPIProvider.tsx → dapp/src/contexts/LedgerWalletAPIProvider.tsx

@@ -19,7 +19,7 @@ type LedgerWalletAPIProviderProps = {
   children: React.ReactElement
 }
 
-export default function LedgerWalletAPIProvider({
+export function LedgerWalletAPIProvider({
   children,
 }: LedgerWalletAPIProviderProps): JSX.Element {
   const transport = getWalletAPITransport()