​

primitives/ContractResult

​

Classes

​

ContractRevertError

​

Extends

• PrimitiveError

​

Constructors

Constructor

new ContractRevertError(message, revertReason): ContractRevertError

Parameters

message

revertReason

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

revertReason

readonly revertReason: RevertReasonType

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

Type Aliases

​

ContractResultType

ContractResultType = SuccessResult | FailureResult

​

FailureResult

FailureResult = object

​

Properties

revertReason

readonly revertReason: RevertReasonType

success

readonly success: false

​

SuccessResult

SuccessResult = object

​

Properties

data

readonly data: ReturnDataType

success

readonly success: true

​

Functions

​

_failure()

_failure(revertReason): FailureResult

​

Parameters

revertReason

​

Returns

​

Example

const result = ContractResult.failure(revertReason);

​

_from()

_from(isSuccess, data): ContractResultType

​

Parameters

isSuccess

data

​

Returns

​

Example

const result = ContractResult.from(true, "0x0000...");
const failResult = ContractResult.from(false, "0x08c379a0...");

​

_isFailure()

_isFailure(result): result is FailureResult

​

Parameters

result

​

Returns

​

Example

if (ContractResult.isFailure(result)) {
  console.log(result.revertReason);
}

​

_isSuccess()

_isSuccess(result): result is SuccessResult

​

Parameters

result

​

Returns

​

Example

if (ContractResult.isSuccess(result)) {
  console.log(result.data);
}

​

_success()

_success(data): SuccessResult

​

Parameters

data

​

Returns

​

Example

const result = ContractResult.success(returnData);

​

_unwrap()

_unwrap(result): ReturnDataType

​

Parameters

result

​

Returns

​

Throws

​

Example

try {
  const data = ContractResult.unwrap(result);
} catch (error) {
  console.log(error.revertReason);
}

​

_unwrapOr()

_unwrapOr(result, defaultValue): ReturnDataType

​

Parameters

result

defaultValue

​

Returns

​

Example

const data = ContractResult.unwrapOr(result, ReturnData.fromHex("0x"));

​

failure()

failure(revertReason): FailureResult

​

Parameters

revertReason

​

Returns

​

from()

from(isSuccess, data): ContractResultType

​

Parameters

isSuccess

data

​

Returns

​

isFailure()

isFailure(result): result is FailureResult

​

Parameters

result

​

Returns

​

isSuccess()

isSuccess(result): result is SuccessResult

​

Parameters

result

​

Returns

​

success()

success(data): SuccessResult

​

Parameters

data

​

Returns

​

unwrap()

unwrap(result): ReturnDataType

​

Parameters

result

​

Returns

​

unwrapOr()

unwrapOr(result, defaultValue): ReturnDataType

​

Parameters

result

defaultValue

​

Returns