Saltar al contenido principal
Versión: 3,0

Configuración

Para habilitar depósitos y retiradas SEP-6, la Anchor Platform debe configurarse para hacer lo siguiente:

  • Proporciona las URLs de servicio necesarias para los endpoints SEP-6, 12 y 38 en el archivo stellar.toml
  • Proporciona información sobre los activos en cadena y fuera de cadena, así como los medios de pago admitidos por tu negocio a través de los endpoints /info de SEP-6 y SEP-38
  • Admite los endpoints y callbacks necesarios para solicitar información KYC y proporcionar tasas de cambio

Habilitar Depósitos y Retiradas Programáticas​

Agrega las siguientes variables a tu archivo de entorno.

# dev.env
SEP6_ENABLED=true
SEP12_ENABLED=true
SEP38_ENABLED=true

Modificar un Archivo de Información Stellar​

Vamos a modificar el archivo stellar.toml creado anteriormente. Las billeteras necesitan saber que la funcionalidad SEP-6 es admitida por tu negocio, y también necesitan conocer todos los activos Stellar que admites.

# dev.stellar.toml
ACCOUNTS = ["add your public keys for your distribution accounts here"]
SIGNING_KEY = "add your signing key here"
NETWORK_PASSPHRASE = "Test SDF Network ; September 2015"

TRANSFER_SERVER = "http://localhost:8080/sep6"
WEB_AUTH_ENDPOINT = "http://localhost:8080/auth"
KYC_SERVER = "http://localhost:8080/sep12"
ANCHOR_QUOTE_SERVER = "http://localhost:8080/sep38"

# Add support for USDC
[[CURRENCIES]]
code = "USDC"
issuer = "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
status = "test"
is_asset_anchored = false
desc = "USD Coin issued by Circle"

[DOCUMENTATION]
ORG_NAME = "Your organization"
ORG_URL = "Your website"
ORG_DESCRIPTION = "A description of your organization"

Ten en cuenta que necesitarás crear otro archivo para tu despliegue de producción que use la frase de paso de la red pública, tus URLs de servicio de producción, tus cuentas de distribución de Mainnet y clave de firma, así como las cuentas emisoras de Mainnet de los activos que tu servicio utiliza.

Modificar el Archivo de Configuración de Activos​

Ahora estás listo para especificar lo siguiente en tu archivo dev.assets.yaml, y cambiar los valores dependiendo de tu caso de uso. Este archivo de activos de ejemplo habilita el soporte para el USDC de Circle y un fiat USD para depositar y retirar.

Los métodos especificados en las secciones sep38 son métodos que serán expuestos por el endpoint SEP-38 GET /info.

Los métodos especificados en las secciones deposit y withdraw son los métodos que serán expuestos por el endpoint SEP-6 GET /info. Los métodos listados deben igualar los métodos definidos en la sección SEP-38 del archivo.

También ten en cuenta que los activos fiat, aquellos con schema: iso4217, no necesitan los objetos de configuración sep6_enabled, deposit o withdraw especificados. De la misma manera, los activos Stellar, aquellos con schema: stellar, no necesitan los objetos de configuración sep38.sell_delivery_methods o sep38.buy_delivery_methods especificados.

items:
  - id: stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5
    distribution_account: GBLSAHONJRODSFTLOV225NZR4LHICH63RIFQTQN37L5CRTR2IMQ5UEK7
    significant_decimals: 2
    sep6:
      enabled: true
      deposit:
        enabled: true
        min_amount: 0
        max_amount: 10
        methods:
          - ACH
      withdraw:
        enabled: true
        min_amount: 0
        max_amount: 10
        methods:
          - ACH
    sep38:
      enabled: true
      exchangeable_assets:
        - iso4217:USD
  - id: iso4217:USD
    significant_decimals: 2
    sep38_enabled: true
    sep38:
      exchangeable_assets:
        - stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5
      buy_delivery_methods:
        - name: ACH
          description: ACH debits for US bank accounts
      sell_delivery_methods:
        - name: ACH
          description: ACH credit for US bank accounts

Gestionar Cuentas de Distribución​

Ten en cuenta que el ejemplo anterior lista un atributo distribution_account para la entrada USDC. Si se especifica, esta cuenta se proporcionará junto con un memo generado aleatoriamente y único por transacción a los clientes como la dirección a la que enviar fondos para transacciones de retirada de fondos. El memo de la transacción es cómo tú o la Anchor Platform igualarán los fondos recibidos con un registro de transacción en la base de datos de la Anchor Platform.

Si no tienes tu propia cuenta Stellar y en su lugar utilizas un tercero que te proporciona una cuenta Stellar y memo para que puedan recibir fondos en tu nombre, como un exchange o custodio, deberías omitir el campo distribution_account de tu archivo de configuración de activos. En su lugar, necesitarás proporcionar la cuenta Stellar y el memo que deseas usar para recibir fondos a través de una solicitud a la Anchor Platform request_onchain_funds en una base por transacción.

Para configurar la Anchor Platform para esperar que la cuenta Stellar y el memo sean proporcionados a través de API en lugar de configurados a través del archivo de activos, especifica la siguiente variable de entorno.

# dev.env
SEP6_DEPOSIT_INFO_GENERATOR_TYPE=none

Si usas un proveedor de billetera admitido por el servicio de custodia de la Anchor Platform, como Fireblocks, también puedes configurar la Anchor Platform para conectarse directamente a tu proveedor de billetera para obtener tus cuentas de distribución y memos. Si esto está configurado, la Anchor Platform también utilizará el proveedor de billetera para enviar fondos a los clientes. Consulta la sección [servicios de custodia] para obtener más información sobre cómo configurar esta función, pero primero necesitarás especificar un valor diferente para la variable de entorno mencionada anteriormente.

# dev.env
SEP6_DEPOSIT_INFO_GENERATOR_TYPE=custody

Habilitar Callbacks al Servidor Business​

Los negocios necesitan recolectar y validar información KYC sobre los clientes para los que están facilitando transacciones. Los clientes preguntan a tu negocio qué información KYC necesita ser recolectada y envían esa información a través de la API KYC SEP-12 hospedada por la Anchor Platform, pero la Anchor Platform nunca almacena información de identificación personal (PII). En su lugar, reenvía las solicitudes de los clientes al servidor business y devuelve las respuestas del negocio a los clientes, actuando como un servidor proxy.

Adicionalmente, los negocios necesitan proporcionar a los clientes una API Tasas para comprobar las tasas de cambio que están ofreciendo entre los activos en cadena y fuera de cadena admitidos por el negocio. Si la tasa es competitiva, los clientes también deben poder solicitar un compromiso a la tasa actualmente ofrecida por el negocio durante un corto período de tiempo. De manera similar a la API KYC, la Anchor Platform realiza solicitudes a tu servidor business para obtener tasas de cambio y cotizaciones y se las devuelve a los clientes.

Para habilitar estas solicitudes a tu servidor business, primero necesitas agregar tu servidor business al archivo docker compose. Luego, para admitir solicitudes a tu servidor business desde la Anchor Platform, necesitas habilitar callbacks.

# dev.env
CALLBACK_API_BASE_URL=http://business-server:3000/callbacks
CALLBACK_API_AUTH_TYPE=jwt
CALLBACK_API_AUTH_JWT_EXPIRATION_MILLISECONDS=30000
CALLBACK_API_AUTH_JWT_HTTP_HEADER=Authorization
SECRET_CALLBACK_API_AUTH_SECRET="a secret used to sign JWTs"

Lo anterior le dice a la Anchor Platform que incluya un JWT, firmado con el secreto configurado, en el encabezado Authorization de las solicitudes realizadas a /callbacks/<callback endpoint> para que tu servidor pueda autenticar la Anchor Platform antes de procesar solicitudes.

Consulta la API KYC y la API Tasas para obtener detalles sobre los endpoints que deben implementarse en tu servidor business.

Configuración Adicional Opcional​

more_info_url es una URL opcional proporcionada por tu servidor business para que las aplicaciones de billetera muestren información sobre transacciones iniciadas previamente. Esta URL se utiliza normalmente por las billeteras en sus vistas de historial de transacciones, y tu negocio puede especificar la información que se mostrará sobre la transacción.

# dev.env
SEP6_MORE_INFO_URL_BASE_URL=http://example.com
SECRET_SEP6_MORE_INFO_URL_JWT_SECRET="your encryption key shared with your business server"

Los negocios pueden establecer un plazo para las acciones del usuario en las transacciones utilizando el campo user_action_required_by. Para ejemplos, consulta Métodos JSON-RPC. Además, el parámetro initial_user_deadline_seconds establece un tiempo predeterminado (en segundos) que un usuario tiene para actuar antes de que la transacción pase al estado EXPIRED.

# dev.env
SEP6_INITIAL_USER_DEADLINE_SECONDS=1209600

Probar con la Billetera Demostrativa​

¡Las billeteras ahora deberían ser capaces de descubrir, autenticar e iniciar transacciones con tu servicio! Tu proyecto y archivos fuente deberían verse ahora algo así.

├── dev.env
├── docker-compose.yaml
├── config
│   ├── dev.assets.yaml
│   ├── dev.stellar.toml

Tu entorno debería verse ahora algo como lo siguiente.

# dev.env
ASSETS_TYPE=file
ASSETS_VALUE=/home/dev.assets.yaml

SEP1_ENABLED=true
SEP1_TOML_TYPE=file
SEP1_TOML_VALUE=/home/dev.stellar.toml

SEP6_ENABLED=true
SEP6_DEPOSIT_INFO_GENERATOR_TYPE=none
SEP6_MORE_INFO_URL_BASE_URL=http://example.com
SECRET_SEP6_MORE_INFO_URL_JWT_SECRET="your encryption key shared with your business server"

SEP10_ENABLED=true
SEP10_HOME_DOMAIN=localhost:8080
SECRET_SEP10_SIGNING_SEED="a Stellar private key"
SECRET_SEP10_JWT_SECRET="a secret used to sign JWTs"

SEP12_ENABLED=true

SEP38_ENABLED=true

CALLBACK_API_BASE_URL=http://business-server:3000/callbacks
CALLBACK_API_AUTH_TYPE=jwt
CALLBACK_API_AUTH_JWT_EXPIRATION_MILLISECONDS=30000
CALLBACK_API_AUTH_JWT_HTTP_HEADER=Authorization
SECRET_CALLBACK_API_AUTH_SECRET="a secret used to sign JWTs"

Para probar esto, ve a la Billetera Demostrativa Stellar.

Inicia una transacción de depósito haciendo lo siguiente:

  • Crear un nuevo keypair
  • Haz clic en el botón "Agregar Activo" e ingresa
    • el código del activo Stellar en tu archivo stellar.toml
    • tu dominio principal, localhost:8080
  • Selecciona el desplegable y haz clic en "Depósito SEP-6", luego haz clic en "Iniciar"

La billetera de demostración debería poder encontrar tu archivo stellar.toml, autenticar utilizando el keypair Stellar que acabas de crear, e iniciar una transacción.