regulated-assets-approval-server

README

regulated-assets-approval-server

Status: supports SEP-8 transactions revision with a simplified rule:
- only revises transactions containing a single operation of type payment.
- payments whose amount does not meet the configured threshold are considered compliant and revised according to the SEP-8 specification.
- payments with an amount exceeding the threshold need further action.
- transactions already compliant with SEP-8 that don't need to be revised will be signed and returned with the "success" SEP-8 status.

Note: SEP-8 states the service should be able to handle offers in addition to payments, but we're not supporting that at the moment.

This is a SEP-8 Approval Server reference implementation based on SEP-8 v1.7.1 intended for testing only. It is being conceived to:

1. Be used as an example of how regulated assets transactions can be validated and revised by an anchor.
2. Serve as a demo server where wallets can test and validate their SEP-8 implementation.

Table of Contents

• regulated-assets-approval-server
  • Table of Contents
  • Usage
    • Usage: Configure Issuer
    • Usage: Migrate
      • Migration files
    • Usage: Serve
  • Account Setup
    • GET /friendbot?addr={digitalbits_address}
  • API Spec
    • POST /tx-approve
    • POST /kyc-status/{CALLBACK_ID}
    • GET /kyc-status/{DIGITALBITS_ADDRESS_OR_CALLBACK_ID}
    • DELETE /kyc-status/{DIGITALBITS_ADDRESS}

Created by gh-md-toc

Usage

$ go install
$ regulated-assets-approval-server --help
SEP-8 Approval Server

Usage:
  regulated-assets-approval-server [command] [flags]
  regulated-assets-approval-server [command]

Available Commands:
  configure-issuer Configure the Asset Issuer Account for SEP-8 Regulated Assets
  migrate          Run migrations on the database
  serve            Serve the SEP-8 Approval Server

Use "regulated-assets-approval-server [command] --help" for more information about a command.

Usage: Configure Issuer

$ go install
$ regulated-assets-approval-server configure-issuer --help
Configure the Asset Issuer Account for SEP-8 Regulated Assets

Usage:
  regulated-assets-approval-server configure-issuer [flags]

Flags:
      --asset-code string              The code of the regulated asset (ASSET_CODE)
      --base-url string                The base url to the server where the asset home domain should be. For instance, "https://test.example.com/" if your desired asset home domain is "test.example.com". (BASE_URL)
      --frontier-url string             Frontier URL used for looking up account details (FRONTIER_URL) (default "https://frontier.testnet.digitalbits.io/")
      --issuer-account-secret string   Secret key of the issuer account. (ISSUER_ACCOUNT_SECRET)
      --network-passphrase string      Network passphrase of the DigitalBits network transactions should be signed for (NETWORK_PASSPHRASE) (default "TestNet Global DigitalBits Network ; December 2020")

Usage: Migrate

$ go install
$ regulated-assets-approval-server migrate --help
Run migrations on the database

Usage:
  regulated-assets-approval-server migrate [up|down] [count] [flags]

Flags:
      --database-url string   Database URL (DATABASE_URL) (default "postgres://localhost:5432/?sslmode=disable")

Migration files

This project builds the migrations into the binary and embeds it into the built project. If there are any changes to the db schema, generate a new version of internal/db/dbmigrate/dbmigrate_generated.go using the gogenerate.sh script located at the root of the repo.

$ ./gogenerate.sh

Usage: Serve

$ go install
$ regulated-assets-approval-server serve --help
Serve the SEP-8 Approval Server

Usage:
  regulated-assets-approval-server serve [flags]

Flags:
      --asset-code string                              The code of the regulated asset (ASSET_CODE)
      --base-url string                                The base url address to this server (BASE_URL)
      --database-url string                            Database URL (DATABASE_URL) (default "postgres://localhost:5432/?sslmode=disable")
      --friendbot-payment-amount int                   The amount of regulated assets the friendbot will be distributing (FRIENDBOT_PAYMENT_AMOUNT) (default 10000)
      --frontier-url string                             Frontier URL used for looking up account details (FRONTIER_URL) (default "https://frontier.testnet.digitalbits.io/")
      --issuer-account-secret string                   Secret key of the issuer account. (ISSUER_ACCOUNT_SECRET)
      --kyc-required-payment-amount-threshold string   The amount threshold when KYC is required, may contain decimals and is greater than 0 (KYC_REQUIRED_PAYMENT_AMOUNT_THRESHOLD) (default "500")
      --network-passphrase string                      Network passphrase of the DigitalBits network transactions should be signed for (NETWORK_PASSPHRASE) (default "TestNet Global DigitalBits Network ; December 2020")
      --port int                                       Port to listen and serve on (PORT) (default 8000)

Account Setup

In order to properly use this server for regulated assets, the account whose secret was added in --issuer-account-secret (ISSUER_ACCOUNT_SECRET) needs to be configured according with SEP-8 authorization flags by setting both Authorization Required and Authorization Revocable flags. This allows the issuer to grant and revoke authorization to transact the asset at will.

You can use the command $ regulated-assets-approval-server configure-issuer or this DigitalBits Laboratory link to set those flags.

After setting up the issuer account you can send some amount of the regulated asset to a digitalbits account using the servers friendbot friendbot/?addr={digitalbits_address} endpoint. The friendbot endpoint is not part of the SEP-8 Approval Server specification, it's a debug feature that allows accounts to test sending transactions containing payments with the issuer's regulated asset, to the server.

GET /friendbot?addr={digitalbits_address}

This endpoint sends a payment of 10,000 (this value is configurable) regulated assets to the provided addr. Please be aware the address must first establish a trustline to the regulated asset in order to receive that payment. You can use this link to do that in DigitalBits Laboratory.

API Spec

POST /tx-approve

This is the core SEP-8 endpoint used to validate and process regulated assets transactions. Its response will contain one of the following statuses: Success, Revised, Action Required, or Rejected.

Note: The example responses below have set their base-url env var configured to "https://example.com".

Request:

{
  "tx": "AAAAAgAAAAA0Nk3++mfFw4Is6OaUJTKe71XNtxdktcjGrPildK84xAAAJxAAAJ3YAAAABwAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAQAAAAARllVv+K58Rbwzc/2Ti1IsisLC03udNJblQx2sPLfDygAAAAJNWVVTRAAAAAAAAAAAAAAAqjdTmDnuZm4YrIZ3wQVmVXmWSMO4dLk5dOPzUjWDvIgAAAABKp6IgAAAAAAAAAABdK84xAAAAEACHShDhulyTyvFx9lCU2LjAN9P7g6XqZJ6aNKo/NFb+9awp4pE5soK5cTtahhVzx9RsUcH+FSRmOPu4YEqqBsK"
}

Responses:

Success: means the transaction has been approved and signed by the issuer without being revised. For more info read the SEP-8 Success section.

{
  "status": "success",
  "message": "Transaction is compliant and signed by the issuer.",
  "tx": "AAAAAgAAAAA0Nk3++mfFw4Is6OaUJTKe71XNtxdktcjGrPildK84xAAABdwAAJ3YAAAABwAAAAEAAAAAAAAAAAAAAABgXdapAAAAAAAAAAUAAAABAAAAAKo3U5g57mZuGKyGd8EFZlV5lkjDuHS5OXTj81I1g7yIAAAABwAAAAA0Nk3++mfFw4Is6OaUJTKe71XNtxdktcjGrPildK84xAAAAAJNWVVTRAAAAAAAAAAAAAABAAAAAQAAAACqN1OYOe5mbhishnfBBWZVeZZIw7h0uTl04/NSNYO8iAAAAAcAAAAAEZZVb/iufEW8M3P9k4tSLIrCwtN7nTSW5UMdrDy3w8oAAAACTVlVU0QAAAAAAAAAAAAAAQAAAAAAAAABAAAAABGWVW/4rnxFvDNz/ZOLUiyKwsLTe500luVDHaw8t8PKAAAAAk1ZVVNEAAAAAAAAAAAAAACqN1OYOe5mbhishnfBBWZVeZZIw7h0uTl04/NSNYO8iAAAAAEqnoiAAAAAAQAAAACqN1OYOe5mbhishnfBBWZVeZZIw7h0uTl04/NSNYO8iAAAAAcAAAAAEZZVb/iufEW8M3P9k4tSLIrCwtN7nTSW5UMdrDy3w8oAAAACTVlVU0QAAAAAAAAAAAAAAAAAAAEAAAAAqjdTmDnuZm4YrIZ3wQVmVXmWSMO4dLk5dOPzUjWDvIgAAAAHAAAAADQ2Tf76Z8XDgizo5pQlMp7vVc23F2S1yMas+KV0rzjEAAAAAk1ZVVNEAAAAAAAAAAAAAAAAAAAAAAAAATWDvIgAAABAxXindTDbKTpw9B+1aUdTOTE6CUF610A0ZL+ofBVSlcvHYadc3LfO/L4/V22h2FyHNt2ALwncmlEq+3hpojZDDQ=="
}

Revised: this response means the transaction was revised to be made compliant, and signed by the issuer. For more info read the SEP-8 Revised section.

{
  "status": "revised",
  "message": "Authorization and deauthorization operations were added.",
  "tx": "AAAAAgAAAAA0Nk3++mfFw4Is6OaUJTKe71XNtxdktcjGrPildK84xAAABdwAAJ3YAAAABwAAAAEAAAAAAAAAAAAAAABgXdapAAAAAAAAAAUAAAABAAAAAKo3U5g57mZuGKyGd8EFZlV5lkjDuHS5OXTj81I1g7yIAAAABwAAAAA0Nk3++mfFw4Is6OaUJTKe71XNtxdktcjGrPildK84xAAAAAJNWVVTRAAAAAAAAAAAAAABAAAAAQAAAACqN1OYOe5mbhishnfBBWZVeZZIw7h0uTl04/NSNYO8iAAAAAcAAAAAEZZVb/iufEW8M3P9k4tSLIrCwtN7nTSW5UMdrDy3w8oAAAACTVlVU0QAAAAAAAAAAAAAAQAAAAAAAAABAAAAABGWVW/4rnxFvDNz/ZOLUiyKwsLTe500luVDHaw8t8PKAAAAAk1ZVVNEAAAAAAAAAAAAAACqN1OYOe5mbhishnfBBWZVeZZIw7h0uTl04/NSNYO8iAAAAAEqnoiAAAAAAQAAAACqN1OYOe5mbhishnfBBWZVeZZIw7h0uTl04/NSNYO8iAAAAAcAAAAAEZZVb/iufEW8M3P9k4tSLIrCwtN7nTSW5UMdrDy3w8oAAAACTVlVU0QAAAAAAAAAAAAAAAAAAAEAAAAAqjdTmDnuZm4YrIZ3wQVmVXmWSMO4dLk5dOPzUjWDvIgAAAAHAAAAADQ2Tf76Z8XDgizo5pQlMp7vVc23F2S1yMas+KV0rzjEAAAAAk1ZVVNEAAAAAAAAAAAAAAAAAAAAAAAAATWDvIgAAABAxXindTDbKTpw9B+1aUdTOTE6CUF610A0ZL+ofBVSlcvHYadc3LfO/L4/V22h2FyHNt2ALwncmlEq+3hpojZDDQ=="
}

Rejected: this response means the transaction is not and couldn't be made compliant. For more info read the SEP-8 Rejected section.

{
  "status": "rejected",
  "error": "There is one or more unauthorized operations in the provided transaction."
}

Action Required: this response means the user must complete an action before this transaction can be approved. The approval server will provide a URL that facilitates the action. Upon completion, the user can resubmit the transaction. For more info read the SEP-8 Action Required section.

{
  "status": "action_required",
  "message": "Payments exceeding 500.00 GOAT needs KYC approval. Please provide an email address.",
  "action_url": "https://example.com/kyc-status/cf4fe081-5b38-48b6-86ed-1bcfb7171c7d",
  "action_method": "POST",
  "action_fields": [
    "email_address"
  ]
}

Pending: this response means the user KYC could not be verified as approved nor rejected and was marked as "pending". As an arbitrary rule, this server is marking as "pending" all accounts whose email starts with "y". For more info read the SEP-8 Pending section.

{
  "status": "pending",
  "error": "Your account could not be verified as approved nor rejected and was marked as pending. You will need staff authorization for operations above 500.00 GOAT."
}

POST /kyc-status/{CALLBACK_ID}

This endpoint is used for the extra action after /tx-approve, as described in the SEP-8 Action Required section.

Currently an arbitrary criteria is implemented:

• email addresses starting with "x" will have the KYC automatically denied.
• email addresses starting with "y" will have their KYC marked as pending.
• all other emails will be accepted.

Note: you'll need to resubmit your transaction to /tx_approve in order to verify if your KYC was approved.

Request:

{
  "email_address": "foo@bar.com"
}

Response:

{
  "result": "no_further_action_required",
}

After the user has been approved or rejected they can POST their transaction to POST /tx-approve for revision.

If their KYC was rejected they should see a rejection response. Response (rejected for emails starting with "x"):

{
  "status": "rejected",
  "error": "Your KYC was rejected and you're not authorized for operations above 500.00 GOAT."
}

If their KYC was marked as pending they should see a pending response. Response (pending for emails starting with "y"):

{
  "status": "pending",
  "error": "Your account could not be verified as approved nor rejected and was marked as pending. You will need staff authorization for operations above 500.00 GOAT."
}

GET /kyc-status/{DIGITALBITS_ADDRESS_OR_CALLBACK_ID}

Returns the detail of an account that requested KYC, as well some metadata about its status.

Note: This functionality is for test/debugging purposes and it's not part of the SEP-8 spec.

Response (pending KYC submission):

{
  "digitalbits_address": "GA2DMTP67JT4LQ4CFTUONFBFGKPO6VONW4LWJNOIY2WPRJLUV44MJZOK",
  "callback_id":"e0d9243a-40cf-4baa-9575-913e6c98a12e",
  "created_at": "2021-03-26T09:35:06.907293-03:00",
}

Response (approved KYC):

{
  "digitalbits_address": "GA2DMTP67JT4LQ4CFTUONFBFGKPO6VONW4LWJNOIY2WPRJLUV44MJZOK",
  "callback_id":"e0d9243a-40cf-4baa-9575-913e6c98a12e",
  "email_address": "test@test.com",
  "created_at": "2021-03-26T09:35:06.907293-03:00",
  "kyc_submitted_at": "2021-03-26T14:03:43.314334-03:00",
  "approved_at": "2021-03-26T14:03:43.314334-03:00",
}

Response (rejected KYC):

{
  "digitalbits_address": "GA2DMTP67JT4LQ4CFTUONFBFGKPO6VONW4LWJNOIY2WPRJLUV44MJZOK",
  "callback_id":"e0d9243a-40cf-4baa-9575-913e6c98a12e",
  "email_address": "xtest@test.com",
  "created_at": "2021-03-26T09:35:06.907293-03:00",
  "kyc_submitted_at": "2021-03-26T14:03:43.314334-03:00",
  "rejected_at": "2021-03-26T14:03:43.314334-03:00",
}

Response (pending KYC):

{
  "digitalbits_address": "GA2DMTP67JT4LQ4CFTUONFBFGKPO6VONW4LWJNOIY2WPRJLUV44MJZOK",
  "callback_id":"e0d9243a-40cf-4baa-9575-913e6c98a12e",
  "email_address": "ytest@test.com",
  "created_at": "2021-03-26T09:35:06.907293-03:00",
  "kyc_submitted_at": "2021-03-26T14:03:43.314334-03:00",
  "pending_at": "2021-03-26T14:03:43.314334-03:00",
}

DELETE /kyc-status/{DIGITALBITS_ADDRESS}

Deletes a digitalbits account from the list of KYCs. If the digitalbits address is not in the database to be deleted the server will return with a 404 - Not Found.

Note: This functionality is for test/debugging purposes and it's not part of the SEP-8 spec.

Response:

{
  "message": "ok"
}