Merge pull request #163 from ardriveapp/alpha

chore: release v1.15.0
ardriveapp · Sep 12, 2024 · d90d6ed · d90d6ed
2 parents f2e776a + 02b6c84
commit d90d6ed
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 13 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ardrive/turbo-sdk",
-  "version": "1.14.1",
+  "version": "1.15.0-alpha.2",
   "main": "./lib/cjs/node/index.js",
   "types": "./lib/types/node/index.d.ts",
   "module": "./lib/esm/node/index.js",

diff --git a/src/common/payment.ts b/src/common/payment.ts
@@ -127,10 +127,15 @@ export class TurboUnauthenticatedPaymentService
 
   public getWincForFiat({
     amount,
+    promoCodes = [],
+    nativeAddress = 'placeholder', // For price checks we only check promo code eligibility, a placeholder can be used
   }: TurboWincForFiatParams): Promise<TurboWincForFiatResponse> {
-    const { amount: paymentAmount, type: currencyType } = amount;
     return this.httpService.get<TurboWincForFiatResponse>({
-      endpoint: `/price/${currencyType}/${paymentAmount}`,
+      endpoint: `/price/${amount.type}/${
+        amount.amount
+      }?destinationAddress=${nativeAddress}&${this.appendPromoCodesToQuery(
+        promoCodes,
+      )}`,
     });
   }
 
@@ -156,7 +161,7 @@ export class TurboUnauthenticatedPaymentService
         : ''
     }&token=${this.token}`;
 
-    const { adjustments, paymentSession, topUpQuote } =
+    const { adjustments, paymentSession, topUpQuote, fees } =
       await this.httpService.get<TopUpRawResponse>({
         endpoint,
         headers,
@@ -165,10 +170,13 @@ export class TurboUnauthenticatedPaymentService
     return {
       winc: topUpQuote.winstonCreditAmount,
       adjustments,
+      fees,
       url: paymentSession.url ?? undefined,
       id: paymentSession.id,
       client_secret: paymentSession.client_secret ?? undefined,
+      /** @deprecated -- backfilled for backwards compatibility, use actualPaymentAmount */
       paymentAmount: topUpQuote.paymentAmount,
+      actualPaymentAmount: topUpQuote.paymentAmount,
       quotedPaymentAmount: topUpQuote.quotedPaymentAmount,
     };
   }
@@ -252,11 +260,10 @@ export class TurboAuthenticatedPaymentService
     amount,
     promoCodes = [],
   }: TurboWincForFiatParams): Promise<TurboWincForFiatResponse> {
-    return this.httpService.get<TurboWincForFiatResponse>({
-      endpoint: `/price/${amount.type}/${
-        amount.amount
-      }?${this.appendPromoCodesToQuery(promoCodes)}`,
-      headers: await this.signer.generateSignedRequestHeaders(),
+    return super.getWincForFiat({
+      amount,
+      promoCodes,
+      nativeAddress: await this.signer.getNativeAddress(),
     });
   }
 

diff --git a/src/types.ts b/src/types.ts
@@ -76,15 +76,17 @@ export type CurrencyLimit = {
 export type TurboPriceResponse = {
   winc: string; // TODO: the service returns BigNumbers as strings
   adjustments: Adjustment[];
+  fees: Adjustment[];
 };
 
 export type TurboWincForFiatResponse = TurboPriceResponse & {
-  paymentAmount: number;
+  actualPaymentAmount: number;
   quotedPaymentAmount: number;
 };
 
 export type TurboWincForFiatParams = {
   amount: CurrencyMap;
+  nativeAddress?: NativeAddress;
   promoCodes?: string[];
 };
 
@@ -96,25 +98,38 @@ export type TurboCheckoutSessionParams = TurboWincForFiatParams & {
 
 export type TopUpRawResponse = {
   topUpQuote: {
+    topUpQuoteId: string;
+    destinationAddressType: string;
     paymentAmount: number;
     quotedPaymentAmount: number;
     winstonCreditAmount: string;
+    destinationAddress: string;
+    currencyType: Currency;
+    quoteExpirationDate: string;
+    paymentProvider: string;
+    adjustments: Adjustment[];
   };
   paymentSession: {
     url: string | null;
     id: string;
     client_secret: string | null;
   };
   adjustments: Adjustment[];
+  fees: Adjustment[];
 };
 
 export type TurboCheckoutSessionResponse = TurboWincForFiatResponse & {
   id: string;
   client_secret?: string;
   url?: string;
+  /** @deprecated use duplicate actualPaymentAmount */
+  paymentAmount: number;
 };
 
-export type TurboBalanceResponse = Omit<TurboPriceResponse, 'adjustments'>;
+export type TurboBalanceResponse = Omit<
+  TurboPriceResponse,
+  'adjustments' | 'fees'
+>;
 
 export type TurboFiatToArResponse = {
   currency: Currency;

diff --git a/src/version.ts b/src/version.ts
@@ -16,4 +16,4 @@
  */
 
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '1.14.1';
+export const version = '1.15.0-alpha.2';
diff --git a/tests/turbo.node.test.ts b/tests/turbo.node.test.ts
@@ -296,11 +296,21 @@ describe('Node environment', () => {
     });
 
     it('getWincForFiat()', async () => {
-      const { winc } = await turbo.getWincForFiat({
+      const {
+        winc,
+        actualPaymentAmount,
+        adjustments,
+        quotedPaymentAmount,
+        fees,
+      } = await turbo.getWincForFiat({
         amount: USD(10), // $10.00 USD
       });
       expect(winc).to.not.be.undefined;
       expect(+winc).to.be.greaterThan(0);
+      expect(actualPaymentAmount).to.equal(1000);
+      expect(quotedPaymentAmount).to.equal(1000);
+      expect(adjustments).to.have.length(0);
+      expect(fees).to.have.length(1);
     });
 
     describe('uploadSignedDataItem()', () => {