-
Notifications
You must be signed in to change notification settings - Fork 10
/
TransactionQR.ts
106 lines (99 loc) · 3.35 KB
/
TransactionQR.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/**
* (C) Symbol Contributors 2022
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// internal dependencies
import {
INetworkType,
QRCode,
QRCodeDataSchema,
QRCodeInterface,
QRCodeType,
RequestTransactionDataSchema,
} from '../index';
import {ITransaction} from "./sdk";
class TransactionQR extends QRCode implements QRCodeInterface {
/**
* Construct a Transaction Request QR Code out of the
* symbol-sdk Transaction instance.
*
* @param transaction {Transaction}
* @param networkType {NetworkType}
* @param generationHash {string}
*/
constructor(/**
* The transaction for the request.
* @var {Transaction}
*/
public readonly transaction: ITransaction,
/**
* The network type.
* @var {NetworkType}
*/
public readonly networkType: INetworkType,
/**
* The chain Id.
* @var {string}
*/
public readonly generationHash: string,
/**
* The QR Code Type
*
* @var {QRCodeType}
*/
public readonly type: QRCodeType = QRCodeType.RequestTransaction) {
super(type, networkType, generationHash);
}
/**
* Parse a JSON QR code content into a TransactionQR
* object.
*
* @param json {string}
* @param transactionCreateFromPayload the transaction parser that creates a transaction from a binary payload.
* @return {TransactionQR}
* @throws {Error} On empty `json` given.
* @throws {Error} On missing `type` field value.
* @throws {Error} On unrecognized QR code `type` field value.
*/
public static fromJSON(
json: string,
transactionCreateFromPayload: (payload: string) => ITransaction,
): TransactionQR {
// create the QRCode object from JSON
return RequestTransactionDataSchema.parse(json, transactionCreateFromPayload);
}
/**
* The `getTypeNumber()` method should return the
* version number for QR codes of the underlying class.
*
* @see https://en.wikipedia.org/wiki/QR_code#Storage
* @return {number}
*/
public getTypeNumber(): number {
// Type version for ContactQR is Version 40, uses correction level L
// This type of QR can hold up to 2953 bytes of data.
return 40;
}
/**
* The `getSchema()` method should return an instance
* of a sub-class of QRCodeDataSchema which describes
* the QR Code data.
*
* @return {QRCodeDataSchema}
*/
public getSchema(): QRCodeDataSchema {
return new RequestTransactionDataSchema();
}
}
export {TransactionQR};