@bitpay-labs/bitcore-wallet-service 11.5.2

package/TSS.md

@@ -0,0 +1,136 @@
+# DKG
+This document explains the specs for the client implementation of distributed _key_ generation (DKG) for the threshold signature scheme (TSS). This logic is mostly abstracted away by the `TssKeyGen` class in `bitcore-wallet-client/lib/tsskey.ts`.
+
+
+### Asynchronous DKG
+If the DKG ceremony is executed asynchronously (meaning all parties are not online at the same time during the DKG), the `keyGen.export()` function should be used between each step to export the local session state. The session state should be securely stored and used with `KeyGen.restore()` for following steps. See the `exportSession()` and `restoreSession()` methods in `bitcore-wallet-client/lib/tsskey.ts` for a reference.
+
+### Flow Diagram
+![DKG Flow](DKG-flow.png)
+
+### API Spec
+
+<details>
+<summary style="font-size:17px"><span style="font-weight:bold">POST</span> /v1/tss/keygen/:id</summary>
+
+Initialize the `KeyGen` class with a seed that is the derived private key.
+
+> E.g.: given your HD master key, derive an Ethereum key along the Ethereum standard path m/44'/60'/0'/\<index>. The resulting private key will be the seed for the KeyGen class.
+
+**If you are creating a session**, your partyId should be 0.
+
+**If you are joining a session**, the join code should have your partyId.
+
+### Request body:
+```typescript
+{
+  message: object, // Message object from the TSS keygen initJoin() or nextRound() methods
+  n?: number, // Number of participants. Only provided by party 0 when initiating the session
+  password?: string // Optional join password set by party 0 when initiating the session
+}
+```
+
+### Response body:
+```typescript
+None
+```
+</details>
+
+<details>
+<summary style="font-size:17px"><span style="font-weight:bold">GET</span> /v1/tss/keygen/:id/:round</summary>
+
+### Request body:
+```typescript
+None
+```
+
+### Response body:
+```typescript
+{
+  messages?: Array, // Array of P2P or Broadcast messages ready to be given to the TSS keygen nextRound() method. Only given if ALL other-party messages are posted
+  publicKey?: string, // The resulting public key at the end of the session
+  hasKeyBackup?: boolean // Indicates if this party's encrypted key share has been backed up to the server
+}
+```
+</details>
+
+<details>
+<summary style="font-size:17px"><span style="font-weight:bold">POST</span> /v1/tss/keygen/:id/store</summary>
+
+
+### Request body:
+```typescript
+{
+  publicKey?: string, // The resulting public key 
+  encryptedKeyChain?: string, // Your encrypted key share
+}
+```
+> THIS IS A SUB-OPTIMAL ENDPOINT. We do NOT want users to be dependent on our servers for recovering their funds. However, this is a stop-gap until we have DKG recovery implemented.
+
+### Response body:
+```typescript
+None
+```
+</details>
+
+<span style="padding:20px"> </span>
+
+# DSG
+This document explains the specs for the client implementation of distributed _signature_ generation (DSG) for the threshold signature scheme (TSS). This logic is mostly abstracted away by the `TssSign` class in `bitcore-wallet-client/lib/tsssign.ts`.
+
+
+### Asynchronous DSG
+If the DSG ceremony is executed asynchronously (meaning all signing parties are not required to be online at the same time during the DSG), the `sign.export()` function should be used between each step to export the local session state. The session state should be securely stored and used with `Sign.restore()` for following steps.
+
+### Flow Diagram
+![DSG Flow](DSG-flow.png)
+
+### API Spec
+<details>
+<summary style="font-size:17px"><span style="font-weight:bold">POST</span> /v1/tss/sign/:id</summary>
+
+### Request body:
+```typescript
+{
+  message: object // Message object from the TSS sign initJoin() or nextRound() methods
+}
+```
+
+### Response body:
+```typescript
+None
+```
+</details>
+
+<details>
+<summary style="font-size:17px"><span style="font-weight:bold">GET</span> /v1/tss/sign/:id/:round</summary>
+
+### Request body:
+```typescript
+None
+```
+
+### Response body:
+```typescript
+{
+  messages?: Array, // Array of P2P or Broadcast messages ready to be given to the TSS keygen nextRound() method. Only given if ALL other-party messages are posted
+  signature?: // The resulting signature at the end of the session. The existence indicates the session has ended
+}
+```
+</details>
+
+<details>
+<summary style="font-size:17px"><span style="font-weight:bold">POST</span> /v1/tss/sign/:id/store</summary>
+
+### Request body:
+```typescript
+{
+  signature?: string, // Provided after the final round
+}
+```
+
+### Response body:
+```typescript
+None
+```
+</details>

package/bws.example.config.js

@@ -0,0 +1,451 @@
+module.exports = {
+  basePath: '/bws/api',
+  disableLogs: false,
+  port: 3232,
+  allowRegtest: false,
+
+  // Uncomment to make BWS a forking server
+  // cluster: true,
+
+  // Uncomment to set the number or process (will use the nr of availalbe CPUs by default)
+  // clusterInstances: 4,
+
+  // https: true,
+  // privateKeyFile: 'private.pem',
+  // certificateFile: 'cert.pem',
+  // //// The following is only for certs which are not
+  // //// trusted by nodejs 'https' by default
+  // //// CAs like Verisign do not require this
+  // CAinter1: '', // ex. 'COMODORSADomainValidationSecureServerCA.crt'
+  // CAinter2: '', // ex. 'COMODORSAAddTrustCA.crt'
+  // CAroot: '', // ex. 'AddTrustExternalCARoot.crt'
+
+  storageOpts: {
+    mongoDb: {
+      uri: 'mongodb://0.0.0.0:27017/bws',
+      dbname: 'bws'
+    }
+  },
+  messageBrokerOpts: {
+    //  To use message broker server, uncomment this:
+    messageBrokerServer: {
+      url: 'http://localhost:3380'
+    }
+  },
+  blockchainExplorerOpts: {
+    btc: {
+      livenet: {
+        url: 'https://api.bitcore.io'
+      },
+      testnet: {
+        url: 'https://api.bitcore.io',
+        regtestEnabled: false
+      },
+      testnet3: {
+        url: 'https://api.bitcore.io'
+      },
+      signet: {
+        url: 'https://api.bitcore.io'
+      },
+    },
+    bch: {
+      livenet: {
+        url: 'https://api.bitcore.io'
+      },
+      testnet: {
+        url: 'https://api.bitcore.io',
+        regtestEnabled: false
+      },
+      testnet3: {
+        url: 'https://api.bitcore.io'
+      },
+      testnet4: {
+        url: 'https://api.bitcore.io'
+      },
+      scalenet: {
+        url: 'https://api.bitcore.io'
+      },
+      chipnet: {
+        url: 'https://api.bitcore.io'
+      },
+    },
+    eth: {
+      livenet: {
+        url: 'https://api-eth.bitcore.io'
+      },
+      testnet: {
+        url: 'https://api-eth.bitcore.io',
+        regtestEnabled: false
+      },
+      sepolia: {
+        url: 'https://api-eth.bitcore.io'
+      },
+      holesky: {
+        url: 'https://api-eth.bitcore.io'
+      },
+    },
+    xrp: {
+      livenet: {
+        url: 'https://api-xrp.bitcore.io'
+      },
+      testnet: {
+        url: 'https://api-xrp.bitcore.io',
+        regtestEnabled: false
+      }
+    },
+    doge: {
+      livenet: {
+        url: 'https://api.bitcore.io'
+      },
+      testnet: {
+        url: 'https://api.bitcore.io',
+        regtestEnabled: false
+      }
+    },
+    ltc: {
+      livenet: {
+        url: 'https://api.bitcore.io'
+      },
+      testnet: {
+        url: 'https://api.bitcore.io',
+        regtestEnabled: false
+      }
+    },
+    socketApiKey: 'socketApiKey'
+  },
+  pushNotificationsOpts: {
+    templatePath: 'templates',
+    defaultLanguage: 'en',
+    defaultUnit: 'btc',
+    subjectPrefix: '',
+    pushServerUrl: 'https://fcm.googleapis.com/fcm',
+    authorizationKey: 'You_have_to_put_something_here'
+  },
+  fiatRateServiceOpts: {
+    defaultProvider: 'BitPay',
+    fetchInterval: 5 // in minutes
+  },
+  maintenanceOpts: {
+    maintenanceMode: false
+  },
+  services: {
+    buyCrypto: {
+      disabled: false,
+      banxa: {
+        disabled: false,
+        removed: false
+      },
+      moonpay: {
+        disabled: false,
+        removed: false
+      },
+      ramp: {
+        disabled: false,
+        removed: false
+      },
+      sardine: {
+        disabled: false,
+        removed: false
+      },
+      simplex: {
+        disabled: false,
+        removed: false
+      },
+      transak: {
+        disabled: false,
+        removed: false
+      },
+      wyre: {
+        disabled: false,
+        removed: false
+      }
+    },
+    sellCrypto: {
+      disabled: false,
+      moonpay: {
+        disabled: false,
+        removed: false
+      },
+      simplex: {
+        disabled: false,
+        removed: false
+      }
+    },
+    swapCrypto: {
+      disabled: false,
+      changelly: {
+        disabled: false,
+        removed: false
+      },
+      thorswap: {
+        disabled: false,
+        removed: false,
+        // config: {
+        //   affiliateAddress: 'thorname_here',
+        //   affiliateBasisPoints: 'type_number_fee_here'
+        // }
+      }
+    },
+  },
+  suspendedChains: [],
+  staticRoot: '/tmp/static'
+  // banxa : {
+  //   sandbox: {
+  //     api: 'https://bitpay.banxa-sandbox.com/api',
+  //     apiKey: 'banxa_sandbox_api_key_here',
+  //     secretKey: 'banxa_sandbox_secret_key_here',
+  //   },
+  //   production: {
+  //     api: 'https://bitpay.banxa-sandbox.com/api',
+  //     apiKey: 'banxa_production_api_key_here',
+  //     secretKey: 'banxa_production_secret_key_here',
+  //   },
+  //   sandboxWeb: {
+  //     api: 'https://bitpay.banxa-sandbox.com/api',
+  //     apiKey: 'banxa_sandbox_web_api_key_here',
+  //     secretKey: 'banxa_sandbox_web_secret_key_here',
+  //   },
+  //   productionWeb: {
+  //     api: 'https://bitpay.banxa-sandbox.com/api',
+  //     apiKey: 'banxa_production_web_api_key_here',
+  //     secretKey: 'banxa_production_web_secret_key_here',
+  //   },
+  // },
+  // moonpay: {
+  //   sandbox: {
+  //     apiKey: 'moonpay_sandbox_api_key_here',
+  //     api: 'https://api.moonpay.com',
+  //     widgetApi: 'https://buy-sandbox.moonpay.com',
+  //     sellWidgetApi: 'https://sell-sandbox.moonpay.com',
+  //     secretKey: 'moonpay_sandbox_secret_key_here',
+  //   },
+  //   production: {
+  //     apiKey: 'moonpay_production_api_key_here',
+  //     api: 'https://api.moonpay.com',
+  //     widgetApi: 'https://buy.moonpay.com',
+  //     sellWidgetApi: 'https://sell.moonpay.com',
+  //     secretKey: 'moonpay_production_secret_key_here',
+  //   },
+  //   sandboxWeb: {
+  //     apiKey: 'moonpay_sandbox_web_api_key_here',
+  //     api: 'https://api.moonpay.com',
+  //     widgetApi: 'https://buy-sandbox.moonpay.com',
+  //     sellWidgetApi: 'https://sell-sandbox.moonpay.com',
+  //     secretKey: 'moonpay_sandbox_web_secret_key_here',
+  //   },
+  //   productionWeb: {
+  //     apiKey: 'moonpay_production_web_api_key_here',
+  //     api: 'https://api.moonpay.com',
+  //     widgetApi: 'https://buy.moonpay.com',
+  //     sellWidgetApi: 'https://sell.moonpay.com',
+  //     secretKey: 'moonpay_production_web_secret_key_here',
+  //   }
+  // },
+  // ramp: {
+  //   sandbox: {
+  //     apiKey: 'ramp_sandbox_api_key_here',
+  //     api: 'https://api.demo.rampnetwork.com/api',
+  //     widgetApi: 'https://app.demo.rampnetwork.com/',
+  //     signingKey: 'ramp_sandbox_signing_key_here',
+  //   },
+  //   production: {
+  //     apiKey: 'ramp_production_api_key_here',
+  //     api: 'https://api.rampnetwork.com/api',
+  //     widgetApi: 'https://app.rampnetwork.com/',
+  //     signingKey: 'ramp_production_signing_key_here',
+  //   },
+  //   sandboxWeb: {
+  //     apiKey: 'ramp_sandbox_web_api_key_here',
+  //     api: 'https://api.demo.rampnetwork.com/api',
+  //     widgetApi: 'https://app.demo.rampnetwork.com/',
+  //     signingKey: 'ramp_sandbox_web_signing_key_here',
+  //   },
+  //   productionWeb: {
+  //     apiKey: 'ramp_production_web_api_key_here',
+  //     api: 'https://api.rampnetwork.com/api',
+  //     widgetApi: 'https://app.rampnetwork.com/',
+  //     signingKey: 'ramp_production_web_signing_key_here',
+  //   }
+  // },
+  // sardine: {
+  //   sandbox: {
+  //     api: 'https://api.sandbox.sardine.ai',
+  //     secretKey: 'sardine_sandbox_secret_key_here',
+  //     clientId: 'sardine_sandbox_client_id_here',
+  //   },
+  //   production: {
+  //     api: 'https://api.sardine.ai/v1',
+  //     secretKey: 'sardine_production_secret_key_here',
+  //     clientId: 'sardine_production_client_id_here',
+  //   },
+  //   sandboxWeb: {
+  //     api: 'https://api.sandbox.sardine.ai',
+  //     secretKey: 'sardine_sandbox_web_secret_key_here',
+  //     clientId: 'sardine_sandbox_web_client_id_here',
+  //   },
+  //   productionWeb: {
+  //     api: 'https://api.sardine.ai/v1',
+  //     secretKey: 'sardine_production_web_secret_key_here',
+  //     clientId: 'sardine_production_web_client_id_here',
+  //   }
+  // },
+  // simplex: {
+  //   sandbox: {
+  //     apiKey: 'simplex_sandbox_api_key_here',
+  //     api: 'https://sandbox.test-simplexcc.com',
+  //     apiSell: 'https://sell-checkout-waf.sandbox.test-simplexcc.com',
+  //     appProviderId: 'simplex_provider_id_here',
+  //     appSellRefId: 'simplex_sell_ref_id_here',
+  //     publicKey: 'simplex_sandbox_public_key_here',
+  //   },
+  //   production: {
+  //     apiKey: 'simplex_production_api_key_here',
+  //     api: 'https://backend-wallet-api.simplexcc.com',
+  //     apiSell: 'https://sell-checkout-widget.simplex.com',
+  //     appProviderId: 'simplex_provider_id_here',
+  //     appSellRefId: 'simplex_sell_ref_id_here',
+  //     publicKey: 'simplex_public_key_here',
+  //   },
+  //   sandboxWeb: {
+  //     apiKey: 'simplex_sandbox_web_api_key_here',
+  //     api: 'https://sandbox.test-simplexcc.com',
+  //     apiSell: 'https://sell-checkout-waf.sandbox.test-simplexcc.com',
+  //     appProviderId: 'simplex_web_provider_id_here',
+  //     appSellRefId: 'simplex_web_sell_ref_id_here',
+  //     publicKey: 'simplex_web_sandbox_public_key_here',
+  //   },
+  //   productionWeb: {
+  //     apiKey: 'simplex_production_web_api_key_here',
+  //     api: 'https://backend-wallet-api.simplexcc.com',
+  //     apiSell: 'https://sell-checkout-widget.simplex.com',
+  //     appProviderId: 'simplex_web_provider_id_here',
+  //     appSellRefId: 'simplex_web_sell_ref_id_here',
+  //     publicKey: 'simplex_web_public_key_here',
+  //   }
+  // },
+  // thorswap : {
+  //   sandbox: {
+  //     api: 'https://dev-api.thorswap.net',
+  //     apiKey: 'thorswap_sandbox_api_key_here',
+  //     secretKey: 'thorswap_sandbox_secret_key_here',
+  //     referer: 'thorswap_sandbox_referer_here'
+  //   },
+  //   production: {
+  //     api: 'https://api.thorswap.net',
+  //     apiKey: 'thorswap_production_api_key_here',
+  //     secretKey: 'thorswap_production_secret_key_here',
+  //     referer: 'thorswap_production_referer_here'
+  //   },
+  // },
+  // transak : {
+  //   sandbox: {
+  //     api: 'https://api-stg.transak.com',
+  //     widgetApi: 'https://api-gateway-stg.transak.com',
+  //     apiKey: 'transak_sandbox_api_key_here',
+  //     secretKey: 'transak_sandbox_secret_key_here',
+  //   },
+  //   production: {
+  //     api: 'https://api.transak.com',
+  //     widgetApi: 'https://api-gateway.transak.com',
+  //     apiKey: 'transak_production_api_key_here',
+  //     secretKey: 'transak_production_secret_key_here',
+  //   },
+  //   sandboxWeb: {
+  //     api: 'https://api-stg.transak.com',
+  //     widgetApi: 'https://api-gateway-stg.transak.com',
+  //     apiKey: 'transak_sandbox_web_api_key_here',
+  //     secretKey: 'transak_sandbox_web_secret_key_here',
+  //   },
+  //   productionWeb: {
+  //     api: 'https://api.transak.com',
+  //     widgetApi: 'https://api-gateway.transak.com',
+  //     apiKey: 'transak_production_web_api_key_here',
+  //     secretKey: 'transak_production_web_secret_key_here',
+  //   }
+  // },
+  // wyre: {
+  //   sandbox: {
+  //     apiKey: 'wyre_sandbox_api_key_here',
+  //     secretApiKey: 'wyre_sandbox_secret_api_key_here',
+  //     api: 'https://api.testwyre.com',
+  //     widgetUrl: 'https://pay.testwyre.com',
+  //     appProviderAccountId: 'wyre_provider_sandbox_account_id_here'
+  //   },
+  //   production: {
+  //     apiKey: 'wyre_production_api_key_here',
+  //     secretApiKey: 'wyre_production_secret_api_key_here',
+  //     api: 'https://api.sendwyre.com',
+  //     widgetUrl: 'https://pay.sendwyre.com/',
+  //     appProviderAccountId: 'wyre_provider_production_account_id_here'
+  //   }
+  // },
+  // changelly: {
+  //   v1: {
+  //     apiKey: 'changelly_api_key',
+  //     secret: 'changelly_secret',
+  //     api: 'https://api.changelly.com'
+  //   },
+  //   v2: {
+  //     secret: 'changelly_secret_v2',
+  //     api: 'https://api.changelly.com/v2'
+  //   }
+  // },
+  // oneInch: {
+  //   api: 'https://api.1inch.dev',
+  //   apiKey: 'one_inch_api_key',
+  //   referrerAddress: 'one_inch_referrer_address', // ETH
+  //   referrerFee: 'one_inch_referrer_fee', // min: 0; max: 3; (represents percentage)
+  // },
+  // coinGecko: {
+  //   api: 'https://api.coingecko.com/api',
+  // },
+  // moralis: {
+  //   apiKey: 'moralis_api_key_here',
+  //   whitelist: []
+  // },
+  // To use email notifications uncomment this:
+  // emailOpts: {
+  //  host: 'localhost',
+  //  port: 25,
+  //  ignoreTLS: true,
+  //  subjectPrefix: '[Wallet Service]',
+  //  from: 'wallet-service@bitcore.io',
+  //  // Note: Prod templates are in a the copay-emails repo (https://github.com/bitpay/copay-emails)
+  //  templatePath: 'templates',
+  //  defaultLanguage: 'en',
+  //  defaultUnit: 'btc',
+  //  publicTxUrlTemplate: {
+  //   btc: {
+  //     livenet: 'https://bitpay.com/insight/#/BTC/mainnet/tx/{{txid}}',
+  //     testnet: 'https://bitpay.com/insight/#/BTC/testnet/tx/{{txid}}',
+  //   },
+  //   bch: {
+  //     livenet: 'https://bitpay.com/insight/#/BCH/mainnet/tx/{{txid}}',
+  //     testnet: 'https://bitpay.com/insight/#/BCH/testnet/tx/{{txid}}',
+  //   },
+  //   eth: {
+  //     livenet: 'https://etherscan.io/tx/{{txid}}',
+  //     testnet: 'https://kovan.etherscan.io/tx/{{txid}}',
+  //   },
+  //   xrp: {
+  //     livenet: 'https://xrpscan.com/tx/{{txid}}',
+  //     testnet: 'https://test.bithomp.com/explorer//tx/{{txid}}',
+  //   },
+  //   doge: {
+  //     livenet: 'https://blockchair.com/dogecoin/transaction/{{txid}}',
+  //     testnet: 'https://sochain.com/tx/DOGETEST/{{txid}}',
+  //  },
+  //   ltc: {
+  //     livenet: 'https://bitpay.com/insight/#/LTC/mainnet/tx/{{txid}}',
+  //     testnet: 'https://bitpay.com/insight/#/LTC/testnet/tx/{{txid}}',
+  //  }
+  // },
+  // },
+  // To use sendgrid:
+  // const sgMail = require('@sendgrid/mail');
+  // sgMail.setApiKey(process.env.SENDGRID_API_KEY);
+  //
+  //
+  // //then add:
+  // mailer: sgMail,
+};