Merge pull request #1877 from brave/virtual-grants

Fix #1654, Fix #1656, Fix #1861: Add support for claiming virtual grants

BraveRewards/BraveRewards.framework/Headers/BATBraveLedger.h

@@ -7,6 +7,7 @@
 #import "ledger.mojom.objc.h"
 #import "BATRewardsNotification.h"
 #import "BATBraveLedgerObserver.h"
+#import "BATPromotionSolution.h"
 
 @class BATBraveAds;
 
@@ -166,23 +167,20 @@ NS_SWIFT_NAME(BraveLedger)
                   completion:(void (^)(BATResult result))completion;
 
 
-#pragma mark - Grants
+#pragma mark - Promotions
 
-@property (nonatomic, readonly) NSArray<BATGrant *> *pendingGrants;
+@property (nonatomic, readonly) NSArray<BATPromotion *> *pendingPromotions;
 
-- (void)fetchAvailableGrantsForLanguage:(NSString *)language
-                              paymentId:(NSString *)paymentId;
+@property (nonatomic, readonly) NSArray<BATPromotion *> *finishedPromotions;
 
-- (void)fetchAvailableGrantsForLanguage:(NSString *)language
-                              paymentId:(NSString *)paymentId
-                             completion:(nullable void (^)(NSArray<BATGrant *> *grants))completion;
+- (void)fetchPromotions:(nullable void (^)(NSArray<BATPromotion *> *grants))completion;
 
-- (void)grantCaptchaForPromotionId:(NSString *)promoID
-                     promotionType:(NSString *)promotionType
-                        completion:(void (^)(NSString *image, NSString *hint))completion;
+- (void)claimPromotion:(NSString *)deviceCheckPublicKey
+            completion:(void (^)(BATResult result, NSString * _Nonnull json))completion;
 
-- (void)solveGrantCaptchWithPromotionId:(NSString *)promotionId
-                               solution:(NSString *)solution;
+- (void)attestPromotion:(NSString *)promotionId
+               solution:(BATPromotionSolution *)solution
+             completion:(nullable void (^)(BATResult result, BATPromotion * _Nullable promotion))completion;
 
 #pragma mark - History
 

BraveRewards/BraveRewards.framework/Headers/BATBraveLedgerObserver.h

@@ -33,11 +33,14 @@ NS_SWIFT_NAME(LedgerObserver)
 
 @property (nonatomic, copy, nullable) void (^publisherListUpdated)();
 
+/// 
+@property (nonatomic, copy, nullable) void (^finishedPromotionsAdded)(NSArray<BATPromotion *> *promotions);
+
 /// Eligable grants were added to the wallet
-@property (nonatomic, copy, nullable) void (^grantsAdded)(NSArray<BATGrant *> *grants);
+@property (nonatomic, copy, nullable) void (^promotionsAdded)(NSArray<BATPromotion *> *promotions);
 
 /// A grant was claimed
-@property (nonatomic, copy, nullable) void (^grantClaimed)(BATGrant *grant);
+@property (nonatomic, copy, nullable) void (^promotionClaimed)(BATPromotion *promotion);
 
 /// A reconcile transaction completed and the user may have an updated balance
 /// and likely an updated balance report

BraveRewards/BraveRewards.framework/Headers/BATPromotionSolution.h

@@ -0,0 +1,23 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// The solution to claiming a promotion on iOS. Obtain the `noonce` through
+/// `[BATBraveLedger claimPromotion:completion:]` method, and obtain the
+/// blob and signature from the users keychain
+NS_SWIFT_NAME(PromotionSolution)
+@interface BATPromotionSolution : NSObject
+
+@property (nonatomic, copy) NSString *noonce;
+@property (nonatomic, copy) NSString *blob;
+@property (nonatomic, copy) NSString *signature;
+
+- (NSString *)JSONPayload;
+
+@end
+
+NS_ASSUME_NONNULL_END

BraveRewards/BraveRewards.framework/Headers/BraveRewards.h

@@ -21,3 +21,4 @@ FOUNDATION_EXPORT const unsigned char BraveRewardsVersionString[];
 #import <BraveRewards/Records.h>
 #import <BraveRewards/ledger.mojom.objc.h>
 #import <BraveRewards/BATRewardsNotification.h>
+#import <BraveRewards/BATPromotionSolution.h>

BraveRewards/BraveRewards.framework/Headers/ledger.mojom.objc.h

@@ -49,7 +49,6 @@ typedef NS_ENUM(NSInteger, BATResult) {
   BATResultRegistrationVerificationFailed = 10,
   BATResultBadRegistrationResponse = 11,
   BATResultWalletCreated = 12,
-  BATResultGrantNotFound = 13,
   BATResultAcTableEmpty = 14,
   BATResultNotEnoughFunds = 15,
   BATResultTipError = 16,
@@ -141,8 +140,39 @@ typedef NS_ENUM(NSInteger, BATEnvironment) {
 } NS_SWIFT_NAME(Environment);
 
 
+typedef NS_ENUM(NSInteger, BATPromotionType) {
+  BATPromotionTypeUgp = 0,
+  BATPromotionTypeAds = 1,
+} NS_SWIFT_NAME(PromotionType);
 
-@class BATContributionInfo, BATPublisherInfo, BATPublisherBanner, BATPendingContribution, BATPendingContributionInfo, BATVisitData, BATGrant, BATWalletProperties, BATBalance, BATAutoContributeProps, BATMediaEventInfo, BATExternalWallet, BATBalanceReportInfo, BATActivityInfoFilterOrderPair, BATActivityInfoFilter, BATReconcileInfo, BATRewardsInternalsInfo, BATServerPublisherInfo, BATTransferFee, BATContributionQueue, BATContributionQueuePublisher;
+
+typedef NS_ENUM(NSInteger, BATPromotionStatus) {
+  BATPromotionStatusActive = 0,
+  BATPromotionStatusAttested = 1,
+  BATPromotionStatusClaimed = 2,
+  BATPromotionStatusSignedTokens = 3,
+  BATPromotionStatusFinished = 4,
+  BATPromotionStatusOver = 5,
+} NS_SWIFT_NAME(PromotionStatus);
+
+
+typedef NS_ENUM(NSInteger, BATPlatform) {
+  BATPlatformDesktop = 0,
+  BATPlatformAndroid = 1,
+  BATPlatformIos = 2,
+} NS_SWIFT_NAME(Platform);
+
+
+typedef NS_ENUM(NSInteger, BATOperatingSystem) {
+  BATOperatingSystemWindows = 0,
+  BATOperatingSystemMacos = 1,
+  BATOperatingSystemLinux = 2,
+  BATOperatingSystemUndefined = 3,
+} NS_SWIFT_NAME(OperatingSystem);
+
+
+
+@class BATContributionInfo, BATPublisherInfo, BATPublisherBanner, BATPendingContribution, BATPendingContributionInfo, BATVisitData, BATWalletProperties, BATBalance, BATAutoContributeProps, BATMediaEventInfo, BATExternalWallet, BATBalanceReportInfo, BATActivityInfoFilterOrderPair, BATActivityInfoFilter, BATReconcileInfo, BATRewardsInternalsInfo, BATServerPublisherInfo, BATTransferFee, BATContributionQueue, BATContributionQueuePublisher, BATPromotion, BATPromotionCreds, BATUnblindedToken, BATClientInfo;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -222,20 +252,10 @@ NS_SWIFT_NAME(VisitData)
 @property (nonatomic, copy) NSString * faviconUrl;
 @end
 
-NS_SWIFT_NAME(Grant)
-@interface BATGrant : NSObject <NSCopying>
-@property (nonatomic, copy) NSString * altcurrency;
-@property (nonatomic, copy) NSString * probi;
-@property (nonatomic, copy) NSString * promotionId;
-@property (nonatomic) uint64_t expiryTime;
-@property (nonatomic, copy) NSString * type;
-@end
-
 NS_SWIFT_NAME(WalletProperties)
 @interface BATWalletProperties : NSObject <NSCopying>
 @property (nonatomic) double feeAmount;
 @property (nonatomic, copy) NSArray<NSNumber *> * parametersChoices;
-@property (nonatomic, copy) NSArray<BATGrant *> * grants;
 @end
 
 NS_SWIFT_NAME(Balance)
@@ -358,4 +378,43 @@ NS_SWIFT_NAME(ContributionQueuePublisher)
 @property (nonatomic) double amountPercent;
 @end
 
+NS_SWIFT_NAME(Promotion)
+@interface BATPromotion : NSObject <NSCopying>
+@property (nonatomic, copy) NSString * id;
+@property (nonatomic) uint32_t version;
+@property (nonatomic) BATPromotionType type;
+@property (nonatomic, copy) NSString * publicKeys;
+@property (nonatomic) uint32_t suggestions;
+@property (nonatomic) double approximateValue;
+@property (nonatomic) bool claimed;
+@property (nonatomic) BATPromotionStatus status;
+@property (nonatomic) uint64_t expiresAt;
+@property (nonatomic, copy, nullable) BATPromotionCreds * credentials;
+@end
+
+NS_SWIFT_NAME(PromotionCreds)
+@interface BATPromotionCreds : NSObject <NSCopying>
+@property (nonatomic, copy) NSString * tokens;
+@property (nonatomic, copy) NSString * blindedCreds;
+@property (nonatomic, copy) NSString * signedCreds;
+@property (nonatomic, copy) NSString * publicKey;
+@property (nonatomic, copy) NSString * batchProof;
+@property (nonatomic, copy) NSString * claimId;
+@end
+
+NS_SWIFT_NAME(UnblindedToken)
+@interface BATUnblindedToken : NSObject <NSCopying>
+@property (nonatomic) uint64_t id;
+@property (nonatomic, copy) NSString * tokenValue;
+@property (nonatomic, copy) NSString * publicKey;
+@property (nonatomic) double value;
+@property (nonatomic, copy) NSString * promotionId;
+@end
+
+NS_SWIFT_NAME(ClientInfo)
+@interface BATClientInfo : NSObject <NSCopying>
+@property (nonatomic) BATPlatform platform;
+@property (nonatomic) BATOperatingSystem os;
+@end
+
 NS_ASSUME_NONNULL_END

BraveRewardsUI/Create Wallet/CreateWalletViewController.swift

@@ -75,7 +75,7 @@ class CreateWalletViewController: UIViewController {
   // MARK: - Actions
 
   func showFailureAlert() {
-    let alertController = UIAlertController(title: Strings.WalletCreationErrorTitle, message: Strings.WalletCreationErrorBody, preferredStyle: .alert)
+    let alertController = UIAlertController(title: Strings.GenericErrorTitle, message: Strings.GenericErrorBody, preferredStyle: .alert)
     alertController.addAction(UIAlertAction(title: Strings.OK, style: .default, handler: nil))
     self.present(alertController, animated: true)
   }

BraveRewardsUI/Extensions/BraveLedgerExtensions.swift

@@ -4,6 +4,9 @@
 
 import Foundation
 import BraveRewards
+import Shared
+
+private let log = Logger.rewardsLogger
 
 extension BraveLedger {
 
@@ -125,6 +128,96 @@ extension BraveLedger {
     }
     return id
   }
+
+  public func setupDeviceCheckEnrollment(_ client: DeviceCheckClient, completion: @escaping () -> Void) {
+    // Enroll in DeviceCheck
+    client.generateToken { [weak self] (token, error) in
+      guard let self = self else { return }
+      if let error = error {
+        log.error("Failed to generate DeviceCheck token: \(error)")
+        completion()
+        return
+      }
+      let paymentId = self.paymentId ?? ""
+      client.generateEnrollment(paymentId: paymentId, token: token) { registration, error in
+        if let error = error {
+          log.error("Failed to enroll in DeviceCheck: \(error)")
+          completion()
+          return
+        }
+        guard let registration = registration else { return }
+        client.registerDevice(enrollment: registration) { error in
+          if let error = error {
+            log.error("Failed to register device with mobile attestation server: \(error)")
+            completion()
+            return
+          }
+        }
+      }
+    }
+  }
+
+  public func claimPromotion(_ promotion: Promotion, completion: @escaping (_ success: Bool) -> Void) {
+    guard let paymentId = self.paymentId else {
+      completion(false)
+      return
+    }
+    let deviceCheck = DeviceCheckClient(environment: BraveLedger.environment)
+    let group = DispatchGroup()
+    if !DeviceCheckClient.isDeviceEnrolled() {
+      group.enter()
+      setupDeviceCheckEnrollment(deviceCheck) {
+        if !DeviceCheckClient.isDeviceEnrolled() {
+          DispatchQueue.main.async {
+            completion(false)
+          }
+          return
+        }
+        group.leave()
+      }
+    }
+    group.notify(queue: .main) {
+      deviceCheck.generateAttestation(paymentId: paymentId) { (attestation, error) in
+        guard let attestation = attestation else {
+          completion(false)
+          return
+        }
+        self.claimPromotion(attestation.publicKeyHash) { result, noonce in
+          if result != .ledgerOk {
+            completion(false)
+            return
+          }
+
+          deviceCheck.generateAttestationVerification(nonce: noonce) { verification, error in
+            guard let verification = verification else {
+              completion(false)
+              return
+            }
+
+            let solution = PromotionSolution()
+            solution.noonce = noonce
+            solution.signature = verification.signature
+            do {
+              solution.blob = try verification.attestationBlob.bsonData().base64EncodedString()
+            } catch {
+              log.error("Couldn't serialize attestation blob. The attest promotion will fail")
+            }
+
+            self.attestPromotion(promotion.id, solution: solution) { result, promotion in
+              if result == .ledgerOk {
+                self.fetchPromotions { _ in
+                  self.fetchBalance({ _ in })
+                  completion(true)
+                }
+              } else {
+                completion(false)
+              }
+            }
+          }
+        }
+      }
+    }
+  }
 }
 
 extension PublisherInfo {

BraveRewardsUI/Grants/GrantsListViewController.swift

@@ -32,19 +32,16 @@ class GrantsListViewController: UIViewController {
     super.viewDidLoad()
 
     title = Strings.Grants
-
-    if let grants = ledger.walletInfo?.grants, !grants.isEmpty {
-      grants.forEach {
-        if let value = BATValue(probi: $0.probi) {
-          let isAd = $0.type == "ads"
-          grantsView.stackView.addArrangedSubview(
-            GrantsItemView(
-              amount: value.displayString,
-              expirationDate: isAd ? nil : Date(timeIntervalSince1970: TimeInterval($0.expiryTime))
-            )
-          )
-        }
-      }
+
+    ledger.finishedPromotions.forEach {
+      let value = BATValue($0.approximateValue)
+      let isAd = $0.type == .ads
+      grantsView.stackView.addArrangedSubview(
+        GrantsItemView(
+          amount: value.displayString,
+          expirationDate: isAd ? nil : Date(timeIntervalSince1970: TimeInterval($0.expiresAt))
+        )
+      )
     }
   }
 }

BraveRewardsUI/Localized Strings/Strings.swift

@@ -251,8 +251,8 @@ internal extension Strings {
   static let NoNetworkBody = NSLocalizedString("NoNetworkBody", bundle: Bundle.RewardsUI, value: "The Brave Rewards server is not responding. We will fix this as soon as possible.", comment: "Body for a no network notification")
   static let MyFirstAdTitle = NSLocalizedString("MyFirstAdTitle", bundle: Bundle.RewardsUI, value: "This is your first Brave ad", comment: "")
   static let MyFirstAdBody = NSLocalizedString("MyFirstAdBody", bundle: Bundle.RewardsUI, value: "Tap here to learn more.", comment: "")
-  static let WalletCreationErrorTitle = NSLocalizedString("WalletCreationErrorTitle", bundle: Bundle.RewardsUI, value: "Error", comment: "")
-  static let WalletCreationErrorBody = NSLocalizedString("WalletCreationErrorBody", bundle: Bundle.RewardsUI, value: "Oops! Something went wrong. Please try again.", comment: "")
+  static let GenericErrorTitle = NSLocalizedString("WalletCreationErrorTitle", bundle: Bundle.RewardsUI, value: "Error", comment: "")
+  static let GenericErrorBody = NSLocalizedString("WalletCreationErrorBody", bundle: Bundle.RewardsUI, value: "Oops! Something went wrong. Please try again.", comment: "")
   static let BATPointsDisclaimer = NSLocalizedString("BATPointsDisclaimer", bundle: Bundle.RewardsUI, value: "BAT Points can be used to contribute to your favorite content creators. BAT Points cannot be exchanged for BAT.", comment: "Disclaimer about BAT Points for JP users")
   static let BATPointsDisclaimerBoldedWords = NSLocalizedString("BATPointsBoldedWords", bundle: Bundle.RewardsUI, value: "BAT Points", comment: "Words that should be bolded in the BAT Points disclaimer")
 }

BraveRewardsUI/README.md

@@ -5,6 +5,6 @@ A UI framework for consuming Brave Rewards. The core logic around BraveRewards r
 The latest BraveRewards.framework was built on:
 
 ```
-brave-browser/373314e05e8e0abe41c21d5aee6314371e4154ad
-brave-core/6544304acdc2641b4e9d6aa02cf711194a64876e
+brave-browser/5d5f18be463abaf9b5f23d5b7ec14be51f7fd412
+brave-core/96b0900380ed89472c8ad2a20e1c6bb728e75573
 ```