Signature API

The Signature API endpoint (try it out here) receives a raw Signature Request object containing the following fields:

Field	Type	Notes
`method`	SignMethod enum	(Required) The RPC method being invoked
`params`	array of strings	(Required) An array of strings, each representing an input to the RPC method. Depending on which `method` is being called, different params are expected. See here for more details.
`url`	string	(Optional) URL of the website or dapp that originated the transaction. Used for risk assessment.

The Signature API endpoint returns an object containing the following fields.

Base Response Fields: these fields are present on both Transaction and Signature API responses.

Field	Type	Notes
`summary`	string	Required. A one-sentence summary of this transaction.
`risk`	RiskResult	Required. Results of risk evaluation
`assetChanges`	AssetChange[]	Required. List of assets leaving or entering the signer's wallet
`errors`	string[]	Optional. List of error messages. Present if any errors were encountered.

Signature-specific response fields: these fields are present only on Signature API responses.

Field	Type	Notes
`rpcMethod`	RPCMethod	Required. RPC Method type string enum. There will rarely be new RPC method types added.
`signatureType`	SignatureType	Required. Signature type string enum. More signature types will be added as Stelo adds support for more protocols.
`signer`	string	Required. Address of signer.
`message`	string	Optional. Plaintext message being signed. Always present for `eth_sign` and `personal_sign` requests.
`json`	JSON	Optional. Parsed JSON object being signed. Always present when `rpcMethod` is `EIP712_TYPED_DATA`
`seaport`	Seaport	Optional. Details of Seaport message being signed. Always present when `signatureType` is `SEAPORT`
`transaction`	ParsedTransaction	Optional. Details of embedded transaction (eg. for a Gnosis safe transaction). Always present when `signatureType` is `TRANSACTION`