types

type BigInt ¶ added in v0.2.0

type BigInt struct {
	// contains filtered or unexported fields
}

BigInt holds a uint256 value used by on-chain identifiers. Use Equal or Cmp for numeric comparisons.

func BigIntFromBig(v *big.Int) (BigInt, error)

func NewBigInt(v uint64) BigInt

func ParseBigInt(s string) (BigInt, error)

func (id BigInt) Big() *big.Int

func (id BigInt) Bytes32() [32]byte

func (id BigInt) Cmp(other BigInt) int

func (id BigInt) Copy() BigInt

func (id BigInt) Equal(other BigInt) bool

func (id BigInt) IsZero() bool

func (id BigInt) MarshalJSON() ([]byte, error)

func (id BigInt) MarshalText() ([]byte, error)

func (id BigInt) String() string

func (id BigInt) Uint64() (uint64, bool)

func (id *BigInt) UnmarshalJSON(data []byte) error

func (id *BigInt) UnmarshalText(text []byte) error

type BroadcastError ¶ added in v0.7.0

type BroadcastError struct {
	Transaction *ethtypes.Transaction
	Cause       error
}

BroadcastError reports an error returned while sending a signed transaction. It does not establish whether the node rejected or accepted the transaction. SDK-originated errors always contain Transaction and Cause. Use errors.AsType to recover the original transaction for lookup or resubmission; do not retry the business operation merely because its WriteResult is nil.

func (e *BroadcastError) Error() string

func (e *BroadcastError) Unwrap() error

type ChainID ¶

type ChainID int64

ChainID is an EIP-155 chain identifier exposed at the SDK public boundary instead of the bare *big.Int used by go-ethereum. The newtype keeps callers honest about units (raw uint256 chain ids fit easily in int64 for every deployed EVM chain) and avoids silently accepting mutable *big.Int pointers across package boundaries.

The zero value is not a valid chain id; use IsValid to check.

func (c ChainID) BigInt() *big.Int

func (c ChainID) Int64() int64

func (c ChainID) IsValid() bool

type Epoch ¶

type Epoch uint64

Epoch is a Filecoin chain epoch number. Zero is the valid "indefinite" sentinel in several warm-storage fields.

type ListOptions ¶

type ListOptions struct {
	Offset uint64
	Limit  uint64
}

ListOptions configures a paginated list call.

Limit must be > 0. The zero value is rejected as a programming error: different services/contracts disagree on what "Limit == 0" means (some treat it as "all remaining", others as a default page size), so callers must be explicit.

When you want to iterate every record regardless of page size, use the service's IterateAll* method instead of trying to encode "no cap" via ListOptions.

func (o ListOptions) Validate() error

type WriteResult ¶

type WriteResult struct {
	Hash    common.Hash
	Receipt *ethtypes.Receipt
}

WriteResult is returned by every state-changing call in the SDK.

Hash is always populated when WriteResult is non-nil — it is set as soon as the transaction is broadcast. Receipt is populated only when the call was made with a wait option (e.g. WithWait(timeout)) and the transaction was mined and reached any requested confirmation count before the wait ended. Explicit confirmations apply to both successful and failed receipts, counting the inclusion block as the first confirmation.

Error semantics (observe WriteResult and err together):

• WriteResult == nil, err != nil: no successful submission result is available. When sending returned an error, err wraps BroadcastError, which preserves the original signed transaction. A nil result does not establish that the node rejected the transaction; do not blindly retry the business operation with a new transaction.
• WriteResult != nil, err == nil: transaction was broadcast successfully. Without a wait option, Receipt is nil. With a wait option, Receipt is non-nil and Status == 1 (successful execution).
• WriteResult != nil, err != nil, Receipt == nil: the wait timed out before a terminal receipt was returned, was canceled, or receipt lookup failed. This includes both "not mined yet" and "already mined, but the configured confirmation count has not been satisfied yet". Hash is valid; callers can keep polling by Hash. Use errors.Is with ErrReceiptTimeout, ErrReceiptRPCFailure, or context.Canceled to distinguish these outcomes; RPC causes are preserved.
• WriteResult != nil, err != nil, Receipt != nil: transaction was mined but execution reverted. err wraps ErrTxFailed (use errors.Is). Receipt carries the failed status and any logs emitted before revert.