Optional data: PartialMessage<Order>Optional conduitThe conduit_key is a bytes32 value that indicates what conduit, if any, should be utilized as a source for token approvals when performing transfers. By default (i.e. when conduitKey is set to the zero hash), the offerer will grant ERC20, ERC721, and ERC1155 token approvals to Seaport directly so that it can perform any transfers specified by the order during fulfillment. In contrast, an offerer that elects to utilize a conduit will grant token approvals to the conduit contract corresponding to the supplied conduit key, and Seaport will then instruct that conduit to transfer the respective tokens.
from field: valorem.trade.v1.H256 conduit_key = 10;
The consideration contains an array of items that must be received in order to fulfill the order. It contains all of the same components as an offered item, and additionally includes a recipient that will receive each item. This array may be extended by the fulfiller on order fulfillment so as to support "tipping" (e.g. relayer or referral payments)
from field: repeated valorem.trade.v1.ConsiderationItem consideration = 4;
Optional endThe end_time indicates the block timestamp at which the order expires. This value and the startTime are used in conjunction with the start_amount and end_amount of each item to derive their current amount.
from field: valorem.trade.v1.H256 end_time = 7;
The offers array contains an array of items that may be transferred from the offerer's account.
from field: repeated valorem.trade.v1.OfferItem offer = 3;
Optional offererThe offerer of the order supplies all offered items and must either fulfill the order personally (i.e. msg.sender == offerer) or approve the order via signature (either standard 65-byte EDCSA, 64-byte EIP-2098, or an EIP-1271 isValidSignature check) or by listing the order on-chain (i.e. calling validate).
from field: valorem.trade.v1.H160 offerer = 1;
from field: valorem.trade.v1.OrderType order_type = 5;
Optional saltThe salt represents an arbitrary source of entropy for the order.
from field: valorem.trade.v1.H256 salt = 9;
Optional startThe start_time indicates the block timestamp at which the order becomes active.
from field: valorem.trade.v1.H256 start_time = 6;
Optional zoneThe zone of the order is an optional secondary account attached to the order with two additional privileges:
The zone may cancel orders where it is named as the zone by calling cancel. (Note that offerers can also cancel their own orders, either individually or for all orders signed with their current counter at once by calling incrementCounter). "Restricted" orders (as specified by the order type) must either be executed by the zone or the offerer, or must be approved as indicated by a call to an validateOrder on the zone.
from field: valorem.trade.v1.H160 zone = 2;
Optional zoneThe zoneHash represents an arbitrary 32-byte value that will be supplied to the zone when fulfilling restricted orders that the zone can utilize when making a determination on whether to authorize the order.
from field: valorem.trade.v1.H256 zone_hash = 8;
Static Readonly fieldsStatic Readonly runtimeStatic Readonly typeCompare with a message of the same type.
Parse from binary data, merging fields.
Repeated fields are appended. Map entries are added, overwriting existing keys.
If a message field is already present, it will be merged with the new data.
Optional options: Partial<BinaryReadOptions>Parse a message from a JSON value.
Optional options: Partial<JsonReadOptions>Parse a message from a JSON string.
Optional options: Partial<JsonReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Serialize the message to binary data.
Optional options: Partial<BinaryWriteOptions>Protected toJSONOverride for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).
Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.
This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.
Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().
Optional options: Partial<JsonWriteOptions>Serialize the message to a JSON string.
Optional options: Partial<JsonWriteStringOptions>Static equalsStatic fromOptional options: Partial<BinaryReadOptions>Static fromOptional options: Partial<JsonReadOptions>Static fromOptional options: Partial<JsonReadOptions>Generated using TypeDoc
Each order contains ten key components
Generated
from message valorem.trade.v1.Order