gitiumiota/packages/transaction/README.md

IOTA Client Reference Implementation

# @iota/transaction

Utilities and validators for transactions.

## Installation

Install using [npm](https://www.npmjs.org/):
```
npm install @iota/transaction
```

or using [yarn](https://yarnpkg.com/):

```
yarn add @iota/transaction
```

## API Reference

    
* [transaction](#module_transaction)

    * [~transactionHash(trits)](#module_transaction..transactionHash)

    * [~isTransaction(tx)](#module_transaction..isTransaction)

    * [~isTailTransaction(transaction)](#module_transaction..isTailTransaction)

    * [~isTransactionHash(hash, mwm)](#module_transaction..isTransactionHash)

    * [~isTransactionTrytes(trytes, minWeightMagnitude)](#module_transaction..isTransactionTrytes)

    * [~isAttachedTrytes(trytes)](#module_transaction..isAttachedTrytes)


<a name="module_transaction..transactionHash"></a>

### *transaction*~transactionHash(trits)

| Param | Type | Description |
| --- | --- | --- |
| trits | <code>Int8Array</code> | Int8Array of 8019 transaction trits |

Calculates the transaction hash out of 8019 transaction trits.

**Returns**: <code>Hash</code> - Transaction hash  
<a name="module_transaction..isTransaction"></a>

### *transaction*~isTransaction(tx)

| Param | Type |
| --- | --- |
| tx | <code>object</code> | 

Checks if input is valid transaction object.

<a name="module_transaction..isTailTransaction"></a>

### *transaction*~isTailTransaction(transaction)

| Param | Type |
| --- | --- |
| transaction | <code>object</code> | 

Checks if given transaction object is tail transaction.
A tail transaction is one with `currentIndex=0`.

<a name="module_transaction..isTransactionHash"></a>

### *transaction*~isTransactionHash(hash, mwm)

| Param | Type |
| --- | --- |
| hash | <code>string</code> | 
| mwm | <code>number</code> | 

Checks if input is correct transaction hash (81 trytes)

<a name="module_transaction..isTransactionTrytes"></a>

### *transaction*~isTransactionTrytes(trytes, minWeightMagnitude)

| Param | Type |
| --- | --- |
| trytes | <code>string</code> | 
| minWeightMagnitude | <code>number</code> | 

Checks if input is correct transaction trytes (2673 trytes)

<a name="module_transaction..isAttachedTrytes"></a>

### *transaction*~isAttachedTrytes(trytes)

| Param | Type |
| --- | --- |
| trytes | <code>string</code> | 

Checks if input is valid attached transaction trytes.
For attached transactions last 241 trytes are non-zero.