All files / src transfer.ts

100% Statements 34/34
100% Branches 29/29
100% Functions 2/2
100% Lines 34/34

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136                            3x 3x             3x 3x   3x                         3x             45x 2x     43x 1x         42x 41x     42x 3x     42x         1x     41x 7x 1x       6x 1x       39x     3x 45x               38x   38x     38x       38x                   38x 16x     22x                   22x       22x   22x    
/*
 * Copyright © 2019 Lisk Foundation
 *
 * See the LICENSE file at the top-level directory of this distribution
 * for licensing information.
 *
 * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation,
 * no part of this software, including this file, may be copied, modified,
 * propagated, or distributed except according to the terms contained in the
 * LICENSE file.
 *
 * Removal or modification of this copyright notice is prohibited.
 *
 */
import { getAddressFromPublicKey } from '@liskhq/lisk-cryptography';
import {
	isValidTransferAmount,
	validateAddress,
	validateNetworkIdentifier,
	validatePublicKey,
} from '@liskhq/lisk-validator';
 
import { TransferTransaction } from './8_transfer_transaction';
import { BYTESIZES } from './constants';
import { TransactionJSON } from './transaction_types';
import { createBaseTransaction } from './utils';
 
export interface TransferInputs {
	readonly amount: string;
	readonly networkIdentifier: string;
	readonly data?: string;
	readonly passphrase?: string;
	readonly recipientId?: string;
	readonly recipientPublicKey?: string;
	readonly secondPassphrase?: string;
	readonly timeOffset?: number;
}
 
const validateInputs = ({
	amount,
	recipientId,
	recipientPublicKey,
	data,
	networkIdentifier,
}: TransferInputs): void => {
	if (!isValidTransferAmount(amount)) {
		throw new Error('Amount must be a valid number in string format.');
	}
 
	if (!recipientId && !recipientPublicKey) {
		throw new Error(
			'Either recipientId or recipientPublicKey must be provided.',
		);
	}
 
	if (typeof recipientId !== 'undefined') {
		validateAddress(recipientId);
	}
 
	if (typeof recipientPublicKey !== 'undefined') {
		validatePublicKey(recipientPublicKey);
	}
 
	if (
		recipientId &&
		recipientPublicKey &&
		recipientId !== getAddressFromPublicKey(recipientPublicKey)
	) {
		throw new Error('recipientId does not match recipientPublicKey.');
	}
 
	if (data && data.length > 0) {
		if (typeof data !== 'string') {
			throw new Error(
				'Invalid encoding in transaction data. Data must be utf-8 encoded string.',
			);
		}
		if (data.length > BYTESIZES.DATA) {
			throw new Error('Transaction data field cannot exceed 64 bytes.');
		}
	}
 
	validateNetworkIdentifier(networkIdentifier);
};
 
export const transfer = (inputs: TransferInputs): Partial<TransactionJSON> => {
	validateInputs(inputs);
	const {
		data,
		amount,
		recipientPublicKey,
		passphrase,
		secondPassphrase,
		networkIdentifier,
	} = inputs;
 
	const recipientIdFromPublicKey = recipientPublicKey
		? getAddressFromPublicKey(recipientPublicKey)
		: undefined;
	const recipientId = inputs.recipientId
		? inputs.recipientId
		: recipientIdFromPublicKey;
 
	const transaction = {
		...createBaseTransaction(inputs),
		type: 8,
		asset: {
			amount,
			recipientId: recipientId as string,
			data,
		},
	};
 
	if (!passphrase) {
		return transaction;
	}
 
	const transactionWithSenderInfo = {
		...transaction,
		networkIdentifier,
		senderPublicKey: transaction.senderPublicKey as string,
		asset: {
			...transaction.asset,
			recipientId: recipientId as string,
		},
	};
 
	const transferTransaction = new TransferTransaction(
		transactionWithSenderInfo,
	);
 
	transferTransaction.sign(passphrase, secondPassphrase);
 
	return transferTransaction.toJSON();
};