Skip to content

Commit

Permalink
Merge pull request #469 from ava-labs/api-error-status
Browse files Browse the repository at this point in the history
Update docs with return payload
  • Loading branch information
iansuvak authored Sep 5, 2024
2 parents 8f49c19 + d2a317c commit 576693d
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion signature-aggregator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,20 @@ The only exposed endpoint is `/aggregate-signatures` expecting `application/jso
"message": "", // (string) hex-encoded unsigned message bytes to be signed
"justification": "", // (string) hex-encoded bytes to supply to the validators as justification
"signing-subnet-id": "", // (string) hex or cb58 encoded signing subnet ID. Defaults to source blockchain's subnet from data if omitted.
"quorum-percentage": 67 // (int) quorum percentage required to sign the message. Defaults to 67 if omitted
"quorum-percentage": 67 // (int) quorum percentage required to sign the message. Defaults to 67 if omitted
}
```

The successful `HTTP 200` response format is

```json
{
"signed-message": "" // (string) hex-encoded signed message bytes signed by at least `quorum-percentage` of the validator set.
}
```

Unsuccessful responses will include an explanatory `application/json` encoded message in the body of the response.

## Sample workflow
If you want to manually test a locally running service pointed to the Fuji testnet you can do so with the following steps.

Expand Down

0 comments on commit 576693d

Please sign in to comment.