Skip to content

Commit

Permalink
refactor: add support for the messageout receipt type (#558)
Browse files Browse the repository at this point in the history
  • Loading branch information
@pixelcircuits
pixelcircuits committed Oct 29, 2022
1 parent 5a9d07b commit eebb0bd
Show file tree
Hide file tree
Showing 12 changed files with 466 additions and 12 deletions.
5 changes: 5 additions & 0 deletions .changeset/clever-donkeys-serve.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@fuel-ts/transactions": minor
---

Added support for MessageOut receipts
45 changes: 44 additions & 1 deletion docs/packages/fuel-ts-contract/namespaces/internal.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,16 @@ ___

___

### MessageOut

• **MessageOut**: ``10``

#### Defined in

[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16)

___

### Variable

• **Variable**: ``4``
Expand Down Expand Up @@ -997,6 +1007,29 @@ ___

___

### ReceiptMessageOut

Ƭ **ReceiptMessageOut**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `messageID` | `string` |
| `sender` | `string` |
| `recipient` | `string` |
| `amount` | [`BN`](../classes/internal-BN.md) |
| `nonce` | `string` |
| `digest` | `string` |
| `data` | `Uint8Array` |
| `type` | [`MessageOut`](internal.md#messageout) |

#### Defined in

[packages/transactions/src/coders/receipt.ts:548](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L548)

___

### StorageSlot

Ƭ **StorageSlot**: `Object`
Expand Down Expand Up @@ -1198,7 +1231,7 @@ ___

### TransactionResultReceipt

Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](internal.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](internal.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](internal.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](internal.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](internal.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](internal.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](internal.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](internal.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](internal.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](internal.md#transactionresultscriptresultreceipt)
Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](internal.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](internal.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](internal.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](internal.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](internal.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](internal.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](internal.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](internal.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](internal.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](internal.md#transactionresultscriptresultreceipt) \| [`TransactionResultMessageOutReceipt`](internal.md#transactionresultmessageoutreceipt)

#### Defined in

Expand Down Expand Up @@ -1256,6 +1289,16 @@ ___

___

### TransactionResultMessageOutReceipt

Ƭ **TransactionResultMessageOutReceipt**: [`ReceiptMessageOut`](internal.md#receiptmessageout)

#### Defined in

[packages/providers/src/transaction-response/transaction-response.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L36)

___

### TransactionResultTransferReceipt

Ƭ **TransactionResultTransferReceipt**: [`ReceiptTransfer`](internal.md#receipttransfer)
Expand Down
12 changes: 11 additions & 1 deletion docs/packages/fuel-ts-providers/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ ___

### TransactionResultReceipt

Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](index.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](index.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](index.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](index.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](index.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](index.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](index.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](index.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](index.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](index.md#transactionresultscriptresultreceipt)
Ƭ **TransactionResultReceipt**: [`TransactionResultCallReceipt`](index.md#transactionresultcallreceipt) \| [`TransactionResultReturnReceipt`](index.md#transactionresultreturnreceipt) \| [`TransactionResultReturnDataReceipt`](index.md#transactionresultreturndatareceipt) \| [`TransactionResultPanicReceipt`](index.md#transactionresultpanicreceipt) \| [`TransactionResultRevertReceipt`](index.md#transactionresultrevertreceipt) \| [`TransactionResultLogReceipt`](index.md#transactionresultlogreceipt) \| [`TransactionResultLogDataReceipt`](index.md#transactionresultlogdatareceipt) \| [`TransactionResultTransferReceipt`](index.md#transactionresulttransferreceipt) \| [`TransactionResultTransferOutReceipt`](index.md#transactionresulttransferoutreceipt) \| [`TransactionResultScriptResultReceipt`](index.md#transactionresultscriptresultreceipt) \| [`TransactionResultMessageOutReceipt`](index.md#transactionresultmessageoutreceipt)

#### Defined in

Expand Down Expand Up @@ -571,6 +571,16 @@ ___

___

### TransactionResultMessageOutReceipt

Ƭ **TransactionResultMessageOutReceipt**: [`ReceiptMessageOut`](internal.md#receiptmessageout)

#### Defined in

[packages/providers/src/transaction-response/transaction-response.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-response/transaction-response.ts#L36)

___

### TransactionResultTransferReceipt

Ƭ **TransactionResultTransferReceipt**: [`ReceiptTransfer`](namespaces/internal.md#receipttransfer)
Expand Down
33 changes: 33 additions & 0 deletions docs/packages/fuel-ts-providers/namespaces/internal.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,16 @@ ___

___

### MessageOut

• **MessageOut**: ``10``

#### Defined in

[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16)

___

### Variable

• **Variable**: ``4``
Expand Down Expand Up @@ -1255,6 +1265,29 @@ ___

___

### ReceiptMessageOut

Ƭ **ReceiptMessageOut**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `messageID` | `string` |
| `sender` | `string` |
| `recipient` | `string` |
| `amount` | [`BN`](../classes/internal-BN.md) |
| `nonce` | `string` |
| `digest` | `string` |
| `data` | `Uint8Array` |
| `type` | [`MessageOut`](internal.md#messageout) |

#### Defined in

[packages/transactions/src/coders/receipt.ts:548](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L548)

___

### Scalars

Ƭ **Scalars**: `Object`
Expand Down
165 changes: 165 additions & 0 deletions docs/packages/fuel-ts-transactions/classes/ReceiptMessageOutCoder.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
---
layout: default
title: ReceiptMessageOutCoder
parent: "@fuel-ts/transactions"
nav_order: 1

---

# Class: ReceiptMessageOutCoder

[@fuel-ts/transactions](../index.md).ReceiptMessageOutCoder

## Hierarchy

- `default`<[`ReceiptMessageOut`](../index.md#receiptmessageout), [`ReceiptMessageOut`](../index.md#receiptmessageout)\>

↳ **`ReceiptMessageOutCoder`**

## Constructors

### constructor

• **new ReceiptMessageOutCoder**()

#### Overrides

Coder&lt;ReceiptMessageOut, ReceiptMessageOut\&gt;.constructor

## Properties

### encodedLength

• `Readonly` **encodedLength**: `number`

#### Inherited from

Coder.encodedLength

#### Defined in

[packages/abi-coder/src/coders/abstract-coder.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L36)

___

### name

• `Readonly` **name**: `string`

#### Inherited from

Coder.name

#### Defined in

[packages/abi-coder/src/coders/abstract-coder.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L34)

___

### offset

• `Optional` **offset**: `number`

#### Inherited from

Coder.offset

#### Defined in

[packages/abi-coder/src/coders/abstract-coder.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L37)

___

### type

• `Readonly` **type**: `string`

#### Inherited from

Coder.type

#### Defined in

[packages/abi-coder/src/coders/abstract-coder.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L35)

## Methods

### decode

▸ **decode**(`data`, `offset`): [[`ReceiptMessageOut`](../index.md#receiptmessageout), `number`]

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | `Uint8Array` |
| `offset` | `number` |

#### Returns

[[`ReceiptMessageOut`](../index.md#receiptmessageout), `number`]

#### Overrides

Coder.decode

___

### encode

▸ **encode**(`value`): `Uint8Array`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [`ReceiptMessageOut`](../index.md#receiptmessageout) |

#### Returns

`Uint8Array`

#### Overrides

Coder.encode

___

### setOffset

▸ **setOffset**(`offset`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `offset` | `number` |

#### Returns

`void`

#### Inherited from

Coder.setOffset

___

### throwError

▸ **throwError**(`message`, `value`): `never`

#### Parameters

| Name | Type |
| :------ | :------ |
| `message` | `string` |
| `value` | `unknown` |

#### Returns

`never`

#### Inherited from

Coder.throwError
10 changes: 10 additions & 0 deletions docs/packages/fuel-ts-transactions/enums/ReceiptType.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,13 @@ ___
#### Defined in

[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16)

___

### MessageOut

• **MessageOut**

#### Defined in

[packages/transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16)
26 changes: 25 additions & 1 deletion docs/packages/fuel-ts-transactions/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ nav_order: 1
- [ReceiptScriptResultCoder](classes/ReceiptScriptResultCoder.md)
- [ReceiptTransferCoder](classes/ReceiptTransferCoder.md)
- [ReceiptTransferOutCoder](classes/ReceiptTransferOutCoder.md)
- [ReceiptMessageOutCoder](classes/ReceiptMessageOutCoder.md)
- [StorageSlotCoder](classes/StorageSlotCoder.md)
- [TransactionCoder](classes/TransactionCoder.md)
- [TransactionCreateCoder](classes/TransactionCreateCoder.md)
Expand Down Expand Up @@ -263,7 +264,7 @@ ___

### Receipt

Ƭ **Receipt**: [`ReceiptCall`](index.md#receiptcall) \| [`ReceiptReturn`](index.md#receiptreturn) \| [`ReceiptReturnData`](index.md#receiptreturndata) \| [`ReceiptPanic`](index.md#receiptpanic) \| [`ReceiptRevert`](index.md#receiptrevert) \| [`ReceiptLog`](index.md#receiptlog) \| [`ReceiptLogData`](index.md#receiptlogdata) \| [`ReceiptTransfer`](index.md#receipttransfer) \| [`ReceiptTransferOut`](index.md#receipttransferout) \| [`ReceiptScriptResult`](index.md#receiptscriptresult)
Ƭ **Receipt**: [`ReceiptCall`](index.md#receiptcall) \| [`ReceiptReturn`](index.md#receiptreturn) \| [`ReceiptReturnData`](index.md#receiptreturndata) \| [`ReceiptPanic`](index.md#receiptpanic) \| [`ReceiptRevert`](index.md#receiptrevert) \| [`ReceiptLog`](index.md#receiptlog) \| [`ReceiptLogData`](index.md#receiptlogdata) \| [`ReceiptTransfer`](index.md#receipttransfer) \| [`ReceiptTransferOut`](index.md#receipttransferout) \| [`ReceiptScriptResult`](index.md#receiptscriptresult) \| [`ReceiptMessageOut`](index.md#receiptmessageout)

#### Defined in

Expand Down Expand Up @@ -487,6 +488,29 @@ ___

___

### ReceiptMessageOut

Ƭ **ReceiptMessageOut**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `messageID` | `string` |
| `sender` | `string` |
| `recipient` | `string` |
| `amount` | [`BN`](../classes/internal-BN.md) |
| `nonce` | `string` |
| `digest` | `string` |
| `data` | `Uint8Array` |
| `type` | [`MessageOut`](internal.md#messageout) |

#### Defined in

[packages/transactions/src/coders/receipt.ts:548](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L548)

___

### StorageSlot

Ƭ **StorageSlot**: `Object`
Expand Down
Loading

1 comment on commit eebb0bd

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage report

St.❔
 Category Percentage Covered / Total
🟢 Statements 89.29% 3500/3920
🟡 Branches 70.74% 677/957
🟢 Functions 86.65% 701/809
🟢 Lines 89.23% 3347/3751

Test suite run success

527 tests passing in 47 suites.

Report generated by 🧪jest coverage report action from eebb0bd

Please sign in to comment.