Skip to content
This repository has been archived by the owner on Apr 6, 2020. It is now read-only.

Commit

Permalink
Regenerated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@holgerd77
holgerd77 committed Jun 1, 2019
1 parent 237689a commit 451b2da
Show file tree
Hide file tree
Showing 7 changed files with 195 additions and 126 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

**Ƭ BufferLike**: _`Buffer` \| [TransformableToBuffer](interfaces/transformabletobuffer.md) \| [PrefixedHexString](#prefixedhexstring) \| `number`_

_Defined in [types.ts:19](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/types.ts#L19)_
_Defined in [types.ts:19](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/types.ts#L19)_

A Buffer, hex string prefixed with `0x`, Number, or an object with a toBuffer method such as BN.

Expand All @@ -41,7 +41,7 @@ A Buffer, hex string prefixed with `0x`, Number, or an object with a toBuffer me

**Ƭ PrefixedHexString**: _`string`_

_Defined in [types.ts:14](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/types.ts#L14)_
_Defined in [types.ts:14](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/types.ts#L14)_

A hex string prefixed with `0x`.

Expand Down
81 changes: 53 additions & 28 deletions docs/classes/faketransaction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Creates a new transaction object that doesn't need to be signed.

_**param**_: A transaction can be initialized with its rlp representation, an array containing the value of its fields in order, or an object containing them by name. If the latter is used, a `chainId` and `from` can also be provided.
_**param**_: A transaction can be initialized with its rlp representation, an array containing the value of its fields in order, or an object containing them by name.

_**param**_: The transaction's options, used to indicate the chain and hardfork the transactions belongs to.

Expand Down Expand Up @@ -49,6 +49,7 @@ _**see**_: Transaction
- [serialize](faketransaction.md#serialize)
- [sign](faketransaction.md#sign)
- [toCreationAddress](faketransaction.md#tocreationaddress)
- [toJSON](faketransaction.md#tojson)
- [validate](faketransaction.md#validate)
- [verifySignature](faketransaction.md#verifysignature)

Expand All @@ -64,7 +65,7 @@ _**see**_: Transaction

_Overrides [Transaction](transaction.md).[constructor](transaction.md#constructor)_

_Defined in [fake.ts:23](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/fake.ts#L23)_
_Defined in [fake.ts:22](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/fake.ts#L22)_

**Parameters:**

Expand All @@ -87,7 +88,7 @@ _Defined in [fake.ts:23](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b8

_Inherited from [Transaction](transaction.md).[\_from](transaction.md#_from)_

_Defined in [transaction.ts:37](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L37)_
_Defined in [transaction.ts:37](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L37)_

---

Expand All @@ -99,7 +100,7 @@ _Defined in [transaction.ts:37](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[data](transaction.md#data)_

_Defined in [transaction.ts:29](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L29)_
_Defined in [transaction.ts:30](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L30)_

---

Expand All @@ -109,7 +110,7 @@ _Defined in [transaction.ts:29](https://github.com/alcuadrado/ethereumjs-tx/blob

**● from**: _`Buffer`_

_Defined in [fake.ts:23](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/fake.ts#L23)_
_Defined in [fake.ts:22](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/fake.ts#L22)_

Set from address to bypass transaction signing. This is not an optional property, as its getter never returns undefined.

Expand All @@ -123,7 +124,7 @@ Set from address to bypass transaction signing. This is not an optional property

_Inherited from [Transaction](transaction.md).[gasLimit](transaction.md#gaslimit)_

_Defined in [transaction.ts:25](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L25)_
_Defined in [transaction.ts:26](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L26)_

---

Expand All @@ -135,7 +136,7 @@ _Defined in [transaction.ts:25](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[gasPrice](transaction.md#gasprice)_

_Defined in [transaction.ts:26](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L26)_
_Defined in [transaction.ts:27](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L27)_

---

Expand All @@ -147,7 +148,7 @@ _Defined in [transaction.ts:26](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[nonce](transaction.md#nonce)_

_Defined in [transaction.ts:24](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L24)_
_Defined in [transaction.ts:25](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L25)_

---

Expand All @@ -159,7 +160,7 @@ _Defined in [transaction.ts:24](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[r](transaction.md#r)_

_Defined in [transaction.ts:31](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L31)_
_Defined in [transaction.ts:32](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L32)_

---

Expand All @@ -171,7 +172,7 @@ _Defined in [transaction.ts:31](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[raw](transaction.md#raw)_

_Defined in [transaction.ts:23](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L23)_
_Defined in [transaction.ts:24](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L24)_

---

Expand All @@ -183,7 +184,7 @@ _Defined in [transaction.ts:23](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[s](transaction.md#s)_

_Defined in [transaction.ts:32](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L32)_
_Defined in [transaction.ts:33](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L33)_

---

Expand All @@ -195,7 +196,7 @@ _Defined in [transaction.ts:32](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[to](transaction.md#to)_

_Defined in [transaction.ts:27](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L27)_
_Defined in [transaction.ts:28](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L28)_

---

Expand All @@ -207,7 +208,7 @@ _Defined in [transaction.ts:27](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[v](transaction.md#v)_

_Defined in [transaction.ts:30](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L30)_
_Defined in [transaction.ts:31](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L31)_

---

Expand All @@ -219,7 +220,7 @@ _Defined in [transaction.ts:30](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[value](transaction.md#value)_

_Defined in [transaction.ts:28](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L28)_
_Defined in [transaction.ts:29](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L29)_

---

Expand All @@ -233,7 +234,7 @@ _Defined in [transaction.ts:28](https://github.com/alcuadrado/ethereumjs-tx/blob

_Inherited from [Transaction](transaction.md).[getBaseFee](transaction.md#getbasefee)_

_Defined in [transaction.ts:314](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L314)_
_Defined in [transaction.ts:296](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L296)_

the minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee)

Expand All @@ -249,7 +250,7 @@ the minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee)

_Inherited from [Transaction](transaction.md).[getChainId](transaction.md#getchainid)_

_Defined in [transaction.ts:228](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L228)_
_Defined in [transaction.ts:202](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L202)_

returns chain ID

Expand All @@ -265,7 +266,7 @@ returns chain ID

_Inherited from [Transaction](transaction.md).[getDataFee](transaction.md#getdatafee)_

_Defined in [transaction.ts:300](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L300)_
_Defined in [transaction.ts:282](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L282)_

The amount of gas paid for the data in this tx

Expand All @@ -281,7 +282,7 @@ The amount of gas paid for the data in this tx

_Inherited from [Transaction](transaction.md).[getSenderAddress](transaction.md#getsenderaddress)_

_Defined in [transaction.ts:235](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L235)_
_Defined in [transaction.ts:209](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L209)_

returns the sender's address

Expand All @@ -297,7 +298,7 @@ returns the sender's address

_Inherited from [Transaction](transaction.md).[getSenderPublicKey](transaction.md#getsenderpublickey)_

_Defined in [transaction.ts:247](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L247)_
_Defined in [transaction.ts:221](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L221)_

returns the public key of the sender

Expand All @@ -313,7 +314,7 @@ returns the public key of the sender

_Inherited from [Transaction](transaction.md).[getUpfrontCost](transaction.md#getupfrontcost)_

_Defined in [transaction.ts:325](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L325)_
_Defined in [transaction.ts:307](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L307)_

the up front amount that an account must have for this transaction to be valid

Expand All @@ -329,7 +330,7 @@ the up front amount that an account must have for this transaction to be valid

_Overrides [Transaction](transaction.md).[hash](transaction.md#hash)_

_Defined in [fake.ts:54](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/fake.ts#L54)_
_Defined in [fake.ts:53](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/fake.ts#L53)_

Computes a sha3-256 hash of the serialized tx, using the sender address to generate a fake signature.

Expand All @@ -351,7 +352,7 @@ Computes a sha3-256 hash of the serialized tx, using the sender address to gener

_Inherited from [Transaction](transaction.md).[serialize](transaction.md#serialize)_

_Defined in [transaction.ts:355](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L355)_
_Defined in [transaction.ts:337](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L337)_

Returns the rlp encoding of the transaction

Expand All @@ -367,7 +368,7 @@ Returns the rlp encoding of the transaction

_Inherited from [Transaction](transaction.md).[sign](transaction.md#sign)_

_Defined in [transaction.ts:288](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L288)_
_Defined in [transaction.ts:262](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L262)_

sign a transaction with a given private key

Expand All @@ -389,14 +390,38 @@ sign a transaction with a given private key

_Inherited from [Transaction](transaction.md).[toCreationAddress](transaction.md#tocreationaddress)_

_Defined in [transaction.ts:181](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L181)_
_Defined in [transaction.ts:169](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L169)_

If the tx's `to` is to the creation address

**Returns:** `boolean`

---

<a id="tojson"></a>

### toJSON

▸ **toJSON**(labels?: _`boolean`_): `object` \| `string`[]

_Inherited from [Transaction](transaction.md).[toJSON](transaction.md#tojson)_

_Defined in [transaction.ts:346](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L346)_

Returns the transaction in JSON format

_**see**_: [ethereumjs-util](https://github.com/ethereumjs/ethereumjs-util/blob/master/docs/index.md#defineproperties)

**Parameters:**

| Name | Type | Default value |
| ---------------------- | --------- | ------------- |
| `Default value` labels | `boolean` | false |

**Returns:** `object` \| `string`[]

---

<a id="validate"></a>

### validate
Expand All @@ -409,15 +434,15 @@ If the tx's `to` is to the creation address

_Inherited from [Transaction](transaction.md).[validate](transaction.md#validate)_

_Defined in [transaction.ts:332](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L332)_
_Defined in [transaction.ts:314](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L314)_

Validates the signature and checks to see if it has enough gas.

**Returns:** `boolean`

_Inherited from [Transaction](transaction.md).[validate](transaction.md#validate)_

_Defined in [transaction.ts:333](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L333)_
_Defined in [transaction.ts:315](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L315)_

**Parameters:**

Expand All @@ -429,7 +454,7 @@ _Defined in [transaction.ts:333](https://github.com/alcuadrado/ethereumjs-tx/blo

_Inherited from [Transaction](transaction.md).[validate](transaction.md#validate)_

_Defined in [transaction.ts:334](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L334)_
_Defined in [transaction.ts:316](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L316)_

**Parameters:**

Expand All @@ -449,7 +474,7 @@ _Defined in [transaction.ts:334](https://github.com/alcuadrado/ethereumjs-tx/blo

_Inherited from [Transaction](transaction.md).[verifySignature](transaction.md#verifysignature)_

_Defined in [transaction.ts:259](https://github.com/alcuadrado/ethereumjs-tx/blob/84f5b82/src/transaction.ts#L259)_
_Defined in [transaction.ts:233](https://github.com/ethereumjs/ethereumjs-tx/blob/5b72ca6/src/transaction.ts#L233)_

Determines if the signature is valid

Expand Down
Loading

0 comments on commit 451b2da

Please sign in to comment.