Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(api): self host Safe API #71

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ape_safe/_cli/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
from ape_safe._cli.pending import pending
from ape_safe._cli.safe_mgmt import _list, add, all_txns, remove

try:
from ape_safe._cli.host_api import host
except ImportError:
host = None # type: ignore[assignment]


@click.group(short_help="Manage Safe accounts and view Safe API data")
def cli():
Expand All @@ -17,3 +22,5 @@ def cli():
cli.add_command(remove)
cli.add_command(all_txns)
cli.add_command(pending)
if host:
cli.add_command(host)
43 changes: 43 additions & 0 deletions ape_safe/_cli/host_api.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import os
from typing import Annotated

import click
import uvicorn
from ape import accounts
from ape.cli import ConnectedProviderCommand
from ape.types import AddressType
from eth_pydantic_types import Address
from fastapi import Depends, FastAPI, HTTPException

from ape_safe.accounts import SafeAccount
from ape_safe.client import MockSafeClient, SafeDetails

app = FastAPI()


def get_accounts() -> dict[AddressType, SafeAccount]:
safe_account_container = accounts.containers["safe"]
for safe in safe_account_container.accounts:
safe.client = MockSafeClient(safe.contract)
return {a.address: a for a in safe_account_container.accounts}


LocalSafeAccounts = Annotated[dict[AddressType, SafeAccount], Depends(get_accounts)]


# NOTE: Mimic official Safe API
@app.get("/api/v1/safes/{address}")
@app.get("/api/v1/safes/{address}/")
async def api_v1_get_safe_details(address: Address, safes: LocalSafeAccounts) -> SafeDetails:
if not (safe := safes.get(address)):
raise HTTPException(status_code=404, detail=f"Safe not found '{address}'.")

return safe.client.safe_details


@click.command(cls=ConnectedProviderCommand)
@click.option("--port", type=int, default=8000)
def host(port):
"""Run a local-only Safe API for aggregating signatures"""
os.environ["SAFE_TRANSACTION_SERVICE_URL"] = f"http://localhost:{port}"
uvicorn.run(app)
4 changes: 4 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,17 @@
"IPython", # Console for interacting
"ipdb", # Debugger (Must use `export PYTHONBREAKPOINT=ipdb.set_trace`)
],
"host": [ # Deps for self-hosting your own Safe API
"fastapi[standard]>=0.110",
],
}

# NOTE: `pip install -e .[dev]` to install package
extras_require["dev"] = (
extras_require["test"]
+ extras_require["lint"]
+ extras_require["release"]
+ extras_require["host"]
+ extras_require["dev"]
)

Expand Down
Loading