Message

Defined in: packages/iso-filecoin/src/message.js:59

Filecoin Message class

Constructors

new Message()

new Message(msg: {
  from: string;
  gasFeeCap: string;
  gasLimit: number;
  gasPremium: string;
  method: number;
  nonce: number;
  params: string;
  to: string;
  value: string;
  version: 0;
 }): Message

Defined in: packages/iso-filecoin/src/message.js:70

Parameters

Parameter	Type	Description
`msg`	{ `from`: `string`; `gasFeeCap`: `string`; `gasLimit`: `number`; `gasPremium`: `string`; `method`: `number`; `nonce`: `number`; `params`: `string`; `to`: `string`; `value`: `string`; `version`: `0`; }
`msg.from`	`string`	-
`msg.gasFeeCap`?	`string`	-
`msg.gasLimit`?	`number`	-
`msg.gasPremium`?	`string`	-
`msg.method`?	`number`	-
`msg.nonce`?	`number`	-
`msg.params`?	`string`	Params encoded as base64pad
`msg.to`	`string`	-
`msg.value`	`string`	Value in attoFIL
`msg.version`?	`0`	-

Returns

Message

Methods

cidBytes()

cidBytes(): Uint8Array<ArrayBufferLike>

Defined in: packages/iso-filecoin/src/message.js:186

CID bytes of the filecoin message

Returns

Uint8Array<ArrayBufferLike>

prepare()

prepare(rpc: RPC): Promise<Message>

Defined in: packages/iso-filecoin/src/message.js:130

Prepare message for signing with nonce and gas estimation

Parameters

Parameter	Type	Description
`rpc`	`RPC`

Returns

Promise<Message>

serialize()

serialize(): Uint8Array<ArrayBufferLike>

Defined in: packages/iso-filecoin/src/message.js:161

Serialize message using dag-cbor

Returns

Uint8Array<ArrayBufferLike>

toLotus()

toLotus(): {
  From: string;
  GasFeeCap: string;
  GasLimit: number;
  GasPremium: string;
  Method: number;
  Nonce: number;
  Params: string;
  To: string;
  Value: string;
  Version: 0;
}

Defined in: packages/iso-filecoin/src/message.js:87

Convert message to Lotus message

Returns

{
  From: string;
  GasFeeCap: string;
  GasLimit: number;
  GasPremium: string;
  Method: number;
  Nonce: number;
  Params: string;
  To: string;
  Value: string;
  Version: 0;
}

From

From: string;

GasFeeCap

GasFeeCap: string;

GasLimit

GasLimit: number;

GasPremium

GasPremium: string;

Method

Method: number;

Nonce

Nonce: number;

Params

Params: string;

To

To: string;

Value

Value: string;

Version

Version: 0;

fromLotus()

static fromLotus(json: LotusMessage): Message

Defined in: packages/iso-filecoin/src/message.js:107

Create message from Lotus message

Parameters

Parameter	Type	Description
`json`	`LotusMessage`

Returns

Message

Properties

from

from: string;

Defined in: packages/iso-filecoin/src/message.js:74

gasFeeCap

gasFeeCap: string;

Defined in: packages/iso-filecoin/src/message.js:78

gasLimit

gasLimit: number;

Defined in: packages/iso-filecoin/src/message.js:77

gasPremium

gasPremium: string;

Defined in: packages/iso-filecoin/src/message.js:79

method

method: number;

Defined in: packages/iso-filecoin/src/message.js:80

nonce

nonce: number;

Defined in: packages/iso-filecoin/src/message.js:75

params

params: string;

Defined in: packages/iso-filecoin/src/message.js:81

to

to: string;

Defined in: packages/iso-filecoin/src/message.js:73

value

value: string;

Defined in: packages/iso-filecoin/src/message.js:76

version

version: 0;

Defined in: packages/iso-filecoin/src/message.js:72