Multi-Currency-Checkout: Types

client/HubApi.ts

@@ -6,8 +6,8 @@ import {
     BehaviorType,
 } from './RequestBehavior';
 import { RedirectRpcClient } from '@nimiq/rpc';
-import { RequestType } from '../src/lib/RequestTypes';
 import {
+    RequestType,
     BasicRequest,
     SimpleRequest,
     OnboardRequest,
@@ -23,13 +23,24 @@ import {
     SimpleResult,
     ExportResult,
     SignedMessage,
+    Currency,
+    PaymentType,
 } from '../src/lib/PublicRequestTypes';
 
 export default class HubApi<DB extends BehaviorType = BehaviorType.POPUP> { // DB: Default Behavior
     public static readonly RequestType = RequestType;
     public static readonly RedirectRequestBehavior = RedirectRequestBehavior;
+    public static readonly Currency = Currency;
+    public static readonly PaymentType = PaymentType;
     public static readonly MSG_PREFIX = '\x16Nimiq Signed Message:\n';
 
+    /** @deprecated */
+    public static get PaymentMethod() {
+        console.warn('PaymentMethod has been renamed to PaymentType. Access via HubApi.PaymentMethod will soon '
+            + 'get disabled. Use HubApi.PaymentType instead.');
+        return PaymentType;
+    }
+
     private static get DEFAULT_ENDPOINT() {
         const originArray = location.origin.split('.');
         originArray.shift();

client/RequestBehavior.ts

@@ -1,6 +1,5 @@
-import { RequestType } from '../src/lib/RequestTypes';
 import { PostMessageRpcClient, RedirectRpcClient } from '@nimiq/rpc';
-import { ResultByRequestType } from '../src/lib/PublicRequestTypes';
+import { ResultByRequestType, RequestType } from '../src/lib/PublicRequestTypes';
 
 export abstract class RequestBehavior<B extends BehaviorType> {
     public static getAllowedOrigin(endpoint: string) {

client/package.json

@@ -15,7 +15,7 @@
     "rollup-plugin-node-resolve": "^5.0.0",
     "rollup-plugin-terser": "^4.0.4",
     "tslint": "^5.16.0",
-    "typescript": "^3.4.5"
+    "typescript": "^3.5.1"
   },
   "files": [
     "dist",

client/yarn.lock

@@ -998,10 +998,10 @@ tsutils@^2.29.0:
   dependencies:
     tslib "^1.8.1"
 
-typescript@^3.4.5:
-  version "3.4.5"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.4.5.tgz#2d2618d10bb566572b8d7aad5180d84257d70a99"
-  integrity sha512-YycBxUb49UUhdNMU5aJ7z5Ej2XGmaIBL0x34vZ82fn3hGvD+bgrMrVDpatgz2f7YxUMJxMkbWxJZeAvDxVe7Vw==
+typescript@^3.5.1:
+  version "3.7.2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.7.2.tgz#27e489b95fa5909445e9fef5ee48d81697ad18fb"
+  integrity sha512-ml7V7JfiN2Xwvcer+XAf2csGO1bPBdRbFCkYBczNZggrBZ9c7G3riSUeJmqEU5uOtXNPMhE3n+R4FA/3YOAWOQ==
 
 union-value@^1.0.0:
   version "1.0.1"

demos/Demo.ts

@@ -1,6 +1,5 @@
 import { State, PostMessageRpcClient } from '@nimiq/rpc';
 import HubApi from '../client/HubApi';
-import { RequestType } from '../src/lib/RequestTypes';
 import {
     SimpleRequest,
     Account,
@@ -11,6 +10,7 @@ import {
     SignMessageRequest,
     ExportRequest,
     RpcResult,
+    RequestType,
 } from '../src/lib/PublicRequestTypes';
 import { PopupRequestBehavior, RedirectRequestBehavior } from '../client/RequestBehavior';
 import { Utf8Tools } from '@nimiq/utils';

package.json

@@ -15,13 +15,14 @@
     "dependencies": {
         "@nimiq/browser-warning": "^0.4.0",
         "@nimiq/iqons": "^1.5.0",
-        "@nimiq/keyguard-client": "^1.0.0",
+        "@nimiq/keyguard-client": "^1.1.0",
         "@nimiq/ledgerjs": "https://github.com/nimiq/ledger-api.git",
         "@nimiq/network-client": "^0.3.1",
         "@nimiq/rpc": "^0.3.0",
         "@nimiq/style": "^0.7.2",
-        "@nimiq/utils": "^0.3.2",
-        "@nimiq/vue-components": "https://github.com/nimiq/vue-components.git#build/accounts",
+        "@nimiq/utils": "^0.4.2",
+        "@nimiq/vue-components": "https://github.com/nimiq/vue-components.git#sebastian/build/checkout/hub",
+        "big-integer": "^1.6.44",
         "vue": "^2.6.6",
         "vue-class-component": "^6.0.0",
         "vue-property-decorator": "^7.0.0",
@@ -35,6 +36,7 @@
         "@nimiq/core": "^1.5.3",
         "@nimiq/core-web": "^1.5.3",
         "@types/jest": "^24.0.6",
+        "@types/node": "^12.12.14",
         "@vue/babel-preset-app": "^3.4.1",
         "@vue/cli-plugin-typescript": "^3.4.1",
         "@vue/cli-plugin-unit-jest": "^3.4.1",
@@ -45,7 +47,7 @@
         "fake-indexeddb": "^2.0.5",
         "jest": "^24.1.0",
         "ts-jest": "^24.0.0",
-        "typescript": "^3.4.2",
+        "typescript": "^3.5.1",
         "vue-template-compiler": "^2.6.6",
         "write-file-webpack-plugin": "^4.5.0"
     }

src/components/IdenticonSelector.vue

@@ -45,7 +45,7 @@
     import { PageHeader, LoadingSpinner, Identicon, AddressDisplay, CloseIcon } from '@nimiq/vue-components';
     import { AccountInfo } from '@/lib/AccountInfo';
     import { default as LabelInput } from './Input.vue';
-    import { isDesktop } from '../lib/Constants';
+    import { isDesktop } from '../lib/Helpers';
 
     @Component({components: { PageHeader, Identicon, LoadingSpinner, AddressDisplay, LabelInput, CloseIcon }})
     class IdenticonSelector extends Vue {

src/lib/Constants.ts

@@ -42,8 +42,3 @@ export const ERROR_COOKIE_SPACE = 'Not enough cookie space';
 
 // Input
 export const MOBILE_MAX_WIDTH = 600; // px
-export function isDesktop() {
-    return (window.innerWidth
-        || document.documentElement.clientWidth
-        || document.body.clientWidth) > MOBILE_MAX_WIDTH;
-}

src/lib/Helpers.ts

@@ -0,0 +1,15 @@
+import { MOBILE_MAX_WIDTH } from './Constants';
+
+export function isDesktop() {
+    return (window.innerWidth
+        || document.documentElement.clientWidth
+        || document.body.clientWidth) > MOBILE_MAX_WIDTH;
+}
+
+export function isMilliseconds(time: number) {
+    /*
+     * 1568577148 = timestamp at time of writing
+     * 100000000000 ~ 11/16/5138
+     */
+    return time > 100000000000;
+}

src/lib/PublicRequestTypes.ts

@@ -1,5 +1,24 @@
 import { WalletType } from './WalletInfo';
-import { RequestType } from './RequestTypes';
+import { NimiqSpecifics, NimiqDirectPaymentOptions } from './paymentOptions/NimiqPaymentOptions';
+import { EtherSpecifics, EtherDirectPaymentOptions } from './paymentOptions/EtherPaymentOptions';
+import { BitcoinSpecifics, BitcoinDirectPaymentOptions } from './paymentOptions/BitcoinPaymentOptions';
+
+export enum RequestType {
+    LIST = 'list',
+    MIGRATE = 'migrate',
+    CHECKOUT = 'checkout',
+    SIGN_MESSAGE = 'sign-message',
+    SIGN_TRANSACTION = 'sign-transaction',
+    ONBOARD = 'onboard',
+    SIGNUP = 'signup',
+    LOGIN = 'login',
+    EXPORT = 'export',
+    CHANGE_PASSWORD = 'change-password',
+    LOGOUT = 'logout',
+    ADD_ADDRESS = 'add-address',
+    RENAME = 'rename',
+    CHOOSE_ADDRESS = 'choose-address',
+}
 
 export interface BasicRequest {
     appName: string;
@@ -28,7 +47,8 @@ export interface SignTransactionRequest extends BasicRequest {
     validityStartHeight: number; // FIXME To be made optional when hub has its own network
 }
 
-export interface CheckoutRequest extends BasicRequest {
+export interface NimiqCheckoutRequest extends BasicRequest {
+    version?: 1;
     shopLogoUrl?: string;
     sender?: string;
     forceSender?: boolean;
@@ -41,6 +61,88 @@ export interface CheckoutRequest extends BasicRequest {
     validityDuration?: number;
 }
 
+export enum PaymentType {
+    DIRECT,
+    OASIS,
+}
+
+export enum Currency {
+    NIM = 'nim',
+    BTC = 'btc',
+    ETH = 'eth',
+}
+
+export type ProtocolSpecificsForCurrency<C extends Currency> =
+    C extends Currency.NIM ? NimiqSpecifics
+    : C extends Currency.BTC ? BitcoinSpecifics
+    : C extends Currency.ETH ? EtherSpecifics
+    : undefined;
+
+export interface PaymentOptions<C extends Currency, T extends PaymentType> {
+    type: T;
+    currency: C;
+    expires?: number;
+    /**
+     * Amount in the smallest unit of the currency specified as `currency`.
+     * i.e Luna for Currency.NIM and Satoshi for Currency.BTC
+     */
+    amount: string;
+    protocolSpecific: ProtocolSpecificsForCurrency<C>;
+}
+
+export type AvailablePaymentOptions = NimiqDirectPaymentOptions
+                                    | EtherDirectPaymentOptions
+                                    | BitcoinDirectPaymentOptions;
+
+export type PaymentOptionsForCurrencyAndType<C extends Currency, T extends PaymentType> =
+    T extends PaymentType.DIRECT ?
+        C extends Currency.NIM ? NimiqDirectPaymentOptions
+        : C extends Currency.BTC ? BitcoinDirectPaymentOptions
+        : C extends Currency.ETH ? EtherDirectPaymentOptions
+        : PaymentOptions<C, T>
+    : PaymentOptions<C, T>;
+
+export interface MultiCurrencyCheckoutRequest extends BasicRequest {
+    version: 2;
+    /**
+     * Must be located on the same origin as the one the request is sent from.
+     */
+    shopLogoUrl: string;
+    /**
+     * TODO description of the api the callback needs to provide.
+     * Input is {currency, type} alongside the order identifying parameters in the url.
+     * the called url must return a PaymentOptions<currency, type> object
+     */
+    callbackUrl?: string;
+    /**
+     * A CSRF token, that will be transmitted in all requests to the callback url.
+     */
+    csrf?: string;
+    /**
+     * The data to be included in the transaction. Ignored for `Currenct.BTC` and `Currency.ETH`.
+     */
+    extraData?: Uint8Array | string;
+    /**
+     * Current time in seconds or milliseconds
+     */
+    time: number;
+    /**
+     * ISO 4217 Code (three letters) of the fiat currency used on the calling site.
+     */
+    fiatCurrency: string;
+    /**
+     * Amount in the currency specified by `fiatCurrency`
+     */
+    fiatAmount: number;
+    /**
+     * Array of available payment options.
+     * Each currency can only be present once, and a Currency.NIM option must exist.
+     */
+    paymentOptions: AvailablePaymentOptions[];
+}
+
+export type CheckoutRequest = NimiqCheckoutRequest | MultiCurrencyCheckoutRequest;
+
 export interface SignedTransaction {
     serializedTx: string; // HEX
     hash: string; // HEX