Comments:BIP 0171

Cerise ( by straumat )

CERISE (website & github) provides :

• BIP-0171 specifications.
• A mocked BIP-0171 compliant server available online you can use to understand the API and make calls.
• A mocked BIP-0171 compliant server as a Java application you can use to develop your client application.
• A mocked BIP-0171 compliant server as a Docker image you can use to develop your client application.
• A BIP-0171 library to transform your application in a BIP-0171 server.
• A server template project to quickly write your implementation and automatically produce your BIP-0171 server.
• A collection of client libraries to call any BIP-0171 compliant server with your favorite language.

Error management proposal ( by straumat )

These are the different http status :

• 200 : Everything worked as expected.
• 400 : The request was unacceptable, often due to missing a required parameter.
• 401 : No valid authorization was provided.
• 402 : The parameters were valid but the request failed.
• 404 : The requested resource doesn't exist.
• 500 : Something went wrong on the server.

In case of error, we always return this object :

{
  "type": "invalid_request_error",
  "message": "Invalid request to enumerating supported currency-pair",
  "errors": [
    {
      "code": "currency_code_invalid",
      "message": "Invalid currency code : AAA"
    },
    {
      "code": "currency_code_invalid",
      "message": "Invalid currency code : BBB"
    },
    {
      "code": "locale_invalid",
      "message": "Invalid locale : UN_UN"
    }
  ]
}

Type : The type of error returned. One of api_connection_error, api_error, authentication_error, invalid_request_error or rate_limit_error.

message : A human-readable message providing more details about the error.

and then you have all the errors with, for each error found :

code : Error code like currency_code_invalid.

message : A human-readable message providing more details about the error.

Change to make in the BIP ? ( by straumat )

“a GET request to a common URI with parameters encoded in application/x-www-form-urlencoded format” May I ask you why parameters should be encoded this way ? From what I have seen in other projects, they also allow json for get method.

In the samples you provided, all returned fields are not set. For example, signature is never set. Of course it’s not a problem but I think it would be a good idea to have at least a result with all fields set so i could implement all the unit test cases. I have the same comment for “archive” and “signature” fiedls in Currency-pair information. I have the same comment for “minrate” and “maxrate” parameters in Current exchange rate and nonce in result.

“digits - The type of digits to use for the quote currency's numbers. "arabic" should be used for common 0-9 digits.” Don’t you think we should provide the list of supported digits ?

Things I don’t understand ( by straumat )

I don’t understand what means “XBTUSD-ver4” ? I don’t see what it means. “Currency-pair information \ symbol : Any positive or negative symbols must be included in this prefix/suffix” I don’t understand this rule. Can you explain it more please ?