An advanced Ethereum/EVM mobile wallet
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
alpha-wallet-ios/docs/deep-link-wallet-api.md

2.3 KiB

Deep link-based wallet API

The API provides a way for mobile apps to communicate with AlphaWallet via deep links.

Calls

Parameters are passed as query strings. There are 2 endpoints:

  • /wallet/v1/connect
    • Parameters:
      • redirecturl — refer below
      • metadata — refer below
    • Result
      • Success
        • call=connect
        • address=
      • Failure
        • call=connect
  • /wallet/v1/signpersonalmessage
    • Parameters
      • redirecturl — refer below
      • metadata — refer below
      • address — address for key to sign with (wallet will check this matches current Ethereum address)
      • message — In hex string representation
    • Result
      • Success
        • call=signpersonalmessage
        • signature=signature
      • Failure
        • call=signpersonalmessage
        • (we provide an error message/code for the current version)

Common parameters:

  • redirecturl — the callback URL to open to pass results back
  • metadata - app metadata, must be JSON containing "name" and "iconurl" and an optional: "appurl"
    • name — name of the app
    • iconurl — URL pointing to an icon for the app. png, jpeg
    • appurl - optional. URL pointing to a webpage with information about the app

Example deep links the client apps should form:

Note that whitespace (0x20) can be encoded as + or %20

Results

Results will be passed by opening the redirecturl which the client app should have been configured to handle, appending the results, eg.

So the redirecturl should be a deep link the client mobile apps are configured to handle