react-native-zcash 0.0.2 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-zcash",
-  "version": "0.0.2",
+  "version": "0.2.1",
   "description": "Zcash library for React Native",
   "homepage": "https://github.com/EdgeApp/react-native-zcash",
   "repository": {
@@ -12,25 +12,26 @@
   "contributors": [
     "William Swanson <william@edge.app>",
     "Paul Puey <paul@edge.app>",
-    "Matthew Piché <matthew@edge.app>"
+    "Matthew Piché <matthew@edge.app>",
+    "Kevin Gorham <kevin.gorham@z.cash>"
   ],
   "files": [
     "android/build.gradle",
     "android/src",
     "CHANGELOG.md",
     "react-native-zcash.podspec",
-    "ios/RNZcash.h",
+    "ios/RNZcash.swift",
     "ios/RNZcash.m",
+    "ios/RNZcash-Bridging-Header.h",
     "ios/RNZcash.xcodeproj",
     "ios/RNZcash.xcworkspace",
     "lib",
     "package.json",
     "README.md",
+    "Scripts",
     "src"
   ],
-  "main": "lib/rnzcash.cjs.js",
-  "module": "lib/rnzcash.js",
-  "browser": "lib/rnzcash.web.js",
+  "main": "lib/rnzcash.rn.js",
   "types": "lib/src/index.d.ts",
   "scripts": {
     "fix": "npm run lint -- --fix",
@@ -87,5 +88,7 @@
     "tmp": "^0.2.1",
     "typescript": "^3.9.3"
   },
-  "react-native": "lib/rnzcash.rn.js"
+  "peerDependencies": {
+    "react-native": ">=0.47.0 <1.0.0"
+  }
 }

package/react-native-zcash.podspec

@@ -10,10 +10,13 @@ Pod::Spec.new do |s|
   s.license      = package['license']
   s.authors      = package['author']
 
-  s.platform     = :ios, "8.0"
+  s.swift_version = '5.4'
+  s.platform     = :ios, "12.0"
   s.requires_arc = true
   s.source       = { :git => "https://github.com/EdgeApp/react-native-zcash.git", :tag => "v#{s.version}" }
-  s.source_files = "ios/**/*.{h,m}"
+  s.source_files = "ios/**/*.{h,m,swift}"
+
+ s.dependency "React"
+ s.dependency 'ZcashLightClientKit', '0.13.0-beta.2'
 
-  s.dependency "React"
 end

package/src/react-native.ts

@@ -1,6 +1,21 @@
-import { NativeModules } from 'react-native'
+import {
+  EventSubscription,
+  NativeEventEmitter,
+  NativeModules
+} from 'react-native'
 
-import { InitializerConfig, WalletBalance } from './types'
+import {
+  BlockRange,
+  ConfirmedTransaction,
+  InitializerConfig,
+  Network,
+  PendingTransaction,
+  SpendInfo,
+  SynchronizerCallbacks,
+  SynchronizerStatus,
+  UnifiedViewingKey,
+  WalletBalance
+} from './types'
 
 const { RNZcash } = NativeModules
 
@@ -9,105 +24,215 @@ const snooze: Function = (ms: number) =>
 
 type Callback = (...args: any[]) => any
 
-// export function subscribeToFoo(callback: Callback): void {
-//   const eventEmitter = new NativeEventEmitter(RNZcash)
-//   eventEmitter.addListener('FooEvent', callback)
-// }
-
 export const KeyTool = {
-  deriveViewKey: async (seedBytesHex: string): Promise<string> => {
-    const result = await RNZcash.deriveViewKey(seedBytesHex)
+  deriveViewingKey: async (
+    seedBytesHex: string,
+    network: Network
+  ): Promise<UnifiedViewingKey> => {
+    const result = await RNZcash.deriveViewingKey(seedBytesHex, network)
+    return result
+  },
+  deriveSpendingKey: async (
+    seedBytesHex: string,
+    network: Network
+  ): Promise<string> => {
+    const result = await RNZcash.deriveSpendingKey(seedBytesHex, network)
+    return result
+  }
+}
+
+export const AddressTool = {
+  deriveShieldedAddress: async (
+    viewingKey: string,
+    network: Network
+  ): Promise<string> => {
+    const result = await RNZcash.deriveShieldedAddress(viewingKey, network)
+    return result
+  },
+  isValidShieldedAddress: async (
+    address: string,
+    network: Network = 'mainnet'
+  ): Promise<boolean> => {
+    const result = await RNZcash.isValidShieldedAddress(address, network)
+    return result
+  },
+  isValidTransparentAddress: async (
+    address: string,
+    network: Network = 'mainnet'
+  ): Promise<boolean> => {
+    const result = await RNZcash.isValidTransparentAddress(address, network)
     return result
   }
-  // deriveSpendingKey: async (seedBytesHex: string): Promise<string> => {return ''}
 }
-// const makeAddressTool = () => {
-//   return {
-//     deriveShieldedAddress: async (viewingKey: string): Promise<string> => {return ''},
-//     deriveTransparentAddress: async (viewingKey: string): Promise<string> => {return ''},
-//     isValidShieldedAddress: async (address: string): Promise<boolean> => {return true},
-//     isValidTransparentAddress: async (address: string): Promise<boolean> => {return true}
-//   }
-// }
-//
-// interface WalletBalance {
-//   shieldedAvailable: string
-//   shieldedTotal: string
-//   transparentAvailable: string
-//   transparentTotal: string
-// }
-// interface InitializerCallbacks {
-//   onError: (e: Error): void
-//   onTransactionsChanged: (): void
-//   onBalanceChanged: (walletBalance: WalletBalance): void
-// }
-// interface SpendInfo {
-//   zatoshi: string
-//   toAddress: string
-//   memo: string
-//   fromAccountIndex: number
-//   spendingKey?: string
-// }
-
-// interface ZcashTransaction {
-//   txId: string
-//   fee: string
-//   value: string
-//   direction: 'inbound' | 'outbound'
-//   toAddress: string
-//   memo?: string
-//   minedHeight: number // 0 for unconfirmed
-//   blockTime: number // UNIX timestamp
-// }
-// type PendingTransaction = ZcashTransaction & {
-//   accountIndex: number
-//   expiryHeight: number
-//   cancelled: number
-//   submitAttemps: number
-//   errorMessage?: string
-//   errorCode?: number
-//   createTime: number
-// }
-
-// interface TransactionQuery {
-//   offset?: number
-//   limit?: number
-//   startDate?: number
-//   endDate?: number
-// }
+
 class Synchronizer {
-  constructor(initializerConfig: InitializerConfig) {
-    console.log(initializerConfig)
+  eventEmitter: NativeEventEmitter
+  subscriptions: EventSubscription[]
+  alias: string
+  network: Network
+
+  constructor(alias: string, network: Network) {
+    this.eventEmitter = new NativeEventEmitter(RNZcash)
+    this.subscriptions = []
+    this.alias = alias
+    this.network = network
+  }
+
+  /// ////////////////////////////////////////////////////////////////
+  // Start PoC behavior
+  //     Here are a few functions to demonstrate functionality but the final library should not have these functions
+  //
+  async readyToSend(): Promise<boolean> {
+    const result = await RNZcash.readyToSend()
+    return result
+  }
+
+  async sendTestTransaction(
+    key: string,
+    address: string
+  ): Promise<PendingTransaction> {
+    // send an amount that's guaranteed to be too large for our wallet and expect it to fail but at least show how this is done
+    // simply change these two values to send a real transaction but ensure the function isn't called too often (although funds can't be spent if notes are unconfirmed)
+    const invalidValue = '9223372036854775807' // Max long value (change this to 10000 to send a small transaction equal to the miner's fee on every reload and you could send 10,000 of those before it equals 1 ZEC)
+    const invalidAccount = 99 // should be 0
+    return this.sendToAddress({
+      zatoshi: invalidValue,
+      toAddress: address,
+      memo: 'this is a test transaction that will fail',
+      fromAccountIndex: invalidAccount,
+      spendingKey: key
+    })
+  }
+
+  async getBlockCount(): Promise<number> {
+    const result = await RNZcash.getBlockCount()
+    return result
+  }
+  // End PoC behavior
+  /// ////////////////////////////////////////////////////////////////
+
+  async start(): Promise<String> {
+    const result = await RNZcash.start(this.alias)
+    return result
+  }
+
+  async stop(): Promise<String> {
+    this.unsubscribe()
+    const result = await RNZcash.stop(this.alias)
+    return result
+  }
+
+  async initialize(initializerConfig: InitializerConfig): Promise<void> {
+    await RNZcash.initialize(
+      initializerConfig.fullViewingKey.extfvk,
+      initializerConfig.fullViewingKey.extpub,
+      initializerConfig.birthdayHeight,
+      initializerConfig.alias,
+      initializerConfig.networkName,
+      initializerConfig.defaultHost,
+      initializerConfig.defaultPort
+    )
+  }
+
+  async getLatestNetworkHeight(alias: string): Promise<number> {
+    const result = await RNZcash.getLatestNetworkHeight(alias)
+    return result
+  }
+
+  async getLatestScannedHeight(): Promise<number> {
+    const result = await RNZcash.getLatestScannedHeight()
+    return result
+  }
+
+  async getProgress(): Promise<number> {
+    const result = await RNZcash.getProgress()
+    return result
+  }
+
+  async getStatus(): Promise<SynchronizerStatus> {
+    const result = await RNZcash.getStatus()
+    return SynchronizerStatus[result.name as keyof typeof SynchronizerStatus]
   }
 
-  // static init (initializerConfig: InitializerConfig): void
-  // setCallbackHandlers (callbacks: InitializerCallbacks): void
-  // getLatestHeight (): number
-  // getProgress (): number // 0-1
-  // getStatus (): ??
   async getShieldedBalance(): Promise<WalletBalance> {
-    const result = await RNZcash.getShieldedBalance()
+    const result = await RNZcash.getShieldedBalance(this.alias)
     return result
   }
 
   async getTransparentBalance(): Promise<WalletBalance> {
+    // TODO: integrate with lightwalletd service to provide taddr balance. Edge probably doesn't need this, though so it can wait.
+
     await snooze(0) // Hack to make typescript happy
     return {
-      availableBalance: '0',
-      totalBalance: '0'
+      availableZatoshi: '0',
+      totalZatoshi: '0'
     }
   }
+
+  async getTransactions(range: BlockRange): Promise<ConfirmedTransaction[]> {
+    const result = await RNZcash.getTransactions(
+      this.alias,
+      range.first,
+      range.last
+    )
+    return result
+  }
+
+  rescan(height: number): void {
+    RNZcash.rescan(this.alias, height)
+  }
+
+  async sendToAddress(spendInfo: SpendInfo): Promise<PendingTransaction> {
+    const result = await RNZcash.spendToAddress(
+      this.alias,
+      spendInfo.zatoshi,
+      spendInfo.toAddress,
+      spendInfo.memo,
+      spendInfo.fromAccountIndex,
+      // TODO: ask is it okay to send this across the boundary or should it live on the native side and never leave?
+      spendInfo.spendingKey
+    )
+    return result
+  }
+
   // estimateFee (spendInfo: SpendInfo): string
   // sendToAddress (spendInfo: SpendInfo): void
-  // start (): void
-  // stop (): void
+
   // getPendingTransactions (): PendingTransactions[]
   // getConfirmedTransactions (query: TransactionQuery): ZcashTransaction[]
+
+  // Events
+
+  subscribe({ onStatusChanged, onUpdate }: SynchronizerCallbacks): void {
+    this.setListener('StatusEvent', onStatusChanged)
+    this.setListener('UpdateEvent', onUpdate)
+  }
+
+  private setListener<T>(
+    eventName: string,
+    callback: Callback = (t: any) => null
+  ): void {
+    this.subscriptions.push(
+      this.eventEmitter.addListener(eventName, arg =>
+        arg.alias === this.alias ? callback(arg) : null
+      )
+    )
+  }
+
+  unsubscribe(): void {
+    this.subscriptions.forEach(subscription => {
+      subscription.remove()
+    })
+  }
 }
 
 export const makeSynchronizer = async (
   initializerConfig: InitializerConfig
 ): Promise<Synchronizer> => {
-  await snooze(0) // Hack to make typescript happy
-  return new Synchronizer(initializerConfig)
+  const synchronizer = new Synchronizer(
+    initializerConfig.alias,
+    initializerConfig.networkName
+  )
+  await synchronizer.initialize(initializerConfig)
+  return synchronizer
 }

package/src/types.ts

@@ -1,12 +1,101 @@
+export type Network = 'mainnet' | 'testnet'
+
 export interface WalletBalance {
-  availableBalance: string
-  totalBalance: string
+  availableZatoshi: string
+  totalZatoshi: string
 }
 
 export interface InitializerConfig {
-  host: string
-  port: number
-  fullViewingKey: string
-  // alias: ??
+  networkName: Network
+  defaultHost: string
+  defaultPort: number
+  fullViewingKey: UnifiedViewingKey
+  alias: string
   birthdayHeight: number
 }
+
+export interface SpendInfo {
+  zatoshi: string
+  toAddress: string
+  memo: string
+  fromAccountIndex: number
+  spendingKey?: string
+}
+
+export interface TransactionQuery {
+  offset?: number
+  limit?: number
+  startDate?: number
+  endDate?: number
+}
+
+export interface ZcashTransaction {
+  txId: string
+  accountIndex: number
+  fee: string
+  value: string
+  direction: 'inbound' | 'outbound'
+  toAddress: string
+  memo?: string
+  minedHeight: number // 0 for unconfirmed
+  blockTime: number // UNIX timestamp
+}
+
+export type PendingTransaction = ZcashTransaction & {
+  expiryHeight: number
+  cancelled: number
+  submitAttempts: number
+  errorMessage?: string
+  errorCode?: number
+  createTime: number
+}
+
+export enum SynchronizerStatus {
+  /** Indicates that [stop] has been called on this Synchronizer and it will no longer be used. */
+  STOPPED,
+  /** Indicates that this Synchronizer is disconnected from its lightwalletd server. When set, a UI element may want to turn red. */
+  DISCONNECTED,
+  /** Indicates that this Synchronizer is actively downloading new blocks from the server. */
+  DOWNLOADING,
+  /** Indicates that this Synchronizer is actively validating new blocks that were downloaded from the server. Blocks need to be verified before they are scanned. This confirms that each block is chain-sequential, thereby detecting missing blocks and reorgs. */
+  VALIDATING,
+  /** Indicates that this Synchronizer is actively decrypting new blocks that were downloaded from the server. */
+  SCANNING,
+  /** Indicates that this Synchronizer is actively enhancing newly scanned blocks with additional transaction details, fetched from the server. */
+  ENHANCING,
+  /** Indicates that this Synchronizer is fully up to date and ready for all wallet functions. When set, a UI element may want to turn green. In this state, the balance can be trusted. */
+  SYNCED
+}
+
+export interface UnifiedViewingKey {
+  extfvk: string
+  extpub: string
+}
+
+export interface UpdateEvent {
+  lastDownloadedHeight: number
+  lastScannedHeight: number
+  scanProgress: number // 0 - 100
+  networkBlockHeight: number
+}
+
+export interface SynchronizerCallbacks {
+  onShieldedBalanceChanged(walletBalance: WalletBalance): void
+  onStatusChanged(status: SynchronizerStatus): void
+  onUpdate(event: UpdateEvent): void
+  onTransactionsChanged(count: number): void
+  onPendingTransactionUpdated(tx: PendingTransaction): void
+}
+
+export interface BlockRange {
+  first: number
+  last: number
+}
+
+export interface ConfirmedTransaction {
+  value: string
+  memo?: string
+  minedHeight: number
+  rawTransactionId: string
+  toAddress?: string
+}

package/android/src/main/java/com/reactlibrary/RNZcashModule.java

@@ -1,94 +0,0 @@
-package com.reactlibrary;
-
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.bridge.ReactContext;
-import com.facebook.react.bridge.ReactContextBaseJavaModule;
-import com.facebook.react.bridge.ReactMethod;
-import com.facebook.react.bridge.Callback;
-import com.facebook.react.bridge.Promise;
-import com.facebook.react.bridge.ReactMethod;
-import com.facebook.react.modules.core.DeviceEventManagerModule;
-import com.facebook.react.bridge.WritableMap;
-import com.facebook.react.bridge.Arguments;
-
-
-
-
-public class RNZcashModule extends ReactContextBaseJavaModule {
-  private final ReactApplicationContext reactContext;
-
-  public RNZcashModule(ReactApplicationContext reactContext) {
-    super(reactContext);
-    this.reactContext = reactContext;
-  }
-
-  @Override
-  public String getName() {
-    return "RNZcash";
-  }
-
-  @ReactMethod
-  public void getNumTransactions(
-          Float N,
-          Promise promise) {
-    try {
-//      (new Runnable(){
-//        @Override
-//        public void run() {
-//          WritableMap params = Arguments.createMap();
-//          params.putString("foo", "bar");
-//          try {
-//            Thread.sleep(20000);
-//          }catch(InterruptedException e) {
-//            //do nothing
-//          }
-//          sendEvent(reactContext, "FooEvent", params);
-//        }
-//      }).run();
-        WritableMap params = Arguments.createMap();
-        params.putString("foo", "bar3");
-      sendEvent(reactContext, "FooEvent", params);
-        try {
-            Thread.sleep(20000);
-        }catch(InterruptedException e) {
-        //do nothing
-        }
-      promise.resolve(N+43);
-    } catch (Exception e) {
-      promise.reject("Err", e);
-    }
-  }
-
-  @ReactMethod
-  public void deriveViewKey(
-          String seedBytesHex,
-          Promise promise) {
-    try {
-      promise.resolve(seedBytesHex+"-viewKey");
-    } catch (Exception e) {
-      promise.reject("Err", e);
-    }
-  }
-
-  @ReactMethod
-  public void getShieldedBalance(
-          Promise promise) {
-    try {
-      WritableMap params = Arguments.createMap();
-      params.putString("availableBalance", "123");
-      params.putString("totalBalance", "1234");
-      promise.resolve(params);
-    } catch (Exception e) {
-      promise.reject("Err", e);
-    }
-  }
-
-    private void sendEvent(ReactContext reactContext,
-                         String eventName,
-                         WritableMap params) {
-    reactContext
-            .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
-            .emit(eventName, params);
-
-}
-}

package/android/src/main/java/com/reactlibrary/RNZcashPackage.java

@@ -1,21 +0,0 @@
-package com.reactlibrary;
-
-import com.facebook.react.ReactPackage;
-import com.facebook.react.bridge.NativeModule;
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.uimanager.ViewManager;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-
-public class RNZcashPackage implements ReactPackage {
-  @Override
-  public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
-    return Arrays.<NativeModule>asList(new RNZcashModule(reactContext));
-  }
-
-  @Override
-  public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
-    return Collections.emptyList();
-  }
-}

package/ios/RNZcash.h

@@ -1,5 +0,0 @@
-#import <React/RCTBridgeModule.h>
-
-@interface RNZcash : NSObject <RCTBridgeModule>
-
-@end

package/lib/rnzcash.cjs.js

@@ -1,3 +0,0 @@
-'use strict';
-
-//# sourceMappingURL=rnzcash.cjs.js.map

package/lib/rnzcash.cjs.js.flow

@@ -1,3 +0,0 @@
-// @flow
-
-export * from '../src/index.flow.js'

package/lib/rnzcash.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rnzcash.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/lib/rnzcash.js

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=rnzcash.js.map

package/lib/rnzcash.js.flow

@@ -1,3 +0,0 @@
-// @flow
-
-export * from '../src/index.flow.js'

package/lib/rnzcash.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rnzcash.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/lib/rnzcash.web.js

@@ -1,3 +0,0 @@
-'use strict';
-
-//# sourceMappingURL=rnzcash.web.js.map

package/lib/rnzcash.web.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rnzcash.web.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}