Skip to content

Commit

Permalink
Release 2.1.0-rc.1 to develop (#340)
Browse files Browse the repository at this point in the history
### Changes

- Add Changelog
- Update the hardcoded version
- Update the the helm charts
  • Loading branch information
marcelosalloum authored Jun 28, 2024
1 parent ec5a2fd commit edb624e
Show file tree
Hide file tree
Showing 9 changed files with 181 additions and 147 deletions.
1 change: 0 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ SEP10_SIGNING_PRIVATE_KEY=
# Generate a new keypair for the distribution account
DISTRIBUTION_PUBLIC_KEY=
DISTRIBUTION_SEED=
DISTRIBUTION_SIGNER_TYPE=DISTRIBUTION_ACCOUNT_DB
DISTRIBUTION_ACCOUNT_ENCRYPTION_PASSPHRASE=${DISTRIBUTION_SEED}
CHANNEL_ACCOUNT_ENCRYPTION_PASSPHRASE=${DISTRIBUTION_SEED}

Expand Down
53 changes: 47 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,57 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).

None

## [2.0.0](https://github.com/stellar/stellar-disbursement-platform-backend/releases/tag/2.0.0)
## [2.1.0-rc.1](https://github.com/stellar/stellar-disbursement-platform-backend/releases/tag/2.1.0-rc.1) ([diff](https://github.com/stellar/stellar-disbursement-platform-backend/compare/2.0.0...2.1.0-rc.1))

Release of the Stellar Disbursement Platform v2.0.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.

This version is only compatible with the [stellar/stellar-disbursement-platform-frontend] version `2.1.0-rc.1`.

### Changed

- Update the name of the account types used for Distribution Accounts to be more descriptive. [#285](https://github.com/stellar/stellar-disbursement-platform-backend/pull/285), [#311](https://github.com/stellar/stellar-disbursement-platform-backend/pull/311)
- When provisioning a tenant, indicate the Distribution account signer type [#319](https://github.com/stellar/stellar-disbursement-platform-backend/pull/319)
- The DistributionAccountResolver now surfaces the tenant's CircleWalletID for Circle-using tenants [#328](https://github.com/stellar/stellar-disbursement-platform-backend/pull/328)
- Disable asset management calls when the tenant is using Circle [#322](https://github.com/stellar/stellar-disbursement-platform-backend/pull/322)
- Bump version of [github.com/stellar/go](https://github.com/stellar/go) to become compatible with Protocol 21.

### Added

- Add the ability to use different signature types per tenant, allowing for more flexibility in the signature service. [#289](https://github.com/stellar/stellar-disbursement-platform-backend/pull/289)
- Add support to provision tenants with `accountType=DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT` [#330](https://github.com/stellar/stellar-disbursement-platform-backend/pull/330)
- Circle SDK integration for the backend. [#321](https://github.com/stellar/stellar-disbursement-platform-backend/pull/321)
- Implement CircleService on top of the CircleClient, in order to automatically route the calls through the correct tenant based on the tenant value saved in the context [#331](https://github.com/stellar/stellar-disbursement-platform-backend/pull/331)
- Add support for Circle-using tenants when validating the tenant available balance upon disbursement start [#309](https://github.com/stellar/stellar-disbursement-platform-backend/pull/309), [#336](https://github.com/stellar/stellar-disbursement-platform-backend/pull/336)
- Implement [joho/godotenv](https://github.com/joho/godotenv) loader [#324](https://github.com/stellar/stellar-disbursement-platform-backend/pull/324)
- Add support for Circle-using tenants to the `db setup-for-network` CLI command [#327](https://github.com/stellar/stellar-disbursement-platform-backend/pull/327)
- Implement the `GET /balances` endpoint that returns the Circle balance when the tenant is using Circle [#325](https://github.com/stellar/stellar-disbursement-platform-backend/pull/325), [#329](https://github.com/stellar/stellar-disbursement-platform-backend/pull/329)
- Implement the `PATCH /organization/circle-config` endpoint that allows Circle configuration to be updated for Circle-using tenants [#326](https://github.com/stellar/stellar-disbursement-platform-backend/pull/326), [#332](https://github.com/stellar/stellar-disbursement-platform-backend/pull/332), [#334](https://github.com/stellar/stellar-disbursement-platform-backend/pull/334)
- Send Stellar payments through Circle when the tenant uses a CIRCLE distribution account [#333](https://github.com/stellar/stellar-disbursement-platform-backend/pull/333)
- Implement Circle reconciliation through polling [#339](https://github.com/stellar/stellar-disbursement-platform-backend/pull/339)

### Fixed

- Fix SDP helm chart defaults and minimal-values [#323](https://github.com/stellar/stellar-disbursement-platform-backend/pull/323)

### Deprecated

- Deprecated the use of `DISTRIBUTION_SIGNER_TYPE`, since this information is now provided when provisioning a tenant [#319](https://github.com/stellar/stellar-disbursement-platform-backend/pull/319).

## [2.0.0](https://github.com/stellar/stellar-disbursement-platform-backend/releases/tag/2.0.0) ([diff](https://github.com/stellar/stellar-disbursement-platform-backend/compare/1.1.7...2.0.0))

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.

This version is only compatible with the [stellar/stellar-disbursement-platform-frontend] version 2.x.x.
This version is only compatible with the [stellar/stellar-disbursement-platform-frontend] version `2.0.0`.

### Changed

- Support multi-tenant CLI
- Make `add-user` CLI support multi-tenancy [#228](https://github.com/stellar/stellar-disbursement-platform-backend/pull/228)
- Change migrations CLI to run for all tenants [#89](https://github.com/stellar/stellar-disbursement-platform-backend/pull/89)
Expand All @@ -27,10 +67,11 @@ This version is only compatible with the [stellar/stellar-disbursement-platform-
- Tag log entries with tenant metadata [#192](https://github.com/stellar/stellar-disbursement-platform-backend/pull/192)
- Use `DistributionAccountResolver` instead of passing around distribution public key [#212](https://github.com/stellar/stellar-disbursement-platform-backend/pull/212)
- Make provision new tenant an atomic operation [#233](https://github.com/stellar/stellar-disbursement-platform-backend/pull/233)
- Make `ready_payments_cancellation` job multi-tenant [#223] (https://github.com/stellar/stellar-disbursement-platform-backend/pull/223)
- Make `ready_payments_cancellation` job multi-tenant [#223](https://github.com/stellar/stellar-disbursement-platform-backend/pull/223)


### Added

- Tenant Provisioning & Onboarding [#84](https://github.com/stellar/stellar-disbursement-platform-backend/pull/84)
- Tenant Authentication Middleware [#92](https://github.com/stellar/stellar-disbursement-platform-backend/pull/92)
- Multi-tenancy connection pool & data source manager [#86](https://github.com/stellar/stellar-disbursement-platform-backend/pull/86)
Expand All @@ -50,16 +91,15 @@ This version is only compatible with the [stellar/stellar-disbursement-platform-
- Patch incoming TSS events to Anchor platform [#134](https://github.com/stellar/stellar-disbursement-platform-backend/pull/134)
- Update DB structure so that TSS resources can be shared by multiple SDP tenants
- Move all TSS related tables to TSS schema [#141](https://github.com/stellar/stellar-disbursement-platform-backend/pull/141)
- Create TSS schema and migrations CLI command [#136](https://github.com/
stellar/stellar-disbursement-platform-backend/pull/136)
- Create TSS schema and migrations CLI command [#136](https://github.com/stellar/stellar-disbursement-platform-backend/pull/136)
- Refactor migrations commands to support TSS migrations [#123](https://github.com/stellar/stellar-disbursement-platform-backend/pull/123)
- Add host distribution account awareness [#172](https://github.com/stellar/stellar-disbursement-platform-backend/pull/172)
- Wire distribution account to tenant admin table during user provisioning [#198](https://github.com/stellar/stellar-disbursement-platform-backend/pull/198)
- Prepare transaction submission table to reference tenant [#142](https://github.com/stellar/stellar-disbursement-platform-backend/pull/142)
- Kafka message broker support
- Migrate SMS invitation to use message broker from scheduled jobs [#133](https://github.com/stellar/stellar-disbursement-platform-backend/pull/133)
- Publish receiver wallet invitation events at disbursement start [#182](https://github.com/stellar/stellar-disbursement-platform-backend/pull/182)
- Produce payment events to sync back to SDP [#149] (https://github.com/stellar/stellar-disbursement-platform-backend/pull/149)
- Produce payment events to sync back to SDP [#149](https://github.com/stellar/stellar-disbursement-platform-backend/pull/149)
- Produce payment events from SDP to TSS [#159](https://github.com/stellar/stellar-disbursement-platform-backend/pull/159)
- Implement `DistributionAccountDBSignatureClient` [#197](https://github.com/stellar/stellar-disbursement-platform-backend/pull/197)
- Create tenant distribution account during provisioning [#224](https://github.com/stellar/stellar-disbursement-platform-backend/pull/224)
Expand All @@ -68,6 +108,7 @@ This version is only compatible with the [stellar/stellar-disbursement-platform-
- Add script to migrate SDP v1.1.6 to V2.x.x [#267](https://github.com/stellar/stellar-disbursement-platform-backend/pull/267)

### Security

- Admin API authentication/authorization [#201](https://github.com/stellar/stellar-disbursement-platform-backend/pull/201)
- Enable security protocols for Kafka
- SASL auth [#162](https://github.com/stellar/stellar-disbursement-platform-backend/pull/162)
Expand Down
2 changes: 1 addition & 1 deletion cmd/utils/shared_config_options.go
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ func BaseDistributionAccountSignatureClientConfigOptions(opts *signing.Signature
return []*config.ConfigOption{
{
Name: "distribution-account-encryption-passphrase",
Usage: "A Stellar-compliant ed25519 private key used to encrypt/decrypt the in-memory distribution accounts' private keys.",
Usage: "A Stellar-compliant ed25519 private key used to encrypt and decrypt the private keys of tenants' distribution accounts.",
OptType: types.String,
CustomSetValue: SetConfigOptionStellarPrivateKey,
ConfigKey: &opts.DistAccEncryptionPassphrase,
Expand Down
5 changes: 2 additions & 3 deletions dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- [Quick Setup and Deployment](#quick-setup-and-deployment)
- [Docker](#docker)
- [Clone the repository:](#clone-the-repository)
- [Update local dns](#update-local-dns)
- [Update local DNS](#update-local-dns)
- [Automated Stellar Account Creation and .env Configuration](#automated-stellar-account-creation-and-env-configuration)
- [Install Multi-tenant SDP Locally](#install-multi-tenant-sdp-locally)
- [Login to the SDP and send a Disbursement](#login-to-the-sdp-and-send-a-disbursement)
Expand Down Expand Up @@ -66,7 +66,7 @@ scripts/make_env.sh

The script will generate new keypairs with a USDC funded distribution account and create the .env file with the following configuration values. Example:

```
```bash
# Generate a new keypair for SEP-10 signing
SEP10_SIGNING_PUBLIC_KEY=GCRSCJEVHB5JFXNZH3KYQRHSKDX3ZRFMMPKDPNX7AL3JSXJSILTV7DEW
SEP10_SIGNING_PRIVATE_KEY=SBEZHHWE2QPBIKNMVHPE5QD2JUUN2PLYNEHYQZZPQ7GYPYWULDTJ5RZU
Expand All @@ -79,7 +79,6 @@ DISTRIBUTION_SEED=SDDWY3N3DSTR6SNCZTECOW6PNUIPOHDTMLKVWDQUTHLRNIKMAUIT46M6
CHANNEL_ACCOUNT_ENCRYPTION_PASSPHRASE=SDDWY3N3DSTR6SNCZTECOW6PNUIPOHDTMLKVWDQUTHLRNIKMAUIT46M6

# Distribution signer
DISTRIBUTION_SIGNER_TYPE=DISTRIBUTION_ACCOUNT_ENV
DISTRIBUTION_ACCOUNT_ENCRYPTION_PASSPHRASE=SDDWY3N3DSTR6SNCZTECOW6PNUIPOHDTMLKVWDQUTHLRNIKMAUIT46M6
```

Expand Down
6 changes: 3 additions & 3 deletions helmchart/sdp/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
apiVersion: v2
name: stellar-disbursement-platform
description: A Helm chart for the Stellar Disbursement Platform Backend (A.K.A. `sdp`)
version: 2.0.1
appVersion: "2.0.0"
version: "2.1.0-rc.1"
appVersion: "2.1.0-rc.1"
type: application
maintainers:
- name: Stellar Development Foundation
sources:
- https://github.com/stellar/stellar-disbursement-platform-backend
- https://github.com/stellar/stellar-disbursement-platform-frontend
- https://github.com/stellar/helm-charts
- https://github.com/stellar/helm-charts
Loading

0 comments on commit edb624e

Please sign in to comment.