diff --git a/docs/packages/README.md b/docs/packages/README.md index f6998b828f3..bbf2e0c070d 100644 --- a/docs/packages/README.md +++ b/docs/packages/README.md @@ -10,5 +10,8 @@ nav_order: 1 ## Modules +- [@fuel-ts/abi-coder](fuel-ts-abi-coder/index.md) +- [@fuel-ts/contract](fuel-ts-contract/index.md) - [@fuel-ts/providers](fuel-ts-providers/index.md) +- [@fuel-ts/transactions](fuel-ts-transactions/index.md) - [@fuel-ts/wallet](fuel-ts-wallet/index.md) diff --git a/docs/packages/fuel-ts-abi-coder/classes/AbiCoder.md b/docs/packages/fuel-ts-abi-coder/classes/AbiCoder.md new file mode 100644 index 00000000000..d1ca99692f6 --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/AbiCoder.md @@ -0,0 +1,83 @@ +--- +layout: default +title: AbiCoder +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: AbiCoder + +[@fuel-ts/abi-coder](../index.md).AbiCoder + +## Constructors + +### constructor + +• **new AbiCoder**() + +#### Defined in + +[abi-coder/src/abi-coder.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L20) + +## Methods + +### decode + +▸ **decode**(`types`, `data`): [`DecodedValue`](../index.md#decodedvalue) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `types` | readonly (`string` \| `ParamType`)[] | +| `data` | `BytesLike` | + +#### Returns + +[`DecodedValue`](../index.md#decodedvalue) + +#### Defined in + +[abi-coder/src/abi-coder.ts:67](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L67) + +___ + +### encode + +▸ **encode**(`types`, `values`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `types` | readonly (`string` \| `ParamType`)[] | +| `values` | readonly [`Values`](../index.md#values)[] | + +#### Returns + +`string` + +#### Defined in + +[abi-coder/src/abi-coder.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L54) + +___ + +### getCoder + +▸ **getCoder**(`param`): [`Coder`](Coder.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `param` | `ParamType` | + +#### Returns + +[`Coder`](Coder.md) + +#### Defined in + +[abi-coder/src/abi-coder.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/abi-coder.ts#L24) diff --git a/docs/packages/fuel-ts-abi-coder/classes/ArrayCoder.md b/docs/packages/fuel-ts-abi-coder/classes/ArrayCoder.md new file mode 100644 index 00000000000..5739fac5f44 --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/ArrayCoder.md @@ -0,0 +1,175 @@ +--- +layout: default +title: ArrayCoder +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: ArrayCoder + +[@fuel-ts/abi-coder](../index.md).ArrayCoder + +## Hierarchy + +- [`Coder`](Coder.md) + + ↳ **`ArrayCoder`** + +## Constructors + +### constructor + +• **new ArrayCoder**(`coder`, `length`, `localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `coder` | [`Coder`](Coder.md) | +| `length` | `number` | +| `localName` | `string` | + +#### Overrides + +[Coder](Coder.md).[constructor](Coder.md#constructor) + +#### Defined in + +[abi-coder/src/coders/array.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L12) + +## Properties + +### coder + +• **coder**: [`Coder`](Coder.md) + +#### Defined in + +[abi-coder/src/coders/array.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L8) + +___ + +### length + +• **length**: `number` + +#### Defined in + +[abi-coder/src/coders/array.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L10) + +___ + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +[Coder](Coder.md).[localName](Coder.md#localname) + +#### Defined in + +[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](Coder.md).[name](Coder.md#name) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L28) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +[Coder](Coder.md).[type](Coder.md#type) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L32) + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`DecodedValue`](../index.md#decodedvalue), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`DecodedValue`](../index.md#decodedvalue), `number`] + +#### Overrides + +[Coder](Coder.md).[decode](Coder.md#decode) + +#### Defined in + +[abi-coder/src/coders/array.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L36) + +___ + +### encode + +▸ **encode**(`value`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `string` \| [`Values`](../index.md#values)[] | + +#### Returns + +`any` + +#### Overrides + +[Coder](Coder.md).[encode](Coder.md#encode) + +#### Defined in + +[abi-coder/src/coders/array.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/array.ts#L20) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +[Coder](Coder.md).[throwError](Coder.md#throwerror) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L45) diff --git a/docs/packages/fuel-ts-abi-coder/classes/B256Coder.md b/docs/packages/fuel-ts-abi-coder/classes/B256Coder.md new file mode 100644 index 00000000000..dd6ba1da18e --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/B256Coder.md @@ -0,0 +1,154 @@ +--- +layout: default +title: B256Coder +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: B256Coder + +[@fuel-ts/abi-coder](../index.md).B256Coder + +## Hierarchy + +- [`Coder`](Coder.md) + + ↳ **`B256Coder`** + +## Constructors + +### constructor + +• **new B256Coder**(`localName`, `type`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | +| `type` | `string` | + +#### Overrides + +[Coder](Coder.md).[constructor](Coder.md#constructor) + +#### Defined in + +[abi-coder/src/coders/b256.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b256.ts#L9) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +[Coder](Coder.md).[localName](Coder.md#localname) + +#### Defined in + +[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](Coder.md).[name](Coder.md#name) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L28) + +___ + +### type + +• **type**: `string` + +#### Overrides + +[Coder](Coder.md).[type](Coder.md#type) + +#### Defined in + +[abi-coder/src/coders/b256.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b256.ts#L7) + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [`string`, `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[`string`, `number`] + +#### Overrides + +[Coder](Coder.md).[decode](Coder.md#decode) + +#### Defined in + +[abi-coder/src/coders/b256.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b256.ts#L28) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `string` | + +#### Returns + +`Uint8Array` + +#### Overrides + +[Coder](Coder.md).[encode](Coder.md#encode) + +#### Defined in + +[abi-coder/src/coders/b256.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/b256.ts#L14) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +[Coder](Coder.md).[throwError](Coder.md#throwerror) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L45) diff --git a/docs/packages/fuel-ts-abi-coder/classes/BooleanCoder.md b/docs/packages/fuel-ts-abi-coder/classes/BooleanCoder.md new file mode 100644 index 00000000000..3dcf6dd6994 --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/BooleanCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: BooleanCoder +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: BooleanCoder + +[@fuel-ts/abi-coder](../index.md).BooleanCoder + +## Hierarchy + +- [`Coder`](Coder.md) + + ↳ **`BooleanCoder`** + +## Constructors + +### constructor + +• **new BooleanCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +[Coder](Coder.md).[constructor](Coder.md#constructor) + +#### Defined in + +[abi-coder/src/coders/boolean.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/boolean.ts#L7) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +[Coder](Coder.md).[localName](Coder.md#localname) + +#### Defined in + +[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](Coder.md).[name](Coder.md#name) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L28) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +[Coder](Coder.md).[type](Coder.md#type) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L32) + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [`boolean`, `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[`boolean`, `number`] + +#### Overrides + +[Coder](Coder.md).[decode](Coder.md#decode) + +#### Defined in + +[abi-coder/src/coders/boolean.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/boolean.ts#L26) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `boolean` | + +#### Returns + +`Uint8Array` + +#### Overrides + +[Coder](Coder.md).[encode](Coder.md#encode) + +#### Defined in + +[abi-coder/src/coders/boolean.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/boolean.ts#L11) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +[Coder](Coder.md).[throwError](Coder.md#throwerror) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L45) diff --git a/docs/packages/fuel-ts-abi-coder/classes/ByteCoder.md b/docs/packages/fuel-ts-abi-coder/classes/ByteCoder.md new file mode 100644 index 00000000000..e7a158c14a5 --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/ByteCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ByteCoder +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: ByteCoder + +[@fuel-ts/abi-coder](../index.md).ByteCoder + +## Hierarchy + +- [`Coder`](Coder.md) + + ↳ **`ByteCoder`** + +## Constructors + +### constructor + +• **new ByteCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +[Coder](Coder.md).[constructor](Coder.md#constructor) + +#### Defined in + +[abi-coder/src/coders/byte.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/byte.ts#L7) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +[Coder](Coder.md).[localName](Coder.md#localname) + +#### Defined in + +[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](Coder.md).[name](Coder.md#name) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L28) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +[Coder](Coder.md).[type](Coder.md#type) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L32) + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [`BigNumber`, `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[`BigNumber`, `number`] + +#### Overrides + +[Coder](Coder.md).[decode](Coder.md#decode) + +#### Defined in + +[abi-coder/src/coders/byte.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/byte.ts#L26) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `string` | + +#### Returns + +`Uint8Array` + +#### Overrides + +[Coder](Coder.md).[encode](Coder.md#encode) + +#### Defined in + +[abi-coder/src/coders/byte.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/byte.ts#L11) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +[Coder](Coder.md).[throwError](Coder.md#throwerror) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L45) diff --git a/docs/packages/fuel-ts-abi-coder/classes/Coder.md b/docs/packages/fuel-ts-abi-coder/classes/Coder.md new file mode 100644 index 00000000000..cf2e278a411 --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/Coder.md @@ -0,0 +1,141 @@ +--- +layout: default +title: Coder +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: Coder + +[@fuel-ts/abi-coder](../index.md).Coder + +## Hierarchy + +- **`Coder`** + + ↳ [`ArrayCoder`](ArrayCoder.md) + + ↳ [`B256Coder`](B256Coder.md) + + ↳ [`BooleanCoder`](BooleanCoder.md) + + ↳ [`ByteCoder`](ByteCoder.md) + + ↳ [`NumberCoder`](NumberCoder.md) + + ↳ [`StringCoder`](StringCoder.md) + + ↳ [`TupleCoder`](TupleCoder.md) + +## Constructors + +### constructor + +• **new Coder**(`name`, `type`, `localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `type` | `string` | +| `localName` | `string` | + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L38) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Defined in + +[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` + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L28) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L32) + +## Methods + +### decode + +▸ `Abstract` **decode**(`data`, `offset`, `length?`): [[`DecodedValue`](../index.md#decodedvalue), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | +| `length?` | `number` | + +#### Returns + +[[`DecodedValue`](../index.md#decodedvalue), `number`] + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:51](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L51) + +___ + +### encode + +▸ `Abstract` **encode**(`value`, `length?`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`Values`](../index.md#values) | +| `length?` | `number` | + +#### Returns + +`Uint8Array` + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:49](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L49) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L45) diff --git a/docs/packages/fuel-ts-abi-coder/classes/Fragment.md b/docs/packages/fuel-ts-abi-coder/classes/Fragment.md new file mode 100644 index 00000000000..734df7fab75 --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/Fragment.md @@ -0,0 +1,93 @@ +--- +layout: default +title: Fragment +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: Fragment + +[@fuel-ts/abi-coder](../index.md).Fragment + +## Hierarchy + +- **`Fragment`** + + ↳ [`FunctionFragment`](FunctionFragment.md) + +## Constructors + +### constructor + +• **new Fragment**(`params`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | [`FragmentParams`](../interfaces/internal-FragmentParams.md) | + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L29) + +## Properties + +### inputs + +• `Readonly` **inputs**: `ParamType`[] = `[]` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L26) + +___ + +### name + +• `Readonly` **name**: `string` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L25) + +___ + +### outputs + +• `Readonly` **outputs**: `ParamType`[] = `[]` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L27) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L24) + +## Methods + +### format + +▸ `Abstract` **format**(`format?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `format?` | `string` | + +#### Returns + +`string` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L36) diff --git a/docs/packages/fuel-ts-abi-coder/classes/FunctionFragment.md b/docs/packages/fuel-ts-abi-coder/classes/FunctionFragment.md new file mode 100644 index 00000000000..e915e990d59 --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/FunctionFragment.md @@ -0,0 +1,131 @@ +--- +layout: default +title: FunctionFragment +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: FunctionFragment + +[@fuel-ts/abi-coder](../index.md).FunctionFragment + +## Hierarchy + +- [`Fragment`](Fragment.md) + + ↳ **`FunctionFragment`** + +## Constructors + +### constructor + +• **new FunctionFragment**(`params`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | [`FragmentParams`](../interfaces/internal-FragmentParams.md) | + +#### Inherited from + +[Fragment](Fragment.md).[constructor](Fragment.md#constructor) + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L29) + +## Properties + +### inputs + +• `Readonly` **inputs**: `ParamType`[] = `[]` + +#### Inherited from + +[Fragment](Fragment.md).[inputs](Fragment.md#inputs) + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L26) + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +[Fragment](Fragment.md).[name](Fragment.md#name) + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L25) + +___ + +### outputs + +• `Readonly` **outputs**: `ParamType`[] = `[]` + +#### Inherited from + +[Fragment](Fragment.md).[outputs](Fragment.md#outputs) + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L27) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +[Fragment](Fragment.md).[type](Fragment.md#type) + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:24](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L24) + +## Methods + +### format + +▸ **format**(): `string` + +#### Returns + +`string` + +#### Overrides + +[Fragment](Fragment.md).[format](Fragment.md#format) + +#### Defined in + +[abi-coder/src/fragments/function-fragment.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/function-fragment.ts#L30) + +___ + +### fromObject + +▸ `Static` **fromObject**(`value`): [`FunctionFragment`](FunctionFragment.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`JsonFragment`](../interfaces/JsonFragment.md) | + +#### Returns + +[`FunctionFragment`](FunctionFragment.md) + +#### Defined in + +[abi-coder/src/fragments/function-fragment.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/function-fragment.ts#L18) diff --git a/docs/packages/fuel-ts-abi-coder/classes/Interface.md b/docs/packages/fuel-ts-abi-coder/classes/Interface.md new file mode 100644 index 00000000000..b30af6dea7a --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/Interface.md @@ -0,0 +1,185 @@ +--- +layout: default +title: Interface +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: Interface + +[@fuel-ts/abi-coder](../index.md).Interface + +## Constructors + +### constructor + +• **new Interface**(`fragments`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fragments` | readonly [`JsonFragment`](../interfaces/JsonFragment.md)[] | + +#### Defined in + +[abi-coder/src/interface.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L32) + +## Properties + +### abiCoder + +• `Readonly` **abiCoder**: [`AbiCoder`](AbiCoder.md) + +#### Defined in + +[abi-coder/src/interface.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L30) + +___ + +### fragments + +• `Readonly` **fragments**: [`Fragment`](Fragment.md)[] + +#### Defined in + +[abi-coder/src/interface.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L28) + +___ + +### functions + +• `Readonly` **functions**: `Object` + +#### Index signature + +▪ [name: `string`]: [`FunctionFragment`](FunctionFragment.md) + +#### Defined in + +[abi-coder/src/interface.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L29) + +## Methods + +### decodeFunctionData + +▸ **decodeFunctionData**(`functionFragment`, `data`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `functionFragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | +| `data` | `BytesLike` | + +#### Returns + +`any` + +#### Defined in + +[abi-coder/src/interface.ts:84](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L84) + +___ + +### decodeFunctionResult + +▸ **decodeFunctionResult**(`functionFragment`, `data`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `functionFragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | +| `data` | `BytesLike` | + +#### Returns + +`any` + +#### Defined in + +[abi-coder/src/interface.ts:128](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L128) + +___ + +### encodeFunctionData + +▸ **encodeFunctionData**(`functionFragment`, `values?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `functionFragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | `undefined` | +| `values` | readonly `any`[] | `[]` | + +#### Returns + +`string` + +#### Defined in + +[abi-coder/src/interface.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L100) + +___ + +### encodeFunctionResult + +▸ **encodeFunctionResult**(`functionFragment`, `values?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `functionFragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | `undefined` | +| `values` | readonly `any`[] | `[]` | + +#### Returns + +`string` + +#### Defined in + +[abi-coder/src/interface.ts:137](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L137) + +___ + +### getFunction + +▸ **getFunction**(`nameOrSignatureOrSighash`): [`FunctionFragment`](FunctionFragment.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nameOrSignatureOrSighash` | `string` | + +#### Returns + +[`FunctionFragment`](FunctionFragment.md) + +#### Defined in + +[abi-coder/src/interface.ts:61](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L61) + +___ + +### getSighash + +▸ `Static` **getSighash**(`fragment`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fragment` | `string` \| [`FunctionFragment`](FunctionFragment.md) | + +#### Returns + +`string` + +#### Defined in + +[abi-coder/src/interface.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/interface.ts#L54) diff --git a/docs/packages/fuel-ts-abi-coder/classes/NumberCoder.md b/docs/packages/fuel-ts-abi-coder/classes/NumberCoder.md new file mode 100644 index 00000000000..409d3b3f2cc --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/NumberCoder.md @@ -0,0 +1,184 @@ +--- +layout: default +title: NumberCoder +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: NumberCoder + +[@fuel-ts/abi-coder](../index.md).NumberCoder + +## Hierarchy + +- [`Coder`](Coder.md) + + ↳ **`NumberCoder`** + +## Constructors + +### constructor + +• **new NumberCoder**(`localName`, `baseType`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | +| `baseType` | `string` | + +#### Overrides + +[Coder](Coder.md).[constructor](Coder.md#constructor) + +#### Defined in + +[abi-coder/src/coders/number.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L13) + +## Properties + +### baseType + +• **baseType**: `string` + +#### Defined in + +[abi-coder/src/coders/number.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L10) + +___ + +### length + +• **length**: `number` + +#### Defined in + +[abi-coder/src/coders/number.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L9) + +___ + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +[Coder](Coder.md).[localName](Coder.md#localname) + +#### Defined in + +[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](Coder.md).[name](Coder.md#name) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L28) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +[Coder](Coder.md).[type](Coder.md#type) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L32) + +___ + +### MAX\_SAFE\_INTEGER + +▪ `Static` **MAX\_SAFE\_INTEGER**: `number` + +#### Defined in + +[abi-coder/src/coders/number.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L11) + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [`BigNumber`, `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[`BigNumber`, `number`] + +#### Overrides + +[Coder](Coder.md).[decode](Coder.md#decode) + +#### Defined in + +[abi-coder/src/coders/number.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L48) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `string` \| `number` \| `BigNumber` | + +#### Returns + +`Uint8Array` + +#### Overrides + +[Coder](Coder.md).[encode](Coder.md#encode) + +#### Defined in + +[abi-coder/src/coders/number.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/number.ts#L33) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +[Coder](Coder.md).[throwError](Coder.md#throwerror) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L45) diff --git a/docs/packages/fuel-ts-abi-coder/classes/StringCoder.md b/docs/packages/fuel-ts-abi-coder/classes/StringCoder.md new file mode 100644 index 00000000000..4cfb5f609ec --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/StringCoder.md @@ -0,0 +1,155 @@ +--- +layout: default +title: StringCoder +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: StringCoder + +[@fuel-ts/abi-coder](../index.md).StringCoder + +## Hierarchy + +- [`Coder`](Coder.md) + + ↳ **`StringCoder`** + +## Constructors + +### constructor + +• **new StringCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +[Coder](Coder.md).[constructor](Coder.md#constructor) + +#### Defined in + +[abi-coder/src/coders/string.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/string.ts#L7) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +[Coder](Coder.md).[localName](Coder.md#localname) + +#### Defined in + +[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](Coder.md).[name](Coder.md#name) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L28) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +[Coder](Coder.md).[type](Coder.md#type) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L32) + +## Methods + +### decode + +▸ **decode**(`data`, `offset`, `length`): [`string`, `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | +| `length` | `number` | + +#### Returns + +[`string`, `number`] + +#### Overrides + +[Coder](Coder.md).[decode](Coder.md#decode) + +#### Defined in + +[abi-coder/src/coders/string.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/string.ts#L18) + +___ + +### encode + +▸ **encode**(`value`, `length`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `string` | +| `length` | `number` | + +#### Returns + +`Uint8Array` + +#### Overrides + +[Coder](Coder.md).[encode](Coder.md#encode) + +#### Defined in + +[abi-coder/src/coders/string.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/string.ts#L11) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +[Coder](Coder.md).[throwError](Coder.md#throwerror) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L45) diff --git a/docs/packages/fuel-ts-abi-coder/classes/TupleCoder.md b/docs/packages/fuel-ts-abi-coder/classes/TupleCoder.md new file mode 100644 index 00000000000..9653747613f --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/classes/TupleCoder.md @@ -0,0 +1,164 @@ +--- +layout: default +title: TupleCoder +parent: "@fuel-ts/abi-coder" +nav_order: 1 + +--- + +# Class: TupleCoder + +[@fuel-ts/abi-coder](../index.md).TupleCoder + +## Hierarchy + +- [`Coder`](Coder.md) + + ↳ **`TupleCoder`** + +## Constructors + +### constructor + +• **new TupleCoder**(`coders`, `localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `coders` | [`Coder`](Coder.md)[] | +| `localName` | `string` | + +#### Overrides + +[Coder](Coder.md).[constructor](Coder.md#constructor) + +#### Defined in + +[abi-coder/src/coders/tuple.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L9) + +## Properties + +### coders + +• **coders**: [`Coder`](Coder.md)[] + +#### Defined in + +[abi-coder/src/coders/tuple.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L7) + +___ + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +[Coder](Coder.md).[localName](Coder.md#localname) + +#### Defined in + +[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](Coder.md).[name](Coder.md#name) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L28) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +[Coder](Coder.md).[type](Coder.md#type) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L32) + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`DecodedValue`](../index.md#decodedvalue), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`DecodedValue`](../index.md#decodedvalue), `number`] + +#### Overrides + +[Coder](Coder.md).[decode](Coder.md#decode) + +#### Defined in + +[abi-coder/src/coders/tuple.ts:55](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L55) + +___ + +### encode + +▸ **encode**(`value`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`Values`](../index.md#values)[] \| { [name: string]: `any`; } | + +#### Returns + +`any` + +#### Overrides + +[Coder](Coder.md).[encode](Coder.md#encode) + +#### Defined in + +[abi-coder/src/coders/tuple.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/tuple.ts#L16) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +[Coder](Coder.md).[throwError](Coder.md#throwerror) + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L45) diff --git a/docs/packages/fuel-ts-abi-coder/index.md b/docs/packages/fuel-ts-abi-coder/index.md new file mode 100644 index 00000000000..496fa5a4b0d --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/index.md @@ -0,0 +1,98 @@ +--- +layout: default +title: "@fuel-ts/abi-coder" +has_children: true +has_toc: false +nav_order: 1 +--- + +# Module: @fuel-ts/abi-coder + +## Namespaces + +- [internal](namespaces/internal.md) + +## Classes + +- [AbiCoder](classes/AbiCoder.md) +- [ArrayCoder](classes/ArrayCoder.md) +- [B256Coder](classes/B256Coder.md) +- [BooleanCoder](classes/BooleanCoder.md) +- [ByteCoder](classes/ByteCoder.md) +- [Coder](classes/Coder.md) +- [Fragment](classes/Fragment.md) +- [FunctionFragment](classes/FunctionFragment.md) +- [Interface](classes/Interface.md) +- [NumberCoder](classes/NumberCoder.md) +- [StringCoder](classes/StringCoder.md) +- [TupleCoder](classes/TupleCoder.md) + +## Interfaces + +- [JsonFragment](interfaces/JsonFragment.md) +- [JsonFragmentType](interfaces/JsonFragmentType.md) + +## Type aliases + +### DecodedValue + +Ƭ **DecodedValue**: `string` \| `number` \| `boolean` \| `BN` \| [`DecodedValue`](index.md#decodedvalue)[] \| { [key: string]: [`DecodedValue`](index.md#decodedvalue); } + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L17) + +___ + +### Values + +Ƭ **Values**: `string` \| `boolean` \| `BN` \| `number` \| `BytesLike` \| `BigInt` \| [`Values`](index.md#values)[] \| { [key: string]: [`Values`](index.md#values); } + +#### Defined in + +[abi-coder/src/coders/abstract-coder.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/abstract-coder.ts#L7) + +## Functions + +### getBytes + +▸ **getBytes**(`value`): `Uint8Array` + +Convert value to a Byte Array + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `BigNumberish` | + +#### Returns + +`Uint8Array` + +#### Defined in + +[abi-coder/src/coders/utilities.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/utilities.ts#L11) + +___ + +### pad + +▸ **pad**(`bytes`, `wordSize`): `Uint8Array` + +Pad a bytes array depending on word size + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bytes` | `Uint8Array` | +| `wordSize` | `number` | + +#### Returns + +`Uint8Array` + +#### Defined in + +[abi-coder/src/coders/utilities.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/coders/utilities.ts#L18) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFragment.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonFragment.md new file mode 100644 index 00000000000..605584f97ea --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/interfaces/JsonFragment.md @@ -0,0 +1,51 @@ +--- +layout: default +title: JsonFragment +parent: "@fuel-ts/abi-coder" +nav_order: 2 + +--- + +# Interface: JsonFragment + +[@fuel-ts/abi-coder](../index.md).JsonFragment + +## Properties + +### inputs + +• `Optional` `Readonly` **inputs**: readonly [`JsonFragmentType`](JsonFragmentType.md)[] + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L12) + +___ + +### name + +• `Readonly` **name**: `string` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L10) + +___ + +### outputs + +• `Optional` `Readonly` **outputs**: readonly [`JsonFragmentType`](JsonFragmentType.md)[] + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L13) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L11) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/JsonFragmentType.md b/docs/packages/fuel-ts-abi-coder/interfaces/JsonFragmentType.md new file mode 100644 index 00000000000..9050ed5c1a4 --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/interfaces/JsonFragmentType.md @@ -0,0 +1,41 @@ +--- +layout: default +title: JsonFragmentType +parent: "@fuel-ts/abi-coder" +nav_order: 2 + +--- + +# Interface: JsonFragmentType + +[@fuel-ts/abi-coder](../index.md).JsonFragmentType + +## Properties + +### components + +• `Optional` `Readonly` **components**: readonly [`JsonFragmentType`](JsonFragmentType.md)[] + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L6) + +___ + +### name + +• `Optional` `Readonly` **name**: `string` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:4](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L4) + +___ + +### type + +• `Optional` `Readonly` **type**: `string` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L5) diff --git a/docs/packages/fuel-ts-abi-coder/interfaces/internal-FragmentParams.md b/docs/packages/fuel-ts-abi-coder/interfaces/internal-FragmentParams.md new file mode 100644 index 00000000000..9b80683900f --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/interfaces/internal-FragmentParams.md @@ -0,0 +1,51 @@ +--- +layout: default +title: FragmentParams +parent: "@fuel-ts/abi-coder" +nav_order: 2 + +--- + +# Interface: FragmentParams + +[@fuel-ts/abi-coder](../index.md).[internal](../namespaces/internal.md).FragmentParams + +## Properties + +### inputs + +• `Readonly` **inputs**: `ParamType`[] + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L19) + +___ + +### name + +• `Readonly` **name**: `string` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L18) + +___ + +### outputs + +• `Readonly` **outputs**: `ParamType`[] + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L20) + +___ + +### type + +• `Readonly` **type**: `string` + +#### Defined in + +[abi-coder/src/fragments/fragment.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/abi-coder/src/fragments/fragment.ts#L17) diff --git a/docs/packages/fuel-ts-abi-coder/namespaces/internal.md b/docs/packages/fuel-ts-abi-coder/namespaces/internal.md new file mode 100644 index 00000000000..11930059387 --- /dev/null +++ b/docs/packages/fuel-ts-abi-coder/namespaces/internal.md @@ -0,0 +1,15 @@ +--- +layout: default +title: internal +parent: "@fuel-ts/abi-coder" +nav_order: 3 + +--- + +# Namespace: internal + +[@fuel-ts/abi-coder](../index.md).internal + +## Interfaces + +- [FragmentParams](../interfaces/internal-FragmentParams.md) diff --git a/docs/packages/fuel-ts-contract/classes/Contract.md b/docs/packages/fuel-ts-contract/classes/Contract.md new file mode 100644 index 00000000000..7a45aae78a7 --- /dev/null +++ b/docs/packages/fuel-ts-contract/classes/Contract.md @@ -0,0 +1,95 @@ +--- +layout: default +title: Contract +parent: "@fuel-ts/contract" +nav_order: 1 + +--- + +# Class: Contract + +[@fuel-ts/contract](../index.md).Contract + +## Constructors + +### constructor + +• **new Contract**(`id`, `abi`, `signerOrProvider?`, `transactionId?`, `request?`) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `id` | `string` | `undefined` | +| `abi` | readonly [`JsonFragment`](../../fuel-ts-abi-coder/interfaces/JsonFragment.md)[] \| `default` | `undefined` | +| `signerOrProvider` | ``null`` \| `default` | `null` | +| `transactionId?` | `string` | `undefined` | +| `request?` | [`TransactionRequest`](../../fuel-ts-providers/index.md#transactionrequest) | `undefined` | + +#### Defined in + +[contract/src/contract.ts:52](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract.ts#L52) + +## Properties + +### functions + +• **functions**: `Object` + +#### Index signature + +▪ [key: `string`]: `any` + +#### Defined in + +[contract/src/contract.ts:50](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract.ts#L50) + +___ + +### id + +• **id**: `string` + +#### Defined in + +[contract/src/contract.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract.ts#L45) + +___ + +### interface + +• **interface**: `default` + +#### Defined in + +[contract/src/contract.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract.ts#L44) + +___ + +### provider + +• **provider**: ``null`` \| `default` + +#### Defined in + +[contract/src/contract.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract.ts#L46) + +___ + +### request + +• `Optional` **request**: [`TransactionRequest`](../../fuel-ts-providers/index.md#transactionrequest) + +#### Defined in + +[contract/src/contract.ts:48](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract.ts#L48) + +___ + +### transaction + +• `Optional` **transaction**: `string` + +#### Defined in + +[contract/src/contract.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract.ts#L47) diff --git a/docs/packages/fuel-ts-contract/classes/ContractFactory.md b/docs/packages/fuel-ts-contract/classes/ContractFactory.md new file mode 100644 index 00000000000..015a81ef5a2 --- /dev/null +++ b/docs/packages/fuel-ts-contract/classes/ContractFactory.md @@ -0,0 +1,107 @@ +--- +layout: default +title: ContractFactory +parent: "@fuel-ts/contract" +nav_order: 1 + +--- + +# Class: ContractFactory + +[@fuel-ts/contract](../index.md).ContractFactory + +## Constructors + +### constructor + +• **new ContractFactory**(`bytecode`, `abi`, `signerOrProvider?`) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `bytecode` | `BytesLike` | `undefined` | +| `abi` | readonly [`JsonFragment`](../../fuel-ts-abi-coder/interfaces/JsonFragment.md)[] \| `default` | `undefined` | +| `signerOrProvider` | ``null`` \| `default` | `null` | + +#### Defined in + +[contract/src/contract-factory.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L17) + +## Properties + +### bytecode + +• **bytecode**: `BytesLike` + +#### Defined in + +[contract/src/contract-factory.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L13) + +___ + +### interface + +• **interface**: `default` + +#### Defined in + +[contract/src/contract-factory.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L14) + +___ + +### provider + +• **provider**: ``null`` \| `default` + +#### Defined in + +[contract/src/contract-factory.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L15) + +## Accessors + +### genBytes32 + +• `get` **genBytes32**(): `string` + +#### Returns + +`string` + +#### Defined in + +[contract/src/contract-factory.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L36) + +## Methods + +### connect + +▸ **connect**(`provider`): [`ContractFactory`](ContractFactory.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `provider` | ``null`` \| `default` | + +#### Returns + +[`ContractFactory`](ContractFactory.md) + +#### Defined in + +[contract/src/contract-factory.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L40) + +___ + +### deployContract + +▸ **deployContract**(): `Promise`<[`Contract`](Contract.md)\> + +#### Returns + +`Promise`<[`Contract`](Contract.md)\> + +#### Defined in + +[contract/src/contract-factory.ts:44](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract-factory.ts#L44) diff --git a/docs/packages/fuel-ts-contract/index.md b/docs/packages/fuel-ts-contract/index.md new file mode 100644 index 00000000000..5a1c213200a --- /dev/null +++ b/docs/packages/fuel-ts-contract/index.md @@ -0,0 +1,32 @@ +--- +layout: default +title: "@fuel-ts/contract" +has_children: true +has_toc: false +nav_order: 1 +--- + +# Module: @fuel-ts/contract + +## Classes + +- [Contract](classes/Contract.md) +- [ContractFactory](classes/ContractFactory.md) + +## Type aliases + +### Overrides + +Ƭ **Overrides**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `gasLimit` | `BigNumberish` | +| `gasPrice` | `BigNumberish` | +| `maturity` | `BigNumberish` | + +#### Defined in + +[contract/src/contract.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/contract/src/contract.ts#L11) diff --git a/docs/packages/fuel-ts-providers/classes/Provider.md b/docs/packages/fuel-ts-providers/classes/Provider.md index 3c8bcc7ed84..ed828a44226 100644 --- a/docs/packages/fuel-ts-providers/classes/Provider.md +++ b/docs/packages/fuel-ts-providers/classes/Provider.md @@ -26,7 +26,7 @@ A provider for connecting to a Fuel node #### Defined in -[providers/src/provider.ts:147](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L147) +[providers/src/provider.ts:147](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L147) ## Properties @@ -58,7 +58,7 @@ A provider for connecting to a Fuel node #### Defined in -[providers/src/provider.ts:145](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L145) +[providers/src/provider.ts:145](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L145) ___ @@ -86,7 +86,7 @@ Executes a transaction without actually submitting it to the chain #### Defined in -[providers/src/provider.ts:225](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L225) +[providers/src/provider.ts:225](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L225) ___ @@ -108,7 +108,7 @@ Returns block matching the given ID or type #### Defined in -[providers/src/provider.ts:387](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L387) +[providers/src/provider.ts:387](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L387) ___ @@ -124,13 +124,13 @@ Returns the current block number #### Defined in -[providers/src/provider.ts:176](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L176) +[providers/src/provider.ts:176](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L176) ___ ### getBlockWithTransactions -▸ **getBlockWithTransactions**(`idOrHeight`): `Promise`<``null`` \| [`Block`](../index.md#block) & { `transactions`: [`Transaction`](../namespaces/internal.md#transaction)[] }\> +▸ **getBlockWithTransactions**(`idOrHeight`): `Promise`<``null`` \| [`Block`](../index.md#block) & { `transactions`: [`Transaction`](../../fuel-ts-transactions/index.md#transaction)[] }\> Returns block matching the given ID or type, including transaction data @@ -142,11 +142,11 @@ Returns block matching the given ID or type, including transaction data #### Returns -`Promise`<``null`` \| [`Block`](../index.md#block) & { `transactions`: [`Transaction`](../namespaces/internal.md#transaction)[] }\> +`Promise`<``null`` \| [`Block`](../index.md#block) & { `transactions`: [`Transaction`](../../fuel-ts-transactions/index.md#transaction)[] }\> #### Defined in -[providers/src/provider.ts:418](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L418) +[providers/src/provider.ts:418](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L418) ___ @@ -170,7 +170,7 @@ Returns coins for the given owner #### Defined in -[providers/src/provider.ts:239](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L239) +[providers/src/provider.ts:239](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L239) ___ @@ -186,13 +186,13 @@ Returns the network configuration of the connected Fuel node #### Defined in -[providers/src/provider.ts:166](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L166) +[providers/src/provider.ts:166](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L166) ___ ### getTransaction -▸ **getTransaction**(`transactionId`): `Promise`<``null`` \| [`Transaction`](../namespaces/internal.md#transaction)\> +▸ **getTransaction**(`transactionId`): `Promise`<``null`` \| [`Transaction`](../../fuel-ts-transactions/index.md#transaction)\> Get transaction with the given ID @@ -204,11 +204,11 @@ Get transaction with the given ID #### Returns -`Promise`<``null`` \| [`Transaction`](../namespaces/internal.md#transaction)\> +`Promise`<``null`` \| [`Transaction`](../../fuel-ts-transactions/index.md#transaction)\> #### Defined in -[providers/src/provider.ts:452](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L452) +[providers/src/provider.ts:452](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L452) ___ @@ -224,7 +224,7 @@ Returns the version of the connected Fuel node #### Defined in -[providers/src/provider.ts:158](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L158) +[providers/src/provider.ts:158](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L158) ___ @@ -246,7 +246,7 @@ Submits a transaction to the chain to be executed #### Defined in -[providers/src/provider.ts:184](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L184) +[providers/src/provider.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L184) ___ @@ -269,7 +269,7 @@ Submits a Create transaction to the chain for contract deployment #### Defined in -[providers/src/provider.ts:269](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L269) +[providers/src/provider.ts:269](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L269) ___ @@ -292,4 +292,4 @@ Submits a Script transaction to the chain for contract execution #### Defined in -[providers/src/provider.ts:303](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L303) +[providers/src/provider.ts:303](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L303) diff --git a/docs/packages/fuel-ts-providers/enums/internal-GqlCoinStatus.md b/docs/packages/fuel-ts-providers/enums/internal-GqlCoinStatus.md index 7770adc0f45..f661e48cba6 100644 --- a/docs/packages/fuel-ts-providers/enums/internal-GqlCoinStatus.md +++ b/docs/packages/fuel-ts-providers/enums/internal-GqlCoinStatus.md @@ -18,7 +18,7 @@ nav_order: 4 #### Defined in -[providers/src/operations.ts:112](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L112) +[providers/src/operations.ts:112](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L112) ___ @@ -28,4 +28,4 @@ ___ #### Defined in -[providers/src/operations.ts:113](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L113) +[providers/src/operations.ts:113](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L113) diff --git a/docs/packages/fuel-ts-providers/enums/internal-GqlReturnType.md b/docs/packages/fuel-ts-providers/enums/internal-GqlReturnType.md index 440e588f197..561d964c625 100644 --- a/docs/packages/fuel-ts-providers/enums/internal-GqlReturnType.md +++ b/docs/packages/fuel-ts-providers/enums/internal-GqlReturnType.md @@ -18,7 +18,7 @@ nav_order: 4 #### Defined in -[providers/src/operations.ts:331](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L331) +[providers/src/operations.ts:331](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L331) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[providers/src/operations.ts:332](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L332) +[providers/src/operations.ts:332](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L332) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -[providers/src/operations.ts:333](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L333) +[providers/src/operations.ts:333](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L333) diff --git a/docs/packages/fuel-ts-providers/index.md b/docs/packages/fuel-ts-providers/index.md index 062b13f4dc9..c9349074dea 100644 --- a/docs/packages/fuel-ts-providers/index.md +++ b/docs/packages/fuel-ts-providers/index.md @@ -40,7 +40,7 @@ A Fuel block #### Defined in -[providers/src/provider.ts:74](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L74) +[providers/src/provider.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L74) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[providers/src/provider.ts:38](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L38) +[providers/src/provider.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L38) ___ @@ -79,7 +79,7 @@ A Fuel coin #### Defined in -[providers/src/provider.ts:85](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L85) +[providers/src/provider.ts:85](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L85) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[providers/src/transaction-request/transaction-request.ts:36](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/transaction-request.ts#L36) +[providers/src/transaction-request/transaction-request.ts:36](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L36) ___ @@ -127,7 +127,7 @@ https://relay.dev/graphql/connections.htm#sec-Arguments #### Defined in -[providers/src/provider.ts:120](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L120) +[providers/src/provider.ts:120](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L120) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[providers/src/transaction-request/transaction-request.ts:17](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/transaction-request.ts#L17) +[providers/src/transaction-request/transaction-request.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L17) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -[providers/src/transaction-request/transaction-request.ts:57](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/transaction-request.ts#L57) +[providers/src/transaction-request/transaction-request.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L57) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -[providers/src/transaction-request/input.ts:32](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/input.ts#L32) +[providers/src/transaction-request/input.ts:32](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L32) ___ @@ -181,7 +181,7 @@ ___ #### Defined in -[providers/src/transaction-request/output.ts:46](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/output.ts#L46) +[providers/src/transaction-request/output.ts:46](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L46) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -[providers/src/provider.ts:62](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L62) +[providers/src/provider.ts:62](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L62) ___ @@ -218,17 +218,17 @@ ___ #### Defined in -[providers/src/provider.ts:54](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L54) +[providers/src/provider.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L54) ___ ### TransactionResultReceipt -Ƭ **TransactionResultReceipt**: [`ReceiptCall`](namespaces/internal.md#receiptcall) \| [`ReceiptReturn`](namespaces/internal.md#receiptreturn) \| [`ReceiptReturnData`](namespaces/internal.md#receiptreturndata) & { `data`: `string` } \| [`ReceiptPanic`](namespaces/internal.md#receiptpanic) \| [`ReceiptRevert`](namespaces/internal.md#receiptrevert) \| [`ReceiptLog`](namespaces/internal.md#receiptlog) \| [`ReceiptLogData`](namespaces/internal.md#receiptlogdata) & { `data`: `string` } \| [`ReceiptTransfer`](namespaces/internal.md#receipttransfer) \| [`ReceiptTransferOut`](namespaces/internal.md#receipttransferout) \| [`ReceiptScriptResult`](namespaces/internal.md#receiptscriptresult) +Ƭ **TransactionResultReceipt**: [`ReceiptCall`](../fuel-ts-transactions/index.md#receiptcall) \| [`ReceiptReturn`](../fuel-ts-transactions/index.md#receiptreturn) \| [`ReceiptReturnData`](../fuel-ts-transactions/index.md#receiptreturndata) & { `data`: `string` } \| [`ReceiptPanic`](../fuel-ts-transactions/index.md#receiptpanic) \| [`ReceiptRevert`](../fuel-ts-transactions/index.md#receiptrevert) \| [`ReceiptLog`](../fuel-ts-transactions/index.md#receiptlog) \| [`ReceiptLogData`](../fuel-ts-transactions/index.md#receiptlogdata) & { `data`: `string` } \| [`ReceiptTransfer`](../fuel-ts-transactions/index.md#receipttransfer) \| [`ReceiptTransferOut`](../fuel-ts-transactions/index.md#receipttransferout) \| [`ReceiptScriptResult`](../fuel-ts-transactions/index.md#receiptscriptresult) #### Defined in -[providers/src/provider.ts:42](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/provider.ts#L42) +[providers/src/provider.ts:42](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/provider.ts#L42) ## Functions @@ -249,7 +249,7 @@ ___ #### Defined in -[providers/src/util.ts:28](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/util.ts#L28) +[providers/src/util.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/util.ts#L28) ___ @@ -270,27 +270,27 @@ ___ #### Defined in -[providers/src/util.ts:22](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/util.ts#L22) +[providers/src/util.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/util.ts#L22) ___ ### getSignableTransaction -▸ `Const` **getSignableTransaction**(`transaction`): [`Transaction`](namespaces/internal.md#transaction) +▸ `Const` **getSignableTransaction**(`transaction`): [`Transaction`](../fuel-ts-transactions/index.md#transaction) #### Parameters | Name | Type | | :------ | :------ | -| `transaction` | [`Transaction`](namespaces/internal.md#transaction) | +| `transaction` | [`Transaction`](../fuel-ts-transactions/index.md#transaction) | #### Returns -[`Transaction`](namespaces/internal.md#transaction) +[`Transaction`](../fuel-ts-transactions/index.md#transaction) #### Defined in -[providers/src/util.ts:35](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/util.ts#L35) +[providers/src/util.ts:35](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/util.ts#L35) ___ @@ -302,7 +302,7 @@ ___ | Name | Type | | :------ | :------ | -| `transaction` | [`Transaction`](namespaces/internal.md#transaction) | +| `transaction` | [`Transaction`](../fuel-ts-transactions/index.md#transaction) | #### Returns @@ -310,13 +310,13 @@ ___ #### Defined in -[providers/src/util.ts:98](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/util.ts#L98) +[providers/src/util.ts:98](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/util.ts#L98) ___ ### inputify -▸ `Const` **inputify**(`value`): [`Input`](namespaces/internal.md#input) +▸ `Const` **inputify**(`value`): [`Input`](../fuel-ts-transactions/index.md#input) #### Parameters @@ -326,17 +326,17 @@ ___ #### Returns -[`Input`](namespaces/internal.md#input) +[`Input`](../fuel-ts-transactions/index.md#input) #### Defined in -[providers/src/transaction-request/input.ts:34](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/input.ts#L34) +[providers/src/transaction-request/input.ts:34](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L34) ___ ### outputify -▸ `Const` **outputify**(`value`): [`Output`](namespaces/internal.md#output) +▸ `Const` **outputify**(`value`): [`Output`](../fuel-ts-transactions/index.md#output) #### Parameters @@ -346,17 +346,17 @@ ___ #### Returns -[`Output`](namespaces/internal.md#output) +[`Output`](../fuel-ts-transactions/index.md#output) #### Defined in -[providers/src/transaction-request/output.ts:54](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/output.ts#L54) +[providers/src/transaction-request/output.ts:54](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L54) ___ ### transactionFromRequest -▸ `Const` **transactionFromRequest**(`transactionRequest`): [`Transaction`](namespaces/internal.md#transaction) +▸ `Const` **transactionFromRequest**(`transactionRequest`): [`Transaction`](../fuel-ts-transactions/index.md#transaction) #### Parameters @@ -366,8 +366,8 @@ ___ #### Returns -[`Transaction`](namespaces/internal.md#transaction) +[`Transaction`](../fuel-ts-transactions/index.md#transaction) #### Defined in -[providers/src/transaction-request/transaction-request.ts:59](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/transaction-request.ts#L59) +[providers/src/transaction-request/transaction-request.ts:59](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/transaction-request.ts#L59) diff --git a/docs/packages/fuel-ts-providers/namespaces/internal.md b/docs/packages/fuel-ts-providers/namespaces/internal.md index 995ae425501..b51e0c20821 100644 --- a/docs/packages/fuel-ts-providers/namespaces/internal.md +++ b/docs/packages/fuel-ts-providers/namespaces/internal.md @@ -15,156 +15,6 @@ nav_order: 3 - [GqlCoinStatus](../enums/internal-GqlCoinStatus.md) - [GqlReturnType](../enums/internal-GqlReturnType.md) -## Enumeration members - -### Call - -• **Call**: `Object` = `0` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:4 - -___ - -### Change - -• **Change**: `Object` = `3` - -#### Defined in - -transactions/dist/coders/output.d.ts:7 - -___ - -### Contract - -• **Contract**: `Object` = `1` - -#### Defined in - -transactions/dist/coders/input.d.ts:6 - -___ - -### ContractCreated - -• **ContractCreated**: `Object` = `5` - -#### Defined in - -transactions/dist/coders/output.d.ts:9 - -___ - -### Log - -• **Log**: `Object` = `5` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:9 - -___ - -### LogData - -• **LogData**: `Object` = `6` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:10 - -___ - -### Panic - -• **Panic**: `Object` = `3` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:7 - -___ - -### Return - -• **Return**: `Object` = `1` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:5 - -___ - -### ReturnData - -• **ReturnData**: `Object` = `2` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:6 - -___ - -### Revert - -• **Revert**: `Object` = `4` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:8 - -___ - -### ScriptResult - -• **ScriptResult**: `Object` = `9` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:13 - -___ - -### Transfer - -• **Transfer**: `Object` = `7` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:11 - -___ - -### TransferOut - -• **TransferOut**: `Object` = `8` - -#### Defined in - -transactions/dist/coders/receipt.d.ts:12 - -___ - -### Variable - -• **Variable**: `Object` = `4` - -#### Defined in - -transactions/dist/coders/output.d.ts:8 - -___ - -### Withdrawal - -• **Withdrawal**: `Object` = `2` - -#### Defined in - -transactions/dist/coders/output.d.ts:6 - ## Type aliases ### ChangeTransactionRequestOutput @@ -177,11 +27,11 @@ transactions/dist/coders/output.d.ts:6 | :------ | :------ | :------ | | `color` | `BytesLike` | Color of coins | | `to` | `BytesLike` | Receiving address or script hash | -| `type` | [`Change`](internal.md#change) | - | +| `type` | `OutputType.Change` | - | #### Defined in -[providers/src/transaction-request/output.ts:31](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/output.ts#L31) +[providers/src/transaction-request/output.ts:31](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L31) ___ @@ -205,7 +55,7 @@ ___ #### Defined in -[providers/src/transaction-request/input.ts:8](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/input.ts#L8) +[providers/src/transaction-request/input.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L8) ___ @@ -224,7 +74,7 @@ ___ #### Defined in -[providers/src/transaction-request/output.ts:8](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/output.ts#L8) +[providers/src/transaction-request/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L8) ___ @@ -237,11 +87,11 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | | `contractId` | `BytesLike` | Contract ID | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | +| `type` | `OutputType.ContractCreated` | - | #### Defined in -[providers/src/transaction-request/output.ts:41](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/output.ts#L41) +[providers/src/transaction-request/output.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L41) ___ @@ -254,11 +104,11 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | | `contractId` | `BytesLike` | Contract ID | -| `type` | [`Contract`](internal.md#contract) | - | +| `type` | `InputType.Contract` | - | #### Defined in -[providers/src/transaction-request/input.ts:27](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/input.ts#L27) +[providers/src/transaction-request/input.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/input.ts#L27) ___ @@ -275,7 +125,7 @@ ___ #### Defined in -[providers/src/transaction-request/output.ts:17](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/output.ts#L17) +[providers/src/transaction-request/output.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L17) ___ @@ -291,7 +141,7 @@ ___ #### Defined in -[providers/src/operations.ts:6](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L6) +[providers/src/operations.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L6) ___ @@ -308,7 +158,7 @@ ___ #### Defined in -[providers/src/operations.ts:97](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L97) +[providers/src/operations.ts:97](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L97) ___ @@ -325,7 +175,7 @@ ___ #### Defined in -[providers/src/operations.ts:818](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L818) +[providers/src/operations.ts:818](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L818) ___ @@ -342,7 +192,7 @@ ___ #### Defined in -[providers/src/operations.ts:842](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L842) +[providers/src/operations.ts:842](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L842) ___ @@ -359,7 +209,7 @@ ___ #### Defined in -[providers/src/operations.ts:849](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L849) +[providers/src/operations.ts:849](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L849) ___ @@ -376,7 +226,7 @@ ___ #### Defined in -[providers/src/operations.ts:665](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L665) +[providers/src/operations.ts:665](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L665) ___ @@ -393,7 +243,7 @@ ___ #### Defined in -[providers/src/operations.ts:685](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L685) +[providers/src/operations.ts:685](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L685) ___ @@ -412,7 +262,7 @@ ___ #### Defined in -[providers/src/operations.ts:733](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L733) +[providers/src/operations.ts:733](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L733) ___ @@ -440,7 +290,7 @@ ___ #### Defined in -[providers/src/operations.ts:462](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L462) +[providers/src/operations.ts:462](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L462) ___ @@ -457,7 +307,7 @@ ___ #### Defined in -[providers/src/operations.ts:762](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L762) +[providers/src/operations.ts:762](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L762) ___ @@ -476,7 +326,7 @@ ___ #### Defined in -[providers/src/operations.ts:787](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L787) +[providers/src/operations.ts:787](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L787) ___ @@ -493,7 +343,7 @@ ___ #### Defined in -[providers/src/operations.ts:484](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L484) +[providers/src/operations.ts:484](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L484) ___ @@ -510,7 +360,7 @@ ___ #### Defined in -[providers/src/operations.ts:518](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L518) +[providers/src/operations.ts:518](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L518) ___ @@ -529,7 +379,7 @@ ___ #### Defined in -[providers/src/operations.ts:616](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L616) +[providers/src/operations.ts:616](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L616) ___ @@ -548,7 +398,7 @@ ___ #### Defined in -[providers/src/operations.ts:564](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L564) +[providers/src/operations.ts:564](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L564) ___ @@ -565,7 +415,7 @@ ___ #### Defined in -[providers/src/operations.ts:458](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L458) +[providers/src/operations.ts:458](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L458) ___ @@ -582,7 +432,7 @@ ___ #### Defined in -[providers/src/operations.ts:855](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L855) +[providers/src/operations.ts:855](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L855) ___ @@ -599,7 +449,7 @@ ___ #### Defined in -[providers/src/operations.ts:836](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L836) +[providers/src/operations.ts:836](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L836) ___ @@ -616,63 +466,7 @@ ___ #### Defined in -[providers/src/operations.ts:832](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L832) - -___ - -### Input - -Ƭ **Input**: [`InputCoin`](internal.md#inputcoin) \| [`InputContract`](internal.md#inputcontract) - -#### Defined in - -transactions/dist/coders/input.d.ts:52 - -___ - -### InputCoin - -Ƭ **InputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `BigNumber` | Amount of coins (u64) | -| `color` | `string` | Color of the coins (b256) | -| `maturity` | `BigNumber` | UTXO being spent must have been created at least this many blocks ago (u64) | -| `owner` | `string` | Owning address or script hash (b256) | -| `predicate` | `string` | Predicate bytecode (byte[]) | -| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | -| `predicateDataLength` | `BigNumber` | Length of predicate input data, in bytes (u16) | -| `predicateLength` | `BigNumber` | Length of predicate, in instructions (u16) | -| `type` | [`Coin`](../index.md#coin) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | -| `witnessIndex` | `BigNumber` | Index of witness that authorizes spending the coin (u8) | - -#### Defined in - -transactions/dist/coders/input.d.ts:8 - -___ - -### InputContract - -Ƭ **InputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract before transaction execution (b256) | -| `contractID` | `string` | Contract ID (b256) | -| `stateRoot` | `string` | State root of contract before transaction execution (b256) | -| `type` | [`Contract`](internal.md#contract) | - | -| `utxoID` | [`UtxoId`](internal.md#utxoid) | UTXO ID (UtxoId) | - -#### Defined in - -transactions/dist/coders/input.d.ts:36 +[providers/src/operations.ts:832](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L832) ___ @@ -688,345 +482,7 @@ ___ #### Defined in -[providers/src/operations.ts:5](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L5) - -___ - -### Output - -Ƭ **Output**: [`OutputCoin`](internal.md#outputcoin) \| [`OutputContract`](internal.md#outputcontract) \| [`OutputWithdrawal`](internal.md#outputwithdrawal) \| [`OutputChange`](internal.md#outputchange) \| [`OutputVariable`](internal.md#outputvariable) \| [`OutputContractCreated`](internal.md#outputcontractcreated) - -#### Defined in - -transactions/dist/coders/output.d.ts:91 - -___ - -### OutputChange - -Ƭ **OutputChange**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `BigNumber` | Amount of coins to send (u64) | -| `color` | `string` | Color of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Change`](internal.md#change) | - | - -#### Defined in - -transactions/dist/coders/output.d.ts:53 - -___ - -### OutputCoin - -Ƭ **OutputCoin**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `BigNumber` | Amount of coins to send (u64) | -| `color` | `string` | Color of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Coin`](../index.md#coin) | - | - -#### Defined in - -transactions/dist/coders/output.d.ts:11 - -___ - -### OutputContract - -Ƭ **OutputContract**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `balanceRoot` | `string` | Root of amount of coins owned by contract after transaction execution (b256) | -| `inputIndex` | `BigNumber` | Index of input contract (u8) | -| `stateRoot` | `string` | State root of contract after transaction execution (b256) | -| `type` | `OutputType.Contract` | - | - -#### Defined in - -transactions/dist/coders/output.d.ts:25 - -___ - -### OutputContractCreated - -Ƭ **OutputContractCreated**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `contractId` | `string` | Contract ID (b256) | -| `type` | [`ContractCreated`](internal.md#contractcreated) | - | - -#### Defined in - -transactions/dist/coders/output.d.ts:81 - -___ - -### OutputVariable - -Ƭ **OutputVariable**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `BigNumber` | Amount of coins to send (u64) | -| `color` | `string` | Color of coins (b256) | -| `to` | `string` | Receiving address or script hash (b256) | -| `type` | [`Variable`](internal.md#variable) | - | - -#### Defined in - -transactions/dist/coders/output.d.ts:67 - -___ - -### OutputWithdrawal - -Ƭ **OutputWithdrawal**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `BigNumber` | Amount of coins to withdraw (u64) | -| `color` | `string` | Color of coins (b256) | -| `to` | `string` | Receiving address (b256) | -| `type` | [`Withdrawal`](internal.md#withdrawal) | - | - -#### Defined in - -transactions/dist/coders/output.d.ts:39 - -___ - -### ReceiptCall - -Ƭ **ReceiptCall**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `BigNumber` | Amount of coins to forward, i.e. $rB (u64) | -| `color` | `string` | Color of coins to forward, i.e. MEM[$rC, 32] (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `gas` | `BigNumber` | Gas to forward, i.e. $rD (u64) | -| `is` | `BigNumber` | Value of register $is (u64) | -| `param1` | `BigNumber` | First parameter (u64) | -| `param2` | `BigNumber` | Second parameter (u64) | -| `pc` | `BigNumber` | Value of register $pc (u64) | -| `to` | `string` | Contract ID of called contract (b256) | -| `type` | [`Call`](internal.md#call) | - | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:15 - -___ - -### ReceiptLog - -Ƭ **ReceiptLog**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | `BigNumber` | Value of register $is (u64) | -| `pc` | `BigNumber` | Value of register $pc (u64) | -| `type` | [`Log`](internal.md#log) | - | -| `val0` | `BigNumber` | Value of register $rA (u64) | -| `val1` | `BigNumber` | Value of register $rB (u64) | -| `val2` | `BigNumber` | Value of register $rC (u64) | -| `val3` | `BigNumber` | Value of register $rD (u64) | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:109 - -___ - -### ReceiptLogData - -Ƭ **ReceiptLogData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rC, $rD] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | `BigNumber` | Value of register $is (u64) | -| `len` | `BigNumber` | Value of register $rD (u64) | -| `pc` | `BigNumber` | Value of register $pc (u64) | -| `ptr` | `BigNumber` | Value of register $rC (u64) | -| `type` | [`LogData`](internal.md#logdata) | - | -| `val0` | `BigNumber` | Value of register $rA (u64) | -| `val1` | `BigNumber` | Value of register $rB (u64) | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:131 - -___ - -### ReceiptPanic - -Ƭ **ReceiptPanic**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | `BigNumber` | Value of register $is (u64) | -| `pc` | `BigNumber` | Value of register $pc (u64) | -| `reason` | `BigNumber` | Panic reason (u64) | -| `type` | [`Panic`](internal.md#panic) | - | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:77 - -___ - -### ReceiptReturn - -Ƭ **ReceiptReturn**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | `BigNumber` | Value of register $is (u64) | -| `pc` | `BigNumber` | Value of register $pc (u64) | -| `type` | [`Return`](internal.md#return) | - | -| `val` | `BigNumber` | Value of register $rA (u64) | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:41 - -___ - -### ReceiptReturnData - -Ƭ **ReceiptReturnData**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `digest` | `string` | Hash of MEM[$rA, $rB] (b256) | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | `BigNumber` | Value of register $is (u64) | -| `len` | `BigNumber` | Value of register $rB (u64) | -| `pc` | `BigNumber` | Value of register $pc (u64) | -| `ptr` | `BigNumber` | Value of register $rA (u64) | -| `type` | [`ReturnData`](internal.md#returndata) | - | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:57 - -___ - -### ReceiptRevert - -Ƭ **ReceiptRevert**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | `BigNumber` | Value of register $is (u64) | -| `pc` | `BigNumber` | Value of register $pc (u64) | -| `type` | [`Revert`](internal.md#revert) | - | -| `val` | `BigNumber` | Value of register $rA (u64) | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:93 - -___ - -### ReceiptScriptResult - -Ƭ **ReceiptScriptResult**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasUsed` | `BigNumber` | Gas consumed by the script (u64) | -| `result` | `BigNumber` | Result variant with embedded `PanicReason` in first 8 bits and `instr` (u64) | -| `type` | [`ScriptResult`](internal.md#scriptresult) | - | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:195 - -___ - -### ReceiptTransfer - -Ƭ **ReceiptTransfer**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `BigNumber` | Amount of coins transferred (u64) | -| `color` | `string` | Color of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | `BigNumber` | Value of register $is (u64) | -| `pc` | `BigNumber` | Value of register $pc (u64) | -| `to` | `string` | Contract ID of contract to transfer coins to (b256) | -| `type` | [`Transfer`](internal.md#transfer) | - | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:155 - -___ - -### ReceiptTransferOut - -Ƭ **ReceiptTransferOut**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | `BigNumber` | Amount of coins transferred (u64) | -| `color` | `string` | Color of coins transferred (b256) | -| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | -| `is` | `BigNumber` | Value of register $is (u64) | -| `pc` | `BigNumber` | Value of register $pc (u64) | -| `to` | `string` | Address to transfer coins to (b256) | -| `type` | [`TransferOut`](internal.md#transferout) | - | - -#### Defined in - -transactions/dist/coders/receipt.d.ts:175 +[providers/src/operations.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L5) ___ @@ -1053,47 +509,7 @@ All built-in and custom scalars, mapped to their actual values #### Defined in -[providers/src/operations.ts:10](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/operations.ts#L10) - -___ - -### Transaction - -Ƭ **Transaction**: [`TransactionScript`](internal.md#transactionscript) \| [`TransactionCreate`](internal.md#transactioncreate) - -#### Defined in - -transactions/dist/coders/transaction.d.ts:82 - -___ - -### TransactionCreate - -Ƭ **TransactionCreate**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bytecodeLength` | `BigNumber` | Contract bytecode length, in instructions (u16) | -| `bytecodeWitnessIndex` | `BigNumber` | Witness index of contract bytecode to create (u8) | -| `gasLimit` | `BigNumber` | Gas limit for transaction (u64) | -| `gasPrice` | `BigNumber` | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `BigNumber` | Number of inputs (u8) | -| `maturity` | `BigNumber` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `BigNumber` | Number of outputs (u8) | -| `salt` | `string` | Salt (b256) | -| `staticContracts` | `string`[] | List of static contracts (b256[]) | -| `staticContractsCount` | `BigNumber` | Number of static contracts (u8) | -| `type` | [`Create`](../enums/TransactionType.md#create) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `BigNumber` | Number of witnesses (u8) | - -#### Defined in - -transactions/dist/coders/transaction.d.ts:46 +[providers/src/operations.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/operations.ts#L10) ___ @@ -1103,54 +519,7 @@ ___ #### Defined in -[providers/src/transaction-request/witness.ts:6](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/witness.ts#L6) - -___ - -### TransactionScript - -Ƭ **TransactionScript**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `gasLimit` | `BigNumber` | Gas limit for transaction (u64) | -| `gasPrice` | `BigNumber` | Gas price for transaction (u64) | -| `inputs` | [`Input`](internal.md#input)[] | List of inputs (Input[]) | -| `inputsCount` | `BigNumber` | Number of inputs (u8) | -| `maturity` | `BigNumber` | Block until which tx cannot be included (u32) | -| `outputs` | [`Output`](internal.md#output)[] | List of outputs (Output[]) | -| `outputsCount` | `BigNumber` | Number of outputs (u8) | -| `receiptsRoot` | `string` | Merkle root of receipts (b256) | -| `script` | `string` | Script to execute (byte[]) | -| `scriptData` | `string` | Script input data (parameters) (byte[]) | -| `scriptDataLength` | `BigNumber` | Length of script input data, in bytes (u16) | -| `scriptLength` | `BigNumber` | Script length, in instructions (u16) | -| `type` | [`Script`](../enums/TransactionType.md#script) | - | -| `witnesses` | [`Witness`](internal.md#witness)[] | List of witnesses (Witness[]) | -| `witnessesCount` | `BigNumber` | Number of witnesses (u8) | - -#### Defined in - -transactions/dist/coders/transaction.d.ts:10 - -___ - -### UtxoId - -Ƭ **UtxoId**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `outputIndex` | `BigNumber` | Output index (u8) | -| `transactionId` | `string` | Transaction ID (b256) | - -#### Defined in - -transactions/dist/coders/utxo-id.d.ts:3 +[providers/src/transaction-request/witness.ts:6](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/witness.ts#L6) ___ @@ -1162,11 +531,11 @@ ___ | Name | Type | | :------ | :------ | -| `type` | [`Variable`](internal.md#variable) | +| `type` | `OutputType.Variable` | #### Defined in -[providers/src/transaction-request/output.ts:38](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/output.ts#L38) +[providers/src/transaction-request/output.ts:38](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L38) ___ @@ -1181,25 +550,8 @@ ___ | `amount` | `BigNumberish` | Amount of coins to withdraw | | `color` | `BytesLike` | Color of coins | | `to` | `BytesLike` | Receiving address | -| `type` | [`Withdrawal`](internal.md#withdrawal) | - | - -#### Defined in - -[providers/src/transaction-request/output.ts:22](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/providers/src/transaction-request/output.ts#L22) - -___ - -### Witness - -Ƭ **Witness**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `string` | Witness data (byte[]) | -| `dataLength` | `BigNumber` | Length of witness data, in bytes (u16) | +| `type` | `OutputType.Withdrawal` | - | #### Defined in -transactions/dist/coders/witness.d.ts:3 +[providers/src/transaction-request/output.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/providers/src/transaction-request/output.ts#L22) diff --git a/docs/packages/fuel-ts-transactions/classes/InputCoder.md b/docs/packages/fuel-ts-transactions/classes/InputCoder.md new file mode 100644 index 00000000000..cc3235c5ea2 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/InputCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: InputCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: InputCoder + +[@fuel-ts/transactions](../index.md).InputCoder + +## Hierarchy + +- `default` + + ↳ **`InputCoder`** + +## Constructors + +### constructor + +• **new InputCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/input.ts:169](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L169) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`Input`](../index.md#input), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`Input`](../index.md#input), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/input.ts:194](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L194) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`Input`](../index.md#input) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/input.ts:173](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L173) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/InputCoinCoder.md b/docs/packages/fuel-ts-transactions/classes/InputCoinCoder.md new file mode 100644 index 00000000000..5aa945cbe1c --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/InputCoinCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: InputCoinCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: InputCoinCoder + +[@fuel-ts/transactions](../index.md).InputCoinCoder + +## Hierarchy + +- `default` + + ↳ **`InputCoinCoder`** + +## Constructors + +### constructor + +• **new InputCoinCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/input.ts:41](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L41) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`InputCoin`](../index.md#inputcoin), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`InputCoin`](../index.md#inputcoin), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/input.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L64) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`InputCoin`](../index.md#inputcoin) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/input.ts:45](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L45) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/InputContractCoder.md b/docs/packages/fuel-ts-transactions/classes/InputContractCoder.md new file mode 100644 index 00000000000..4ed3186f370 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/InputContractCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: InputContractCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: InputContractCoder + +[@fuel-ts/transactions](../index.md).InputContractCoder + +## Hierarchy + +- `default` + + ↳ **`InputContractCoder`** + +## Constructors + +### constructor + +• **new InputContractCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/input.ts:125](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L125) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`InputContract`](../index.md#inputcontract), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`InputContract`](../index.md#inputcontract), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/input.ts:140](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L140) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`InputContract`](../index.md#inputcontract) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/input.ts:129](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L129) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/OutputChangeCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputChangeCoder.md new file mode 100644 index 00000000000..2d81de85a07 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/OutputChangeCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: OutputChangeCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: OutputChangeCoder + +[@fuel-ts/transactions](../index.md).OutputChangeCoder + +## Hierarchy + +- `default` + + ↳ **`OutputChangeCoder`** + +## Constructors + +### constructor + +• **new OutputChangeCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/output.ts:170](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L170) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`OutputChange`](../index.md#outputchange), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`OutputChange`](../index.md#outputchange), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/output.ts:184](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L184) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`OutputChange`](../index.md#outputchange) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/output.ts:174](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L174) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/OutputCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputCoder.md new file mode 100644 index 00000000000..19dd1ffbbef --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/OutputCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: OutputCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: OutputCoder + +[@fuel-ts/transactions](../index.md).OutputCoder + +## Hierarchy + +- `default` + + ↳ **`OutputCoder`** + +## Constructors + +### constructor + +• **new OutputCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/output.ts:301](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L301) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`Output`](../index.md#output), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`Output`](../index.md#output), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/output.ts:342](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L342) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`Output`](../index.md#output) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/output.ts:305](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L305) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/OutputCoinCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputCoinCoder.md new file mode 100644 index 00000000000..498ef25aff6 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/OutputCoinCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: OutputCoinCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: OutputCoinCoder + +[@fuel-ts/transactions](../index.md).OutputCoinCoder + +## Hierarchy + +- `default` + + ↳ **`OutputCoinCoder`** + +## Constructors + +### constructor + +• **new OutputCoinCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/output.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L26) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`OutputCoin`](../index.md#outputcoin), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`OutputCoin`](../index.md#outputcoin), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/output.ts:40](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L40) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`OutputCoin`](../index.md#outputcoin) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/output.ts:30](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L30) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/OutputContractCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputContractCoder.md new file mode 100644 index 00000000000..1249a8b17b5 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/OutputContractCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: OutputContractCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: OutputContractCoder + +[@fuel-ts/transactions](../index.md).OutputContractCoder + +## Hierarchy + +- `default` + + ↳ **`OutputContractCoder`** + +## Constructors + +### constructor + +• **new OutputContractCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/output.ts:74](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L74) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`OutputContract`](../index.md#outputcontract), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`OutputContract`](../index.md#outputcontract), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/output.ts:88](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L88) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`OutputContract`](../index.md#outputcontract) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/output.ts:78](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L78) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/OutputContractCreatedCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputContractCreatedCoder.md new file mode 100644 index 00000000000..1a32dd93dc7 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/OutputContractCreatedCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: OutputContractCreatedCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: OutputContractCreatedCoder + +[@fuel-ts/transactions](../index.md).OutputContractCreatedCoder + +## Hierarchy + +- `default` + + ↳ **`OutputContractCreatedCoder`** + +## Constructors + +### constructor + +• **new OutputContractCreatedCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/output.ts:262](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L262) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`OutputContractCreated`](../index.md#outputcontractcreated), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`OutputContractCreated`](../index.md#outputcontractcreated), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/output.ts:274](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L274) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`OutputContractCreated`](../index.md#outputcontractcreated) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/output.ts:266](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L266) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/OutputVariableCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputVariableCoder.md new file mode 100644 index 00000000000..f154267fd13 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/OutputVariableCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: OutputVariableCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: OutputVariableCoder + +[@fuel-ts/transactions](../index.md).OutputVariableCoder + +## Hierarchy + +- `default` + + ↳ **`OutputVariableCoder`** + +## Constructors + +### constructor + +• **new OutputVariableCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/output.ts:218](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L218) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`OutputVariable`](../index.md#outputvariable), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`OutputVariable`](../index.md#outputvariable), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/output.ts:232](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L232) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`OutputVariable`](../index.md#outputvariable) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/output.ts:222](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L222) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/OutputWithdrawalCoder.md b/docs/packages/fuel-ts-transactions/classes/OutputWithdrawalCoder.md new file mode 100644 index 00000000000..525f77d7d34 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/OutputWithdrawalCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: OutputWithdrawalCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: OutputWithdrawalCoder + +[@fuel-ts/transactions](../index.md).OutputWithdrawalCoder + +## Hierarchy + +- `default` + + ↳ **`OutputWithdrawalCoder`** + +## Constructors + +### constructor + +• **new OutputWithdrawalCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/output.ts:122](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L122) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`OutputWithdrawal`](../index.md#outputwithdrawal), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`OutputWithdrawal`](../index.md#outputwithdrawal), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/output.ts:136](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L136) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`OutputWithdrawal`](../index.md#outputwithdrawal) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/output.ts:126](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L126) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptCallCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptCallCoder.md new file mode 100644 index 00000000000..c2c876f2fbd --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptCallCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptCallCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptCallCoder + +[@fuel-ts/transactions](../index.md).ReceiptCallCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptCallCoder`** + +## Constructors + +### constructor + +• **new ReceiptCallCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:43](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L43) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptCall`](../index.md#receiptcall), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptCall`](../index.md#receiptcall), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L63) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptCall`](../index.md#receiptcall) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L47) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptCoder.md new file mode 100644 index 00000000000..5038a708e97 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptCoder + +[@fuel-ts/transactions](../index.md).ReceiptCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptCoder`** + +## Constructors + +### constructor + +• **new ReceiptCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:669](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L669) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`Receipt`](../index.md#receipt), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`Receipt`](../index.md#receipt), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:726](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L726) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`Receipt`](../index.md#receipt) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:673](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L673) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptLogCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptLogCoder.md new file mode 100644 index 00000000000..65494c376f6 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptLogCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptLogCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptLogCoder + +[@fuel-ts/transactions](../index.md).ReceiptLogCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptLogCoder`** + +## Constructors + +### constructor + +• **new ReceiptLogCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:351](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L351) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptLog`](../index.md#receiptlog), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptLog`](../index.md#receiptlog), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:369](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L369) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptLog`](../index.md#receiptlog) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:355](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L355) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptLogDataCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptLogDataCoder.md new file mode 100644 index 00000000000..abeb66c9959 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptLogDataCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptLogDataCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptLogDataCoder + +[@fuel-ts/transactions](../index.md).ReceiptLogDataCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptLogDataCoder`** + +## Constructors + +### constructor + +• **new ReceiptLogDataCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:425](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L425) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptLogData`](../index.md#receiptlogdata), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptLogData`](../index.md#receiptlogdata), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:444](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L444) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptLogData`](../index.md#receiptlogdata) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:429](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L429) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptPanicCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptPanicCoder.md new file mode 100644 index 00000000000..4b44605fd24 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptPanicCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptPanicCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptPanicCoder + +[@fuel-ts/transactions](../index.md).ReceiptPanicCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptPanicCoder`** + +## Constructors + +### constructor + +• **new ReceiptPanicCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:237](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L237) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptPanic`](../index.md#receiptpanic), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptPanic`](../index.md#receiptpanic), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:252](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L252) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptPanic`](../index.md#receiptpanic) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:241](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L241) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptReturnCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptReturnCoder.md new file mode 100644 index 00000000000..6d7224a5168 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptReturnCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptReturnCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptReturnCoder + +[@fuel-ts/transactions](../index.md).ReceiptReturnCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptReturnCoder`** + +## Constructors + +### constructor + +• **new ReceiptReturnCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:117](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L117) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptReturn`](../index.md#receiptreturn), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptReturn`](../index.md#receiptreturn), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:132](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L132) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptReturn`](../index.md#receiptreturn) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:121](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L121) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptReturnDataCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptReturnDataCoder.md new file mode 100644 index 00000000000..e9fb5e7ac6f --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptReturnDataCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptReturnDataCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptReturnDataCoder + +[@fuel-ts/transactions](../index.md).ReceiptReturnDataCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptReturnDataCoder`** + +## Constructors + +### constructor + +• **new ReceiptReturnDataCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:175](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L175) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptReturnData`](../index.md#receiptreturndata), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptReturnData`](../index.md#receiptreturndata), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:192](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L192) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptReturnData`](../index.md#receiptreturndata) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:179](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L179) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptRevertCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptRevertCoder.md new file mode 100644 index 00000000000..85a268ea363 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptRevertCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptRevertCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptRevertCoder + +[@fuel-ts/transactions](../index.md).ReceiptRevertCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptRevertCoder`** + +## Constructors + +### constructor + +• **new ReceiptRevertCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:291](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L291) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptRevert`](../index.md#receiptrevert), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptRevert`](../index.md#receiptrevert), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:306](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L306) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptRevert`](../index.md#receiptrevert) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:295](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L295) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptScriptResultCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptScriptResultCoder.md new file mode 100644 index 00000000000..7822c75f85d --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptScriptResultCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptScriptResultCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptScriptResultCoder + +[@fuel-ts/transactions](../index.md).ReceiptScriptResultCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptScriptResultCoder`** + +## Constructors + +### constructor + +• **new ReceiptScriptResultCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:623](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L623) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptScriptResult`](../index.md#receiptscriptresult), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptScriptResult`](../index.md#receiptscriptresult), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:636](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L636) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptScriptResult`](../index.md#receiptscriptresult) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:627](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L627) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptTransferCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptTransferCoder.md new file mode 100644 index 00000000000..a484cb270f2 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptTransferCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptTransferCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptTransferCoder + +[@fuel-ts/transactions](../index.md).ReceiptTransferCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptTransferCoder`** + +## Constructors + +### constructor + +• **new ReceiptTransferCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:499](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L499) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptTransfer`](../index.md#receipttransfer), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptTransfer`](../index.md#receipttransfer), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:516](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L516) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptTransfer`](../index.md#receipttransfer) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:503](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L503) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/ReceiptTransferOutCoder.md b/docs/packages/fuel-ts-transactions/classes/ReceiptTransferOutCoder.md new file mode 100644 index 00000000000..a2fc1f9ab05 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/ReceiptTransferOutCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: ReceiptTransferOutCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: ReceiptTransferOutCoder + +[@fuel-ts/transactions](../index.md).ReceiptTransferOutCoder + +## Hierarchy + +- `default` + + ↳ **`ReceiptTransferOutCoder`** + +## Constructors + +### constructor + +• **new ReceiptTransferOutCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/receipt.ts:565](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L565) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`ReceiptTransferOut`](../index.md#receipttransferout), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`ReceiptTransferOut`](../index.md#receipttransferout), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/receipt.ts:582](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L582) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`ReceiptTransferOut`](../index.md#receipttransferout) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/receipt.ts:569](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L569) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/TransactionCoder.md b/docs/packages/fuel-ts-transactions/classes/TransactionCoder.md new file mode 100644 index 00000000000..77d59a30182 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/TransactionCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: TransactionCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: TransactionCoder + +[@fuel-ts/transactions](../index.md).TransactionCoder + +## Hierarchy + +- `default` + + ↳ **`TransactionCoder`** + +## Constructors + +### constructor + +• **new TransactionCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/transaction.ts:325](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L325) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`Transaction`](../index.md#transaction), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`Transaction`](../index.md#transaction), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/transaction.ts:350](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L350) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`Transaction`](../index.md#transaction) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/transaction.ts:329](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L329) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/TransactionCreateCoder.md b/docs/packages/fuel-ts-transactions/classes/TransactionCreateCoder.md new file mode 100644 index 00000000000..71d1a8b0363 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/TransactionCreateCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: TransactionCreateCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: TransactionCreateCoder + +[@fuel-ts/transactions](../index.md).TransactionCreateCoder + +## Hierarchy + +- `default` + + ↳ **`TransactionCreateCoder`** + +## Constructors + +### constructor + +• **new TransactionCreateCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/transaction.ts:198](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L198) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`TransactionCreate`](../index.md#transactioncreate), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`TransactionCreate`](../index.md#transactioncreate), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/transaction.ts:243](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L243) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`TransactionCreate`](../index.md#transactioncreate) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/transaction.ts:202](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L202) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/TransactionScriptCoder.md b/docs/packages/fuel-ts-transactions/classes/TransactionScriptCoder.md new file mode 100644 index 00000000000..a9bddc294e9 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/TransactionScriptCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: TransactionScriptCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: TransactionScriptCoder + +[@fuel-ts/transactions](../index.md).TransactionScriptCoder + +## Hierarchy + +- `default` + + ↳ **`TransactionScriptCoder`** + +## Constructors + +### constructor + +• **new TransactionScriptCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/transaction.ts:53](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L53) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`TransactionScript`](../index.md#transactionscript), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`TransactionScript`](../index.md#transactionscript), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/transaction.ts:92](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L92) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`TransactionScript`](../index.md#transactionscript) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/transaction.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L57) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/UtxoIdCoder.md b/docs/packages/fuel-ts-transactions/classes/UtxoIdCoder.md new file mode 100644 index 00000000000..7cb69f630d9 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/UtxoIdCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: UtxoIdCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: UtxoIdCoder + +[@fuel-ts/transactions](../index.md).UtxoIdCoder + +## Hierarchy + +- `default` + + ↳ **`UtxoIdCoder`** + +## Constructors + +### constructor + +• **new UtxoIdCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/utxo-id.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L13) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`UtxoId`](../index.md#utxoid), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`UtxoId`](../index.md#utxoid), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/utxo-id.ts:26](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L26) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`UtxoId`](../index.md#utxoid) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/utxo-id.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L17) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/classes/WitnessCoder.md b/docs/packages/fuel-ts-transactions/classes/WitnessCoder.md new file mode 100644 index 00000000000..5208babb0f6 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/classes/WitnessCoder.md @@ -0,0 +1,153 @@ +--- +layout: default +title: WitnessCoder +parent: "@fuel-ts/transactions" +nav_order: 1 + +--- + +# Class: WitnessCoder + +[@fuel-ts/transactions](../index.md).WitnessCoder + +## Hierarchy + +- `default` + + ↳ **`WitnessCoder`** + +## Constructors + +### constructor + +• **new WitnessCoder**(`localName`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `localName` | `string` | + +#### Overrides + +Coder.constructor + +#### Defined in + +[transactions/src/coders/witness.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L15) + +## Properties + +### localName + +• `Readonly` **localName**: `string` + +#### Inherited from + +Coder.localName + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:12 + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +Coder.name + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:10 + +___ + +### type + +• `Readonly` **type**: `string` + +#### Inherited from + +Coder.type + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:11 + +## Methods + +### decode + +▸ **decode**(`data`, `offset`): [[`Witness`](../index.md#witness), `number`] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `offset` | `number` | + +#### Returns + +[[`Witness`](../index.md#witness), `number`] + +#### Overrides + +Coder.decode + +#### Defined in + +[transactions/src/coders/witness.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L28) + +___ + +### encode + +▸ **encode**(`value`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`Witness`](../index.md#witness) | + +#### Returns + +`Uint8Array` + +#### Overrides + +Coder.encode + +#### Defined in + +[transactions/src/coders/witness.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L19) + +___ + +### throwError + +▸ **throwError**(`message`, `value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Inherited from + +Coder.throwError + +#### Defined in + +abi-coder/dist/coders/abstract-coder.d.ts:14 diff --git a/docs/packages/fuel-ts-transactions/enums/InputType.md b/docs/packages/fuel-ts-transactions/enums/InputType.md new file mode 100644 index 00000000000..db68c18a720 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/enums/InputType.md @@ -0,0 +1,31 @@ +--- +layout: default +title: InputType +parent: "@fuel-ts/transactions" +nav_order: 4 + +--- + +# Enumeration: InputType + +[@fuel-ts/transactions](../index.md).InputType + +## Enumeration members + +### Coin + +• **Coin** = `0` + +#### Defined in + +[transactions/src/coders/input.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L12) + +___ + +### Contract + +• **Contract** = `1` + +#### Defined in + +[transactions/src/coders/input.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L13) diff --git a/docs/packages/fuel-ts-transactions/enums/OutputType.md b/docs/packages/fuel-ts-transactions/enums/OutputType.md new file mode 100644 index 00000000000..a4b20cedda9 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/enums/OutputType.md @@ -0,0 +1,71 @@ +--- +layout: default +title: OutputType +parent: "@fuel-ts/transactions" +nav_order: 4 + +--- + +# Enumeration: OutputType + +[@fuel-ts/transactions](../index.md).OutputType + +## Enumeration members + +### Change + +• **Change** = `3` + +#### Defined in + +[transactions/src/coders/output.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L10) + +___ + +### Coin + +• **Coin** = `0` + +#### Defined in + +[transactions/src/coders/output.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L7) + +___ + +### Contract + +• **Contract** = `1` + +#### Defined in + +[transactions/src/coders/output.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L8) + +___ + +### ContractCreated + +• **ContractCreated** = `5` + +#### Defined in + +[transactions/src/coders/output.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L12) + +___ + +### Variable + +• **Variable** = `4` + +#### Defined in + +[transactions/src/coders/output.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L11) + +___ + +### Withdrawal + +• **Withdrawal** = `2` + +#### Defined in + +[transactions/src/coders/output.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L9) diff --git a/docs/packages/fuel-ts-transactions/enums/ReceiptType.md b/docs/packages/fuel-ts-transactions/enums/ReceiptType.md new file mode 100644 index 00000000000..e28219aeb88 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/enums/ReceiptType.md @@ -0,0 +1,111 @@ +--- +layout: default +title: ReceiptType +parent: "@fuel-ts/transactions" +nav_order: 4 + +--- + +# Enumeration: ReceiptType + +[@fuel-ts/transactions](../index.md).ReceiptType + +## Enumeration members + +### Call + +• **Call** = `0` + +#### Defined in + +[transactions/src/coders/receipt.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L8) + +___ + +### Log + +• **Log** = `5` + +#### Defined in + +[transactions/src/coders/receipt.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L13) + +___ + +### LogData + +• **LogData** = `6` + +#### Defined in + +[transactions/src/coders/receipt.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L14) + +___ + +### Panic + +• **Panic** = `3` + +#### Defined in + +[transactions/src/coders/receipt.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L11) + +___ + +### Return + +• **Return** = `1` + +#### Defined in + +[transactions/src/coders/receipt.ts:9](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L9) + +___ + +### ReturnData + +• **ReturnData** = `2` + +#### Defined in + +[transactions/src/coders/receipt.ts:10](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L10) + +___ + +### Revert + +• **Revert** = `4` + +#### Defined in + +[transactions/src/coders/receipt.ts:12](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L12) + +___ + +### ScriptResult + +• **ScriptResult** = `9` + +#### Defined in + +[transactions/src/coders/receipt.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L17) + +___ + +### Transfer + +• **Transfer** = `7` + +#### Defined in + +[transactions/src/coders/receipt.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L15) + +___ + +### TransferOut + +• **TransferOut** = `8` + +#### Defined in + +[transactions/src/coders/receipt.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L16) diff --git a/docs/packages/fuel-ts-transactions/enums/TransactionType.md b/docs/packages/fuel-ts-transactions/enums/TransactionType.md new file mode 100644 index 00000000000..a5004c2b4ab --- /dev/null +++ b/docs/packages/fuel-ts-transactions/enums/TransactionType.md @@ -0,0 +1,31 @@ +--- +layout: default +title: TransactionType +parent: "@fuel-ts/transactions" +nav_order: 4 + +--- + +# Enumeration: TransactionType + +[@fuel-ts/transactions](../index.md).TransactionType + +## Enumeration members + +### Create + +• **Create** = `1` + +#### Defined in + +[transactions/src/coders/transaction.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L17) + +___ + +### Script + +• **Script** = `0` + +#### Defined in + +[transactions/src/coders/transaction.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L16) diff --git a/docs/packages/fuel-ts-transactions/index.md b/docs/packages/fuel-ts-transactions/index.md new file mode 100644 index 00000000000..4c508b40e41 --- /dev/null +++ b/docs/packages/fuel-ts-transactions/index.md @@ -0,0 +1,673 @@ +--- +layout: default +title: "@fuel-ts/transactions" +has_children: true +has_toc: false +nav_order: 1 +--- + +# Module: @fuel-ts/transactions + +## Enumerations + +- [InputType](enums/InputType.md) +- [OutputType](enums/OutputType.md) +- [ReceiptType](enums/ReceiptType.md) +- [TransactionType](enums/TransactionType.md) + +## Classes + +- [InputCoder](classes/InputCoder.md) +- [InputCoinCoder](classes/InputCoinCoder.md) +- [InputContractCoder](classes/InputContractCoder.md) +- [OutputChangeCoder](classes/OutputChangeCoder.md) +- [OutputCoder](classes/OutputCoder.md) +- [OutputCoinCoder](classes/OutputCoinCoder.md) +- [OutputContractCoder](classes/OutputContractCoder.md) +- [OutputContractCreatedCoder](classes/OutputContractCreatedCoder.md) +- [OutputVariableCoder](classes/OutputVariableCoder.md) +- [OutputWithdrawalCoder](classes/OutputWithdrawalCoder.md) +- [ReceiptCallCoder](classes/ReceiptCallCoder.md) +- [ReceiptCoder](classes/ReceiptCoder.md) +- [ReceiptLogCoder](classes/ReceiptLogCoder.md) +- [ReceiptLogDataCoder](classes/ReceiptLogDataCoder.md) +- [ReceiptPanicCoder](classes/ReceiptPanicCoder.md) +- [ReceiptReturnCoder](classes/ReceiptReturnCoder.md) +- [ReceiptReturnDataCoder](classes/ReceiptReturnDataCoder.md) +- [ReceiptRevertCoder](classes/ReceiptRevertCoder.md) +- [ReceiptScriptResultCoder](classes/ReceiptScriptResultCoder.md) +- [ReceiptTransferCoder](classes/ReceiptTransferCoder.md) +- [ReceiptTransferOutCoder](classes/ReceiptTransferOutCoder.md) +- [TransactionCoder](classes/TransactionCoder.md) +- [TransactionCreateCoder](classes/TransactionCreateCoder.md) +- [TransactionScriptCoder](classes/TransactionScriptCoder.md) +- [UtxoIdCoder](classes/UtxoIdCoder.md) +- [WitnessCoder](classes/WitnessCoder.md) + +## Type aliases + +### Input + +Ƭ **Input**: [`InputCoin`](index.md#inputcoin) \| [`InputContract`](index.md#inputcontract) + +#### Defined in + +[transactions/src/coders/input.ts:166](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L166) + +___ + +### InputCoin + +Ƭ **InputCoin**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount` | `BigNumber` | Amount of coins (u64) | +| `color` | `string` | Color of the coins (b256) | +| `maturity` | `BigNumber` | UTXO being spent must have been created at least this many blocks ago (u64) | +| `owner` | `string` | Owning address or script hash (b256) | +| `predicate` | `string` | Predicate bytecode (byte[]) | +| `predicateData` | `string` | Predicate input data (parameters) (byte[]) | +| `predicateDataLength` | `BigNumber` | Length of predicate input data, in bytes (u16) | +| `predicateLength` | `BigNumber` | Length of predicate, in instructions (u16) | +| `type` | [`Coin`](enums/InputType.md#coin) | - | +| `utxoID` | [`UtxoId`](index.md#utxoid) | UTXO ID (UtxoId) | +| `witnessIndex` | `BigNumber` | Index of witness that authorizes spending the coin (u8) | + +#### Defined in + +[transactions/src/coders/input.ts:16](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L16) + +___ + +### InputContract + +Ƭ **InputContract**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `balanceRoot` | `string` | Root of amount of coins owned by contract before transaction execution (b256) | +| `contractID` | `string` | Contract ID (b256) | +| `stateRoot` | `string` | State root of contract before transaction execution (b256) | +| `type` | [`Contract`](enums/InputType.md#contract) | - | +| `utxoID` | [`UtxoId`](index.md#utxoid) | UTXO ID (UtxoId) | + +#### Defined in + +[transactions/src/coders/input.ts:112](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/input.ts#L112) + +___ + +### Output + +Ƭ **Output**: [`OutputCoin`](index.md#outputcoin) \| [`OutputContract`](index.md#outputcontract) \| [`OutputWithdrawal`](index.md#outputwithdrawal) \| [`OutputChange`](index.md#outputchange) \| [`OutputVariable`](index.md#outputvariable) \| [`OutputContractCreated`](index.md#outputcontractcreated) + +#### Defined in + +[transactions/src/coders/output.ts:292](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L292) + +___ + +### OutputChange + +Ƭ **OutputChange**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount` | `BigNumber` | Amount of coins to send (u64) | +| `color` | `string` | Color of coins (b256) | +| `to` | `string` | Receiving address or script hash (b256) | +| `type` | [`Change`](enums/OutputType.md#change) | - | + +#### Defined in + +[transactions/src/coders/output.ts:159](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L159) + +___ + +### OutputCoin + +Ƭ **OutputCoin**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount` | `BigNumber` | Amount of coins to send (u64) | +| `color` | `string` | Color of coins (b256) | +| `to` | `string` | Receiving address or script hash (b256) | +| `type` | [`Coin`](enums/OutputType.md#coin) | - | + +#### Defined in + +[transactions/src/coders/output.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L15) + +___ + +### OutputContract + +Ƭ **OutputContract**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `balanceRoot` | `string` | Root of amount of coins owned by contract after transaction execution (b256) | +| `inputIndex` | `BigNumber` | Index of input contract (u8) | +| `stateRoot` | `string` | State root of contract after transaction execution (b256) | +| `type` | [`Contract`](enums/OutputType.md#contract) | - | + +#### Defined in + +[transactions/src/coders/output.ts:63](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L63) + +___ + +### OutputContractCreated + +Ƭ **OutputContractCreated**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `contractId` | `string` | Contract ID (b256) | +| `type` | [`ContractCreated`](enums/OutputType.md#contractcreated) | - | + +#### Defined in + +[transactions/src/coders/output.ts:255](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L255) + +___ + +### OutputVariable + +Ƭ **OutputVariable**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount` | `BigNumber` | Amount of coins to send (u64) | +| `color` | `string` | Color of coins (b256) | +| `to` | `string` | Receiving address or script hash (b256) | +| `type` | [`Variable`](enums/OutputType.md#variable) | - | + +#### Defined in + +[transactions/src/coders/output.ts:207](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L207) + +___ + +### OutputWithdrawal + +Ƭ **OutputWithdrawal**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount` | `BigNumber` | Amount of coins to withdraw (u64) | +| `color` | `string` | Color of coins (b256) | +| `to` | `string` | Receiving address (b256) | +| `type` | [`Withdrawal`](enums/OutputType.md#withdrawal) | - | + +#### Defined in + +[transactions/src/coders/output.ts:111](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/output.ts#L111) + +___ + +### 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) + +#### Defined in + +[transactions/src/coders/receipt.ts:656](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L656) + +___ + +### ReceiptCall + +Ƭ **ReceiptCall**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount` | `BigNumber` | Amount of coins to forward, i.e. $rB (u64) | +| `color` | `string` | Color of coins to forward, i.e. MEM[$rC, 32] (b256) | +| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | +| `gas` | `BigNumber` | Gas to forward, i.e. $rD (u64) | +| `is` | `BigNumber` | Value of register $is (u64) | +| `param1` | `BigNumber` | First parameter (u64) | +| `param2` | `BigNumber` | Second parameter (u64) | +| `pc` | `BigNumber` | Value of register $pc (u64) | +| `to` | `string` | Contract ID of called contract (b256) | +| `type` | [`Call`](enums/ReceiptType.md#call) | - | + +#### Defined in + +[transactions/src/coders/receipt.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L20) + +___ + +### ReceiptLog + +Ƭ **ReceiptLog**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | +| `is` | `BigNumber` | Value of register $is (u64) | +| `pc` | `BigNumber` | Value of register $pc (u64) | +| `type` | [`Log`](enums/ReceiptType.md#log) | - | +| `val0` | `BigNumber` | Value of register $rA (u64) | +| `val1` | `BigNumber` | Value of register $rB (u64) | +| `val2` | `BigNumber` | Value of register $rC (u64) | +| `val3` | `BigNumber` | Value of register $rD (u64) | + +#### Defined in + +[transactions/src/coders/receipt.ts:332](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L332) + +___ + +### ReceiptLogData + +Ƭ **ReceiptLogData**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `digest` | `string` | Hash of MEM[$rC, $rD] (b256) | +| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | +| `is` | `BigNumber` | Value of register $is (u64) | +| `len` | `BigNumber` | Value of register $rD (u64) | +| `pc` | `BigNumber` | Value of register $pc (u64) | +| `ptr` | `BigNumber` | Value of register $rC (u64) | +| `type` | [`LogData`](enums/ReceiptType.md#logdata) | - | +| `val0` | `BigNumber` | Value of register $rA (u64) | +| `val1` | `BigNumber` | Value of register $rB (u64) | + +#### Defined in + +[transactions/src/coders/receipt.ts:404](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L404) + +___ + +### ReceiptPanic + +Ƭ **ReceiptPanic**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | +| `is` | `BigNumber` | Value of register $is (u64) | +| `pc` | `BigNumber` | Value of register $pc (u64) | +| `reason` | `BigNumber` | Panic reason (u64) | +| `type` | [`Panic`](enums/ReceiptType.md#panic) | - | + +#### Defined in + +[transactions/src/coders/receipt.ts:224](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L224) + +___ + +### ReceiptReturn + +Ƭ **ReceiptReturn**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | +| `is` | `BigNumber` | Value of register $is (u64) | +| `pc` | `BigNumber` | Value of register $pc (u64) | +| `type` | [`Return`](enums/ReceiptType.md#return) | - | +| `val` | `BigNumber` | Value of register $rA (u64) | + +#### Defined in + +[transactions/src/coders/receipt.ts:104](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L104) + +___ + +### ReceiptReturnData + +Ƭ **ReceiptReturnData**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `digest` | `string` | Hash of MEM[$rA, $rB] (b256) | +| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | +| `is` | `BigNumber` | Value of register $is (u64) | +| `len` | `BigNumber` | Value of register $rB (u64) | +| `pc` | `BigNumber` | Value of register $pc (u64) | +| `ptr` | `BigNumber` | Value of register $rA (u64) | +| `type` | [`ReturnData`](enums/ReceiptType.md#returndata) | - | + +#### Defined in + +[transactions/src/coders/receipt.ts:158](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L158) + +___ + +### ReceiptRevert + +Ƭ **ReceiptRevert**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | +| `is` | `BigNumber` | Value of register $is (u64) | +| `pc` | `BigNumber` | Value of register $pc (u64) | +| `type` | [`Revert`](enums/ReceiptType.md#revert) | - | +| `val` | `BigNumber` | Value of register $rA (u64) | + +#### Defined in + +[transactions/src/coders/receipt.ts:278](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L278) + +___ + +### ReceiptScriptResult + +Ƭ **ReceiptScriptResult**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `gasUsed` | `BigNumber` | Gas consumed by the script (u64) | +| `result` | `BigNumber` | Result variant with embedded `PanicReason` in first 8 bits and `instr` (u64) | +| `type` | [`ScriptResult`](enums/ReceiptType.md#scriptresult) | - | + +#### Defined in + +[transactions/src/coders/receipt.ts:614](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L614) + +___ + +### ReceiptTransfer + +Ƭ **ReceiptTransfer**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount` | `BigNumber` | Amount of coins transferred (u64) | +| `color` | `string` | Color of coins transferred (b256) | +| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | +| `is` | `BigNumber` | Value of register $is (u64) | +| `pc` | `BigNumber` | Value of register $pc (u64) | +| `to` | `string` | Contract ID of contract to transfer coins to (b256) | +| `type` | [`Transfer`](enums/ReceiptType.md#transfer) | - | + +#### Defined in + +[transactions/src/coders/receipt.ts:482](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L482) + +___ + +### ReceiptTransferOut + +Ƭ **ReceiptTransferOut**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `amount` | `BigNumber` | Amount of coins transferred (u64) | +| `color` | `string` | Color of coins transferred (b256) | +| `from` | `string` | Contract ID of current context if in an internal context, zero otherwise (b256) | +| `is` | `BigNumber` | Value of register $is (u64) | +| `pc` | `BigNumber` | Value of register $pc (u64) | +| `to` | `string` | Address to transfer coins to (b256) | +| `type` | [`TransferOut`](enums/ReceiptType.md#transferout) | - | + +#### Defined in + +[transactions/src/coders/receipt.ts:548](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/receipt.ts#L548) + +___ + +### Transaction + +Ƭ **Transaction**: [`TransactionScript`](index.md#transactionscript) \| [`TransactionCreate`](index.md#transactioncreate) + +#### Defined in + +[transactions/src/coders/transaction.ts:322](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L322) + +___ + +### TransactionCreate + +Ƭ **TransactionCreate**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `bytecodeLength` | `BigNumber` | Contract bytecode length, in instructions (u16) | +| `bytecodeWitnessIndex` | `BigNumber` | Witness index of contract bytecode to create (u8) | +| `gasLimit` | `BigNumber` | Gas limit for transaction (u64) | +| `gasPrice` | `BigNumber` | Gas price for transaction (u64) | +| `inputs` | [`Input`](index.md#input)[] | List of inputs (Input[]) | +| `inputsCount` | `BigNumber` | Number of inputs (u8) | +| `maturity` | `BigNumber` | Block until which tx cannot be included (u32) | +| `outputs` | [`Output`](index.md#output)[] | List of outputs (Output[]) | +| `outputsCount` | `BigNumber` | Number of outputs (u8) | +| `salt` | `string` | Salt (b256) | +| `staticContracts` | `string`[] | List of static contracts (b256[]) | +| `staticContractsCount` | `BigNumber` | Number of static contracts (u8) | +| `type` | [`Create`](enums/TransactionType.md#create) | - | +| `witnesses` | [`Witness`](index.md#witness)[] | List of witnesses (Witness[]) | +| `witnessesCount` | `BigNumber` | Number of witnesses (u8) | + +#### Defined in + +[transactions/src/coders/transaction.ts:165](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L165) + +___ + +### TransactionScript + +Ƭ **TransactionScript**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `gasLimit` | `BigNumber` | Gas limit for transaction (u64) | +| `gasPrice` | `BigNumber` | Gas price for transaction (u64) | +| `inputs` | [`Input`](index.md#input)[] | List of inputs (Input[]) | +| `inputsCount` | `BigNumber` | Number of inputs (u8) | +| `maturity` | `BigNumber` | Block until which tx cannot be included (u32) | +| `outputs` | [`Output`](index.md#output)[] | List of outputs (Output[]) | +| `outputsCount` | `BigNumber` | Number of outputs (u8) | +| `receiptsRoot` | `string` | Merkle root of receipts (b256) | +| `script` | `string` | Script to execute (byte[]) | +| `scriptData` | `string` | Script input data (parameters) (byte[]) | +| `scriptDataLength` | `BigNumber` | Length of script input data, in bytes (u16) | +| `scriptLength` | `BigNumber` | Script length, in instructions (u16) | +| `type` | [`Script`](enums/TransactionType.md#script) | - | +| `witnesses` | [`Witness`](index.md#witness)[] | List of witnesses (Witness[]) | +| `witnessesCount` | `BigNumber` | Number of witnesses (u8) | + +#### Defined in + +[transactions/src/coders/transaction.ts:20](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/transaction.ts#L20) + +___ + +### UtxoId + +Ƭ **UtxoId**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `outputIndex` | `BigNumber` | Output index (u8) | +| `transactionId` | `string` | Transaction ID (b256) | + +#### Defined in + +[transactions/src/coders/utxo-id.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/utxo-id.ts#L5) + +___ + +### Witness + +Ƭ **Witness**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | `string` | Witness data (byte[]) | +| `dataLength` | `BigNumber` | Length of witness data, in bytes (u16) | + +#### Defined in + +[transactions/src/coders/witness.ts:7](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/coders/witness.ts#L7) + +## Variables + +### CONTRACT\_MAX\_SIZE + +• **CONTRACT\_MAX\_SIZE**: `number` + +Maximum contract size, in bytes. + +#### Defined in + +[transactions/src/consts.ts:2](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L2) + +___ + +### MAX\_GAS\_PER\_TX + +• **MAX\_GAS\_PER\_TX**: ``1000000`` + +Maximum gas per transaction. + +#### Defined in + +[transactions/src/consts.ts:14](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L14) + +___ + +### MAX\_INPUTS + +• **MAX\_INPUTS**: ``8`` + +Maximum number of inputs. + +#### Defined in + +[transactions/src/consts.ts:5](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L5) + +___ + +### MAX\_OUTPUTS + +• **MAX\_OUTPUTS**: ``8`` + +Maximum number of outputs. + +#### Defined in + +[transactions/src/consts.ts:8](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L8) + +___ + +### MAX\_PREDICATE\_DATA\_LENGTH + +• **MAX\_PREDICATE\_DATA\_LENGTH**: `number` + +Maximum length of predicate data, in bytes. + +#### Defined in + +[transactions/src/consts.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L33) + +___ + +### MAX\_PREDICATE\_LENGTH + +• **MAX\_PREDICATE\_LENGTH**: `number` + +Maximum length of predicate, in instructions. + +#### Defined in + +[transactions/src/consts.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L29) + +___ + +### MAX\_SCRIPT\_DATA\_LENGTH + +• **MAX\_SCRIPT\_DATA\_LENGTH**: `number` + +Maximum length of script data, in bytes. + +#### Defined in + +[transactions/src/consts.ts:22](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L22) + +___ + +### MAX\_SCRIPT\_LENGTH + +• **MAX\_SCRIPT\_LENGTH**: `number` + +Maximum length of script, in instructions. + +#### Defined in + +[transactions/src/consts.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L18) + +___ + +### MAX\_STATIC\_CONTRACTS + +• **MAX\_STATIC\_CONTRACTS**: ``255`` + +Maximum number of static contracts. + +#### Defined in + +[transactions/src/consts.ts:25](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L25) + +___ + +### MAX\_WITNESSES + +• **MAX\_WITNESSES**: ``16`` + +Maximum number of witnesses. + +#### Defined in + +[transactions/src/consts.ts:11](https://github.com/FuelLabs/fuels-ts/blob/master/packages/transactions/src/consts.ts#L11) diff --git a/docs/packages/fuel-ts-wallet/classes/Signer.md b/docs/packages/fuel-ts-wallet/classes/Signer.md index 8f6c0c99d6c..d602822f121 100644 --- a/docs/packages/fuel-ts-wallet/classes/Signer.md +++ b/docs/packages/fuel-ts-wallet/classes/Signer.md @@ -26,7 +26,7 @@ Create a Signer instance from a given private key #### Defined in -[wallet/src/signer.ts:27](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/signer.ts#L27) +[wallet/src/signer.ts:27](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/signer.ts#L27) ## Properties @@ -36,7 +36,7 @@ Create a Signer instance from a given private key #### Defined in -[wallet/src/signer.ts:15](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/signer.ts#L15) +[wallet/src/signer.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/signer.ts#L15) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[wallet/src/signer.ts:19](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/signer.ts#L19) +[wallet/src/signer.ts:19](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/signer.ts#L19) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[wallet/src/signer.ts:17](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/signer.ts#L17) +[wallet/src/signer.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/signer.ts#L17) ## Methods @@ -82,7 +82,7 @@ hashed signature #### Defined in -[wallet/src/signer.ts:56](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/signer.ts#L56) +[wallet/src/signer.ts:56](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/signer.ts#L56) ___ @@ -107,7 +107,7 @@ address from signature. The address is a sha256 hash from the public key. #### Defined in -[wallet/src/signer.ts:101](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/signer.ts#L101) +[wallet/src/signer.ts:101](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/signer.ts#L101) ___ @@ -132,4 +132,4 @@ public key from signature from the #### Defined in -[wallet/src/signer.ts:77](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/signer.ts#L77) +[wallet/src/signer.ts:77](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/signer.ts#L77) diff --git a/docs/packages/fuel-ts-wallet/classes/Wallet.md b/docs/packages/fuel-ts-wallet/classes/Wallet.md index a25508274bb..41384d49af4 100644 --- a/docs/packages/fuel-ts-wallet/classes/Wallet.md +++ b/docs/packages/fuel-ts-wallet/classes/Wallet.md @@ -25,7 +25,7 @@ nav_order: 1 #### Defined in -[wallet/src/wallet.ts:17](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L17) +[wallet/src/wallet.ts:17](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L17) ## Properties @@ -35,7 +35,7 @@ nav_order: 1 #### Defined in -[wallet/src/wallet.ts:13](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L13) +[wallet/src/wallet.ts:13](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L13) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[wallet/src/wallet.ts:15](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L15) +[wallet/src/wallet.ts:15](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L15) ## Accessors @@ -67,7 +67,7 @@ ___ #### Defined in -[wallet/src/wallet.ts:29](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L29) +[wallet/src/wallet.ts:29](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L29) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[wallet/src/wallet.ts:33](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L33) +[wallet/src/wallet.ts:33](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L33) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[wallet/src/wallet.ts:37](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L37) +[wallet/src/wallet.ts:37](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L37) ## Methods @@ -115,7 +115,7 @@ ___ #### Defined in -[wallet/src/wallet.ts:64](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L64) +[wallet/src/wallet.ts:64](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L64) ___ @@ -139,7 +139,7 @@ TransactionResponse #### Defined in -[wallet/src/wallet.ts:87](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L87) +[wallet/src/wallet.ts:87](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L87) ___ @@ -163,7 +163,7 @@ string - Signature a ECDSA 64 bytes #### Defined in -[wallet/src/wallet.ts:47](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L47) +[wallet/src/wallet.ts:47](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L47) ___ @@ -188,4 +188,4 @@ Sign transaction with wallet instance privateKey #### Defined in -[wallet/src/wallet.ts:57](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/wallet.ts#L57) +[wallet/src/wallet.ts:57](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/wallet.ts#L57) diff --git a/docs/packages/fuel-ts-wallet/namespaces/Hasher.md b/docs/packages/fuel-ts-wallet/namespaces/Hasher.md index d0e29c9a42f..dc9aa832400 100644 --- a/docs/packages/fuel-ts-wallet/namespaces/Hasher.md +++ b/docs/packages/fuel-ts-wallet/namespaces/Hasher.md @@ -32,7 +32,7 @@ A sha256 hash of the data #### Defined in -[wallet/src/hasher.ts:100](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/hasher.ts#L100) +[wallet/src/hasher.ts:100](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/hasher.ts#L100) ___ @@ -56,7 +56,7 @@ A sha256 hash of the message #### Defined in -[wallet/src/hasher.ts:18](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/hasher.ts#L18) +[wallet/src/hasher.ts:18](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/hasher.ts#L18) ___ @@ -80,4 +80,4 @@ sha256 hash of the transaction #### Defined in -[wallet/src/hasher.ts:28](https://github.com/luizstacio/fuels-ts/blob/756d35d/packages/wallet/src/hasher.ts#L28) +[wallet/src/hasher.ts:28](https://github.com/FuelLabs/fuels-ts/blob/master/packages/wallet/src/hasher.ts#L28) diff --git a/package-lock.json b/package-lock.json index c536d2ae338..3644a080d9e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -45,6 +45,7 @@ "typedoc-just-the-docs-theme": "^0.0.1", "typedoc-monorepo-link-types": "^0.0.2", "typedoc-plugin-markdown": "^3.11.12", + "typedoc-plugin-sourcefile-url": "^1.0.6", "typescript": "^4.5.2" }, "engines": { @@ -16567,6 +16568,15 @@ "typedoc": ">=0.22.0" } }, + "node_modules/typedoc-plugin-sourcefile-url": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typedoc-plugin-sourcefile-url/-/typedoc-plugin-sourcefile-url-1.0.6.tgz", + "integrity": "sha512-xHq9DzkoQywS7FyPneMm2/Hr9GRoCpjSQXkVN0W6SCJKP7fguqg2tasgh+8l5/mW6YSYvqCqEbkSYLbuD4Y6gA==", + "dev": true, + "peerDependencies": { + "typedoc": ">=0.16.0" + } + }, "node_modules/typescript": { "version": "4.5.5", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", @@ -30693,6 +30703,13 @@ "handlebars": "^4.7.7" } }, + "typedoc-plugin-sourcefile-url": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typedoc-plugin-sourcefile-url/-/typedoc-plugin-sourcefile-url-1.0.6.tgz", + "integrity": "sha512-xHq9DzkoQywS7FyPneMm2/Hr9GRoCpjSQXkVN0W6SCJKP7fguqg2tasgh+8l5/mW6YSYvqCqEbkSYLbuD4Y6gA==", + "dev": true, + "requires": {} + }, "typescript": { "version": "4.5.5", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", diff --git a/package.json b/package.json index 70e5a365a73..7ee52bbb554 100644 --- a/package.json +++ b/package.json @@ -67,6 +67,7 @@ "typedoc-just-the-docs-theme": "^0.0.1", "typedoc-monorepo-link-types": "^0.0.2", "typedoc-plugin-markdown": "^3.11.12", + "typedoc-plugin-sourcefile-url": "^1.0.6", "typescript": "^4.5.2" } } diff --git a/typedoc.json b/typedoc.json index 992f8d9620c..8f1f2d7cf22 100644 --- a/typedoc.json +++ b/typedoc.json @@ -2,7 +2,13 @@ "$schema": "https://typedoc.org/schema.json", "theme": "just-the-docs", "out": "docs/packages", - "entryPoints": ["packages/wallet", "packages/providers"], + "entryPoints": [ + "packages/wallet", + "packages/providers", + "packages/transactions", + "packages/contract", + "packages/abi-coder" + ], "entryPointStrategy": "Packages", "githubPages": false, "hideInPageTOC": true, @@ -13,6 +19,7 @@ "categorizeByGroup": true, "filenameSeparator": "-", "entryDocument": "README.md", + "gitRevision": "master", "plugin": [ "typedoc-monorepo-link-types", "typedoc-plugin-markdown",