Skip to content

Latest commit

 

History

History
318 lines (250 loc) · 15.5 KB

File metadata and controls

318 lines (250 loc) · 15.5 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

Unreleased

Place unreleased changes here.

Release of the Stellar Disbursement Platform v3.0.0. In this release, receiver registration does not need to be done exclusively through SMS as it now supports new types. The options are PHONE_NUMBER, EMAIL, EMAIL_AND_WALLET_ADDRESS, and PHONE_NUMBER_AND_WALLET_ADDRESS. If a receiver is registered with a wallet address, they can receive the payment right away without having to go through the SEP-24 registration flow.

[!Warning] This version is only compatible with the stellar/stellar-disbursement-platform-backend version 3.0.0.

Added

  • Display the user email in the "Team Members" section #131
  • Ability to register receivers using email addresses:
    • Support receiver contact info for both phone number and email #150
    • Add email column to the CSV template #141
    • Rename fields for receiver invitation templates and intervals to be channel agnostic #147
    • Update organization SMS retry configuration to reflect both email and SMS #148
  • Ability to register receivers with a Stellar wallet address directly by providing contact info and a wallet address. Options include PHONE_NUMBER_AND_WALLET_ADDRESS and EMAIL_AND_WALLET_ADDRESS:
    • Support multiple registration types for receivers: PHONE_NUMBER, EMAIL, PHONE_NUMBER_AND_WALLET_ADDRESS, EMAIL_AND_WALLET_ADDRESS #176
    • Make receiver verifications optional #178
    • Update GET /wallets with the ?user_managed={boolean} query param #179
    • Update the "Download template CSV" button to return a template based on the receiver registration and verification types selected during disbursement creation #185
    • Polish flow when creating a disbursement targeting wallet addresses #186

Changed

  • Dropdowns in disbursement creation now follow inter-dependency logic based on registration types #177

Fixed

  • Remove draft payments from remaining payments count when calculating the percentage of successful payments #132
  • Prevent selection of an asset without a trustline or balance #134
  • Disable "Org Name" input when in single-tenant mode #135
  • Correct calculation for success payments percentage on the home page #167
  • Calculate balance after CSV re-upload on the draft disbursement screen #190

Security and Dependencies

  • Bump the all-docker group #122
  • Bump the all-actions group #123
  • Update docker/build-push-action from 6.5.0 to 6.7.0 in the all-actions group #136
  • Upgrade elliptic from 6.5.4 to 6.5.7 in the npm_and_yarn group #142

Release of the Stellar Disbursement Platform v2.1.0. This release introduces the option to set different distribution account signers per tenant, as well as Circle support, so the tenant can choose to run their payments through the Circle API rather than directly on the Stellar network.

[!Warning] This version is only compatible with the stellar/stellar-disbursement-platform-backend version 2.1.0.

Added

  • Implement support for Circle distribution accounts #114, #119.
    • When the account is of type Circle and it's status is not Active, a banner is displayed to direct the user through the Circle setup.
    • A new flow was added to allow the user to set up the Circle account.
    • When the account is of type Circle, balances are fetched from the SDP backend rather than the Stellar network.
    • The payment details page now shows the Circle transaction ID, when available.
  • Support the new verification type YEAR_MONTH #121
  • Added dependabot extra features #118

Fix

  • Update some fields usage to optional, since they may not be present on the payload comming from the backend #120

Security

  • Update the ws and braces dependencies to fix security vulnerabilities. #117

Added

Release of the Stellar Disbursement Platform v2.0.0. This release introduces multi-tenancy support, allowing multiple tenants (organizations) to use the platform simultaneously.

Each organization has its own set of users, receivers, disbursements, etc.

[!Warning] This version is only compatible with the stellar/stellar-disbursement-platform-backend version 2.x.x. In order to migrate from 1.x.x to 2.x.x, please consult the SDP Migration Guide.

Added

  • Make the dashboard tenant aware #44
  • Add Organization (Tenant Name) selection text box to Login, Reset Password and Forgot Password pages #50
  • Derive Organization (Tenant Name) from the hostname prefix when possible #56
  • Add Future Balance label in the Disbursement Details page. #76
  • Ability for users to add/update verification info for receivers. #78

Attention, this version is compatible with the backend version 1.1.6.

Added

  • Add the "Future Balance" label in the disbursement detail component to display what will be balance for the asset on the distribution account after the disbursement is completed. #76
  • Add option to update a receiver's verification info from the receiver's detail page. #78

Changed

  • Update the CSV template by adding examples with and without the paymentID (optional) column. #77
  • Display the entire disbursement account address for the tenant when that disbursement account does not exist in the network, making it easier to identify the account that needs to be funded. #80

Fixed

  • Retry payment button was not showing up on failed payments #72.

Added

  • Add dropdown for choosing verification type when creating new disbursements #53
  • Display external payment ID on payments details page #59
  • Add a cancel button to payments details page #60
  • Add env variable injection to dashboard #62
  • Add SMS preview & editing before sending a new disbursement #66
  • Display Created By and Started By on disbursement details page #68

Changed

  • State Refactors
    • receiver payments, wallet balance, wallet history #34
    • users #36
    • wallet providers #37
    • countries #42
  • Automatic cancellation of payments in READY status after a certain time period #38

Chores

  • Optimize refresh token for dispatch actions #39
  • Analytics cards: adjust layout #47
  • Updated favicons and README #64
  • Business user role should receive permission to view details for individual payments, details, and receivers #63
  • Standardize errors with extras #61
  • Update SDS package #58
  • Show error details upon sign-in #57

Fixed

  • Fix input entry for Payments cancellation and SMS retry #43
  • Fix table overflow crop #55

Added

  • Add a new screen to manage Wallet Providers. #14
  • Add re-send SMS invitation functionality. #18
  • Customize receiver wallet invite SMS message. #17
  • Display asset issuer for Trustlines in the Distribution account screen #20
  • Settings: configure SMS retry interval #28

Changed

  • Change payment status history sort order to descending order. #15
  • Filter assets based on wallet selection in New Disbursement screen. #24
  • Only show enabled wallets in the New Disbursement screen. #29

Security

  • Add warning message about Distribution account funds #11

Added

  • Support for a 2-step approval for the disbursement, where one user creates the disbursement and another approves it. #1, #3
  • Support to edit receivers. #5
  • Support for changing the password without resorting to the "fogot password" flow. #6

Changed

  • Readme instructions. #2

Added

First Release Candidate of the Stellar Disbursement Platform, a tool used to make bulk payments to a list of recipients based on their phone number and a confirmation date. This repository is frontend-only, is a client to the backend version available at stellar/stellar-disbursement-platform-backend. Their version numbers are meant to be kept in sync.

The basic process of this product starts with an organization supplying a CSV file which includes the recipients' phone number, transfer amount, and essential customer validation data such as the date of birth.

The platform subsequently sends an SMS to the recipient, which includes a deep link to the wallet. This link permits recipients with compatible wallets to register their wallet on the SDP. During this step, they are required to verify their phone number and additional customer data through the SEP-24 interactive deposit flow, where this data is shared directly with the backend through a webpage inside the wallet, but the wallet itself does not have access to this data.

Upon successful verification, the SDP backend will transfer the funds directly to the recipient's wallet. When the recipient's wallet has been successfully associated with their phone number in the SDP, all subsequent payments will occur automatically.