@bitpay-labs/bitcore-wallet-service 11.5.2

package/src/lib/model/index.ts

@@ -0,0 +1,12 @@
+export { Address } from './address';
+export { Copayer } from './copayer';
+export { Advertisement } from './advertisement';
+export { Email } from './email';
+export { INotification, Notification } from './notification';
+export { IPreferences, Preferences } from './preferences';
+export { PushNotificationSub } from './pushnotificationsub';
+export { Session } from './session';
+export { TxConfirmationSub } from './txconfirmationsub';
+export { TxNote } from './txnote';
+export { ITxProposal, TxProposal } from './txproposal';
+export { IWallet, Wallet } from './wallet';

package/src/lib/model/notification.ts

@@ -0,0 +1,77 @@
+/*
+ * notifications examples
+ *
+ * NewCopayer -
+ * NewAddress -
+ * NewTxProposal - (amount)
+ * TxProposalAcceptedBy - (txProposalId, copayerId)
+ * TxProposalRejectedBy -  (txProposalId, copayerId)
+ * txProposalFinallyRejected - txProposalId
+ * txProposalFinallyAccepted - txProposalId
+ *
+ * NewIncomingTx (address, txid)
+ * NewOutgoingTx - (txProposalId, txid)
+ *
+ * data Examples:
+ * { amount: 'xxx', address: 'xxx'}
+ * { txProposalId: 'xxx', copayerId: 'xxx' }
+ *
+ * Data is meant to provide only the needed information
+ * to notify the user
+ *
+ */
+
+export interface INotification {
+  version: string;
+  createdOn: number;
+  id: number;
+  type: string;
+  data: any;
+  walletId: string;
+  creatorId: string;
+  isCreator: boolean;
+}
+
+export class Notification {
+  version: string;
+  createdOn: number;
+  id: string | number;
+  type: string;
+  data: any;
+  walletId: string;
+  creatorId: string;
+  isCreator: boolean;
+
+  static create(opts) {
+    opts = opts || {};
+
+    const x = new Notification();
+
+    x.version = '1.0.0';
+    const now = Date.now();
+
+    x.createdOn = Math.floor(now / 1000);
+    x.id = now.toString().padStart(14, '0') + (opts.ticker || 0).toString().padStart(4, '0');
+    x.type = opts.type || 'general';
+    x.data = opts.data;
+    x.walletId = opts.walletId;
+    x.creatorId = opts.creatorId;
+    x.isCreator = opts.isCreator;
+
+    return x;
+  }
+
+  static fromObj(obj) {
+    const x = new Notification();
+
+    x.version = obj.version;
+    x.createdOn = obj.createdOn;
+    x.id = obj.id;
+    (x.type = obj.type), (x.data = obj.data);
+    x.walletId = obj.walletId;
+    x.creatorId = obj.creatorId;
+    x.isCreator = obj.isCreator;
+
+    return x;
+  }
+}

package/src/lib/model/preferences.ts

@@ -0,0 +1,79 @@
+export interface IPreferences {
+  version: string;
+  createdOn: number;
+  walletId: string;
+  copayerId: string;
+  email: string;
+  language: string;
+  unit: number;
+  tokenAddresses?: string[];
+  multisigEthInfo: object[];
+  maticTokenAddresses?: string[];
+  opTokenAddresses?: string[];
+  baseTokenAddresses?: string[];
+  arbTokenAddresses?: string[];
+  solTokenAddresses?: string[];
+  multisigMaticInfo: object[];
+}
+export class Preferences {
+  version: string;
+  createdOn: number;
+  walletId: string;
+  copayerId: string;
+  email: string;
+  language: string;
+  unit: number;
+  tokenAddresses: string[];
+  multisigEthInfo: object[];
+  maticTokenAddresses: string[];
+  opTokenAddresses: string[];
+  baseTokenAddresses: string[];
+  arbTokenAddresses: string[];
+  solTokenAddresses: string[];
+  multisigMaticInfo: object[];
+
+  static create(opts) {
+    opts = opts || {};
+
+    const x = new Preferences();
+
+    x.version = '1.0.0';
+    x.createdOn = Math.floor(Date.now() / 1000);
+    x.walletId = opts.walletId;
+    x.copayerId = opts.copayerId;
+    x.email = opts.email;
+    x.language = opts.language;
+    x.unit = opts.unit;
+    x.tokenAddresses = opts.tokenAddresses;
+    x.multisigEthInfo = opts.multisigEthInfo;
+    x.maticTokenAddresses = opts.maticTokenAddresses;
+    x.opTokenAddresses = opts.opTokenAddresses;
+    x.baseTokenAddresses = opts.baseTokenAddresses;
+    x.arbTokenAddresses = opts.arbTokenAddresses;
+    x.solTokenAddresses = opts.solTokenAddresses;
+    x.multisigMaticInfo = opts.multisigMaticInfo;
+    // you can't put useDust here since this is copayer's specific.
+    return x;
+  }
+
+  static fromObj(obj) {
+    const x = new Preferences();
+
+    x.version = obj.version;
+    x.createdOn = obj.createdOn;
+    x.walletId = obj.walletId;
+    x.copayerId = obj.copayerId;
+    x.email = obj.email;
+    x.language = obj.language;
+    x.unit = obj.unit;
+    x.tokenAddresses = obj.tokenAddresses;
+    x.multisigEthInfo = obj.multisigEthInfo;
+    x.maticTokenAddresses = obj.maticTokenAddresses;
+    x.opTokenAddresses = obj.opTokenAddresses;
+    x.baseTokenAddresses = obj.baseTokenAddresses;
+    x.arbTokenAddresses = obj.arbTokenAddresses;
+    x.solTokenAddresses = obj.solTokenAddresses;
+    x.multisigMaticInfo = obj.multisigMaticInfo;
+    return x;
+  }
+}

package/src/lib/model/pushnotificationsub.ts

@@ -0,0 +1,50 @@
+export interface IPushNotificationSub {
+  version: string;
+  createdOn: number;
+  copayerId: string;
+  token: string;
+  externalUserId: string;
+  packageName: string;
+  platform: string;
+  walletId: string;
+}
+export class PushNotificationSub {
+  version: string;
+  createdOn: number;
+  copayerId: string;
+  token: string;
+  externalUserId: string;
+  packageName: string;
+  platform: string;
+  walletId: string;
+
+  static create(opts) {
+    opts = opts || {};
+
+    const x = new PushNotificationSub();
+
+    x.version = '1.0.0';
+    x.createdOn = Math.floor(Date.now() / 1000);
+    x.copayerId = opts.copayerId;
+    x.token = opts.token;
+    x.externalUserId = opts.externalUserId;
+    x.packageName = opts.packageName;
+    x.platform = opts.platform;
+    x.walletId = opts.walletId;
+    return x;
+  }
+
+  static fromObj(obj) {
+    const x = new PushNotificationSub();
+
+    x.version = obj.version;
+    x.createdOn = obj.createdOn;
+    x.copayerId = obj.copayerId;
+    x.token = obj.token;
+    x.externalUserId = obj.externalUserId;
+    x.packageName = obj.packageName;
+    x.platform = obj.platform;
+    x.walletId = obj.walletId;
+    return x;
+  }
+}

package/src/lib/model/session.ts

@@ -0,0 +1,65 @@
+import Uuid from 'uuid';
+import { Common } from '../common';
+
+const Defaults = Common.Defaults;
+
+export interface ISession {
+  id: number;
+  version: number;
+  createdOn: number;
+  updatedOn: number;
+  copayerId: string;
+  walletId: string;
+}
+export class Session {
+  id: number;
+  version: number;
+  createdOn: number;
+  updatedOn: number;
+  copayerId: string;
+  walletId: string;
+
+  static create(opts) {
+    opts = opts || {};
+
+    const now = Math.floor(Date.now() / 1000);
+
+    const x = new Session();
+
+    x.id = Uuid.v4();
+    x.version = 1;
+    x.createdOn = now;
+    x.updatedOn = now;
+    x.copayerId = opts.copayerId;
+    x.walletId = opts.walletId;
+
+    return x;
+  }
+
+  static fromObj(obj) {
+    const x = new Session();
+
+    x.id = obj.id;
+    x.version = obj.version;
+    x.createdOn = obj.createdOn;
+    x.updatedOn = obj.updatedOn;
+    x.copayerId = obj.copayerId;
+    x.walletId = obj.walletId;
+
+    return x;
+  }
+
+  toObject() {
+    return this;
+  }
+
+  isValid() {
+    const now = Math.floor(Date.now() / 1000);
+    return now - this.updatedOn <= Defaults.SESSION_EXPIRATION;
+  }
+
+  touch() {
+    const now = Math.floor(Date.now() / 1000);
+    this.updatedOn = now;
+  }
+}

package/src/lib/model/tsskeygen.ts

@@ -0,0 +1,154 @@
+import { singleton } from 'preconditions';
+import { Common } from '../common';
+
+const $ = singleton();
+
+const { Defaults } = Common;
+
+
+export interface ITssKeyMessageObject {
+  broadcastMessages: Array<{
+    from: number;
+    payload: {
+      message: string;
+      signature: string;
+    };
+  }>;
+  p2pMessages: Array<{
+    to: number;
+    from: number;
+    commitment: string;
+    payload: {
+      encryptedMessage: string;
+      signature: string;
+    };
+  }>;
+  partyId: number;
+  publicKey: string;
+  round: number;
+};
+
+export interface ITssKeyGenModel {
+  /**
+   * The ID of the TSS key generation session.
+   */
+  id: string;
+  /**
+   * The version of the BWC/BWS TSS key generation scheme.
+   * This should be incremented any time there are breaking changes to the way
+   *  BWC & BWS communicate.
+   */
+  schemeVersion: number;
+  /**
+   * The number of participants in the TSS key generation process.
+   */
+  n: number;
+  /**
+   * The list of public keys of the participants in the TSS key generation process.
+   * The pub keys are in partyId order.
+   */
+  participants: Array<string>;
+  /**
+   * An array of the rounds in round order. Each round is an array of messages
+   */
+  rounds: Array<Array<{
+    fromPartyId: number;
+    messages: ITssKeyMessageObject;
+  }>>;
+  /**
+   * The public key generated as the result of the TSS key generation process.
+   */
+  sharedPublicKey?: string;
+  /**
+   * The password used to join the TSS key generation process.
+   */
+  joinPassword?: string;
+  /**
+   * Key shares for each participant encrypted to themseleves.
+   */
+  keyShares?: Array<string>;
+  /**
+   * Timestamp the session was created
+   */
+  createdOn: number;
+  /**
+   * Session expires after this many milliseconds.
+   */
+  timeLimit?: number;
+  /**
+   * The BWC-generated secret for joining a BWS wallet
+   */
+  bwsJoinSecret?: string;
+  /**
+   * The mongo doc version
+   */
+  __v: number;
+};
+
+export class TssKeyGenModel implements ITssKeyGenModel {
+  id: string;
+  n: number;
+  participants: Array<string>;
+  rounds: Array<Array<{
+    fromPartyId: number;
+    messages: ITssKeyMessageObject;
+  }>>;
+  sharedPublicKey?: string;
+  schemeVersion: number;
+  joinPassword?: string;
+  keyShares?: Array<string>;
+  createdOn: number;
+  timeLimit?: number;
+  bwsJoinSecret?: string;
+  __v: number;
+
+
+  static create(params: { id: string; message: ITssKeyMessageObject; n: number; copayerId: string; passwordHash?: string }): TssKeyGenModel {
+    const { id, message, n, copayerId, passwordHash } = params;
+    const { partyId } = message;
+    $.checkArgument(partyId === 0, 'Key generation session must be started by partyId 0');
+
+    const x = new TssKeyGenModel();
+    x.id = id;
+    x.schemeVersion = Defaults.TSS_KEYGEN_SCHEME_VERSION;
+    x.n = n;
+    x.participants = new Array(n);
+    x.participants[partyId] = copayerId;
+    x.rounds = [[{
+      fromPartyId: partyId,
+      messages: message
+    }]];
+    x.joinPassword = passwordHash;
+    x.keyShares = new Array(n);
+    x.createdOn = Date.now();
+    x.timeLimit = null; // TODO - add a session time limit
+    x.__v = 0;
+    return x;
+  }
+
+  static fromObj(obj: ITssKeyGenModel & { __v: number }): TssKeyGenModel {
+    const x = new TssKeyGenModel();
+    x.id = obj.id;
+    x.schemeVersion = obj.schemeVersion;
+    x.n = obj.n;
+    x.participants = obj.participants;
+    x.rounds = obj.rounds;
+    x.sharedPublicKey = obj.sharedPublicKey;
+    x.joinPassword = obj.joinPassword;
+    x.keyShares = obj.keyShares;
+    x.createdOn = obj.createdOn;
+    x.timeLimit = obj.timeLimit;
+    x.bwsJoinSecret = obj.bwsJoinSecret;
+    x.__v = obj.__v;
+    return x;
+  }
+
+  getCurrentRound(): number {
+    const mostRecentRound = this.rounds.length - 1;
+    if (this.rounds[mostRecentRound].length === this.n) {
+      // If the most recent round is done, return the next round
+      return mostRecentRound + 1;
+    }
+    return mostRecentRound;
+  }
+}

package/src/lib/model/tsssign.ts

@@ -0,0 +1,136 @@
+import { Common } from '../common';
+
+const { Defaults } = Common;
+
+
+export interface ITssSigMessageObject {
+  broadcastMessages: Array<{
+    from: number;
+    payload: {
+      message: string;
+      signature: string;
+    };
+  }>;
+  p2pMessages: Array<{
+    to: number;
+    from: number;
+    payload: {
+      encryptedMessage: string;
+      signature: string;
+    };
+  }>;
+  partyId: number;
+  publicKey: string;
+  round: number;
+  signature?: {
+    r: string;
+    s: string;
+    v: number;
+    pubKey: string;
+  };
+};
+
+export interface ITssSigGenModel {
+  /**
+   * The ID of the TSS signature generation session.
+   */
+  id: string;
+  /**
+   * The version of the BWC/BWS TSS signature generation scheme.
+   * This should be incremented any time there are breaking changes to the way
+   *  BWC & BWS communicate.
+   */
+  schemeVersion: number;
+  /**
+   * The number of required participants in the TSS signature generation process.
+   */
+  m: number;
+  /**
+   * The list of public keys of the participants in the TSS signature generation process.
+   * The pub keys are in partyId order.
+   */
+  participants: Array<{
+    partyId: number;
+    copayerId: string;
+  }>;
+  /**
+   * An array of the rounds in round order. Each round is an array of messages
+   */
+  rounds: Array<Array<{
+    fromPartyId: number;
+    messages: ITssSigMessageObject;
+  }>>;
+  /**
+   * The signature generated as the result of the TSS signature generation process.
+   * The signature can be generated along a derivation path, which produces a pubKey that's
+   *  dfferent from the key gen sharedPublicKey.
+   */
+  signature?: {
+    r: string;
+    s: string;
+    v: number;
+    pubKey: string;
+  };
+  /**
+   * The mongo doc version
+   */
+  __v: number;
+};
+
+export class TssSigGenModel implements ITssSigGenModel {
+  id: string;
+  m: number;
+  participants: Array<{
+    partyId: number;
+    copayerId: string;
+  }>;
+  rounds: Array<Array<{
+    fromPartyId: number;
+    messages: ITssSigMessageObject;
+  }>>;
+  signature?: ITssSigMessageObject['signature'];
+  schemeVersion: number;
+  __v: number;
+
+
+  static create(params: { id: string; message: ITssSigMessageObject; m: number; copayerId: string }): TssSigGenModel {
+    const { id, message, m, copayerId } = params;
+    const { partyId } = message;
+
+    const x = new TssSigGenModel();
+    x.id = id;
+    x.schemeVersion = Defaults.TSS_SIGGEN_SCHEME_VERSION;
+    x.m = m;
+    x.participants = [{
+      partyId,
+      copayerId
+    }];
+    x.rounds = [[{
+      fromPartyId: partyId,
+      messages: message
+    }]];
+    x.__v = 0;
+    return x;
+  }
+
+  static fromObj(obj: ITssSigGenModel): TssSigGenModel {
+    const x = new TssSigGenModel();
+    x.id = obj.id;
+    x.schemeVersion = obj.schemeVersion;
+    x.m = obj.m;
+    x.participants = obj.participants;
+    x.rounds = obj.rounds;
+    x.signature = obj.signature;
+    x.__v = obj.__v;
+    return x;
+  }
+
+  getCurrentRound(): number {
+    const mostRecentRound = this.rounds.length - 1;
+    if (this.rounds[mostRecentRound].length === this.m) {
+      // If the most recent round is done, return the next round
+      return mostRecentRound + 1;
+    }
+    return mostRecentRound;
+  }
+}

package/src/lib/model/txconfirmationsub.ts

@@ -0,0 +1,50 @@
+export interface ITxConfirmationSub {
+  version: number;
+  createdOn: number;
+  walletId: string;
+  copayerId: string;
+  txid: string;
+  amount: number;
+  isActive: boolean;
+  isCreator: boolean;
+}
+export class TxConfirmationSub {
+  version: number;
+  createdOn: number;
+  walletId: string;
+  copayerId: string;
+  txid: string;
+  amount: number;
+  isActive: boolean;
+  isCreator: boolean;
+
+  static create(opts) {
+    opts = opts || {};
+
+    const x = new TxConfirmationSub();
+
+    x.version = 1;
+    x.createdOn = Math.floor(Date.now() / 1000);
+    x.walletId = opts.walletId;
+    x.copayerId = opts.copayerId;
+    x.txid = opts.txid;
+    x.isActive = true;
+    x.amount = opts.amount;
+    x.isCreator = opts.isCreator;
+    return x;
+  }
+
+  static fromObj(obj) {
+    const x = new TxConfirmationSub();
+
+    x.version = obj.version;
+    x.createdOn = obj.createdOn;
+    x.walletId = obj.walletId;
+    x.copayerId = obj.copayerId;
+    x.txid = obj.txid;
+    x.amount = obj.amount;
+    x.isActive = obj.isActive;
+    x.isCreator = obj.isCreator;
+    return x;
+  }
+}

package/src/lib/model/txnote.ts

@@ -0,0 +1,60 @@
+export interface ITxNote {
+  version: number;
+  createdOn: number;
+  walletId: string;
+  txid: string;
+  body: string;
+  editedOn: number;
+  editedBy: string;
+}
+export class TxNote {
+  version: number;
+  createdOn: number;
+  walletId: string;
+  txid: string;
+  body: string;
+  editedOn: number;
+  editedBy: string;
+
+  static create(opts) {
+    opts = opts || {};
+
+    const now = Math.floor(Date.now() / 1000);
+
+    const x = new TxNote();
+
+    x.version = 1;
+    x.createdOn = now;
+    x.walletId = opts.walletId;
+    x.txid = opts.txid;
+    x.body = opts.body;
+    x.editedOn = now;
+    x.editedBy = opts.copayerId;
+
+    return x;
+  }
+
+  static fromObj(obj) {
+    const x = new TxNote();
+
+    x.version = obj.version;
+    x.createdOn = obj.createdOn;
+    x.walletId = obj.walletId;
+    x.txid = obj.txid;
+    x.body = obj.body;
+    x.editedOn = obj.editedOn;
+    x.editedBy = obj.editedBy;
+
+    return x;
+  }
+
+  edit(body, copayerId) {
+    this.body = body;
+    this.editedBy = copayerId;
+    this.editedOn = Math.floor(Date.now() / 1000);
+  }
+
+  toObject() {
+    return this;
+  }
+}