proto

package
v0.0.0-...-740805f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 5, 2024 License: AGPL-3.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	HashScheme_name = map[int32]string{
		0: "HASH_SCHEME_NONE",
		1: "HASH_SCHEME_BLAKE3",
	}
	HashScheme_value = map[string]int32{
		"HASH_SCHEME_NONE":   0,
		"HASH_SCHEME_BLAKE3": 1,
	}
)

Enum value maps for HashScheme.

View Source 
var (
	SignatureScheme_name = map[int32]string{
		0: "SIGNATURE_SCHEME_NONE",
		1: "SIGNATURE_SCHEME_ED25519",
		2: "SIGNATURE_SCHEME_EIP712",
	}
	SignatureScheme_value = map[string]int32{
		"SIGNATURE_SCHEME_NONE":    0,
		"SIGNATURE_SCHEME_ED25519": 1,
		"SIGNATURE_SCHEME_EIP712":  2,
	}
)

Enum value maps for SignatureScheme.

View Source 
var (
	MessageType_name = map[int32]string{
		0:  "MESSAGE_TYPE_NONE",
		1:  "MESSAGE_TYPE_CAST_ADD",
		2:  "MESSAGE_TYPE_CAST_REMOVE",
		3:  "MESSAGE_TYPE_REACTION_ADD",
		4:  "MESSAGE_TYPE_REACTION_REMOVE",
		5:  "MESSAGE_TYPE_LINK_ADD",
		6:  "MESSAGE_TYPE_LINK_REMOVE",
		7:  "MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS",
		8:  "MESSAGE_TYPE_VERIFICATION_REMOVE",
		11: "MESSAGE_TYPE_USER_DATA_ADD",
		12: "MESSAGE_TYPE_USERNAME_PROOF",
		13: "MESSAGE_TYPE_FRAME_ACTION",
	}
	MessageType_value = map[string]int32{
		"MESSAGE_TYPE_NONE":                         0,
		"MESSAGE_TYPE_CAST_ADD":                     1,
		"MESSAGE_TYPE_CAST_REMOVE":                  2,
		"MESSAGE_TYPE_REACTION_ADD":                 3,
		"MESSAGE_TYPE_REACTION_REMOVE":              4,
		"MESSAGE_TYPE_LINK_ADD":                     5,
		"MESSAGE_TYPE_LINK_REMOVE":                  6,
		"MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS": 7,
		"MESSAGE_TYPE_VERIFICATION_REMOVE":          8,
		"MESSAGE_TYPE_USER_DATA_ADD":                11,
		"MESSAGE_TYPE_USERNAME_PROOF":               12,
		"MESSAGE_TYPE_FRAME_ACTION":                 13,
	}
)

Enum value maps for MessageType.

View Source 
var (
	FarcasterNetwork_name = map[int32]string{
		0: "FARCASTER_NETWORK_NONE",
		1: "FARCASTER_NETWORK_MAINNET",
		2: "FARCASTER_NETWORK_TESTNET",
		3: "FARCASTER_NETWORK_DEVNET",
	}
	FarcasterNetwork_value = map[string]int32{
		"FARCASTER_NETWORK_NONE":    0,
		"FARCASTER_NETWORK_MAINNET": 1,
		"FARCASTER_NETWORK_TESTNET": 2,
		"FARCASTER_NETWORK_DEVNET":  3,
	}
)

Enum value maps for FarcasterNetwork.

View Source 
var (
	UserDataType_name = map[int32]string{
		0: "USER_DATA_TYPE_NONE",
		1: "USER_DATA_TYPE_PFP",
		2: "USER_DATA_TYPE_DISPLAY",
		3: "USER_DATA_TYPE_BIO",
		5: "USER_DATA_TYPE_URL",
		6: "USER_DATA_TYPE_USERNAME",
	}
	UserDataType_value = map[string]int32{
		"USER_DATA_TYPE_NONE":     0,
		"USER_DATA_TYPE_PFP":      1,
		"USER_DATA_TYPE_DISPLAY":  2,
		"USER_DATA_TYPE_BIO":      3,
		"USER_DATA_TYPE_URL":      5,
		"USER_DATA_TYPE_USERNAME": 6,
	}
)

Enum value maps for UserDataType.

View Source 
var (
	ReactionType_name = map[int32]string{
		0: "REACTION_TYPE_NONE",
		1: "REACTION_TYPE_LIKE",
		2: "REACTION_TYPE_RECAST",
	}
	ReactionType_value = map[string]int32{
		"REACTION_TYPE_NONE":   0,
		"REACTION_TYPE_LIKE":   1,
		"REACTION_TYPE_RECAST": 2,
	}
)

Enum value maps for ReactionType.

View Source 
var (
	Protocol_name = map[int32]string{
		0: "PROTOCOL_ETHEREUM",
		1: "PROTOCOL_SOLANA",
	}
	Protocol_value = map[string]int32{
		"PROTOCOL_ETHEREUM": 0,
		"PROTOCOL_SOLANA":   1,
	}
)

Enum value maps for Protocol.

View Source 
var (
	UserNameType_name = map[int32]string{
		0: "USERNAME_TYPE_NONE",
		1: "USERNAME_TYPE_FNAME",
		2: "USERNAME_TYPE_ENS_L1",
	}
	UserNameType_value = map[string]int32{
		"USERNAME_TYPE_NONE":   0,
		"USERNAME_TYPE_FNAME":  1,
		"USERNAME_TYPE_ENS_L1": 2,
	}
)

Enum value maps for UserNameType.

View Source 
var File_hubmessage_proto protoreflect.FileDescriptor
View Source 
var File_username_proof_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CastAddBody 

type CastAddBody struct {
	EmbedsDeprecated []string `protobuf:"bytes,1,rep,name=embeds_deprecated,json=embedsDeprecated,proto3" json:"embeds_deprecated,omitempty"` // URLs to be embedded in the cast
	Mentions         []uint64 `protobuf:"varint,2,rep,packed,name=mentions,proto3" json:"mentions,omitempty"`                                 // Fids mentioned in the cast
	// Types that are assignable to Parent:
	//
	//	*CastAddBody_ParentCastId
	//	*CastAddBody_ParentUrl
	Parent            isCastAddBody_Parent `protobuf_oneof:"parent"`
	Text              string               `protobuf:"bytes,4,opt,name=text,proto3" json:"text,omitempty"`                                                            // Text of the cast
	MentionsPositions []uint32             `protobuf:"varint,5,rep,packed,name=mentions_positions,json=mentionsPositions,proto3" json:"mentions_positions,omitempty"` // Positions of the mentions in the text
	Embeds            []*Embed             `protobuf:"bytes,6,rep,name=embeds,proto3" json:"embeds,omitempty"`                                                        // URLs or cast ids to be embedded in the cast
	// contains filtered or unexported fields
}

* Adds a new Cast

func (*CastAddBody) Descriptor deprecated 

func (*CastAddBody) Descriptor() ([]byte, []int)

Deprecated: Use CastAddBody.ProtoReflect.Descriptor instead.

func (*CastAddBody) GetEmbeds 

func (x *CastAddBody) GetEmbeds() []*Embed

func (*CastAddBody) GetEmbedsDeprecated 

func (x *CastAddBody) GetEmbedsDeprecated() []string

func (*CastAddBody) GetMentions 

func (x *CastAddBody) GetMentions() []uint64

func (*CastAddBody) GetMentionsPositions 

func (x *CastAddBody) GetMentionsPositions() []uint32

func (*CastAddBody) GetParent 

func (m *CastAddBody) GetParent() isCastAddBody_Parent

func (*CastAddBody) GetParentCastId 

func (x *CastAddBody) GetParentCastId() *CastId

func (*CastAddBody) GetParentUrl 

func (x *CastAddBody) GetParentUrl() string

func (*CastAddBody) GetText 

func (x *CastAddBody) GetText() string

func (*CastAddBody) ProtoMessage 

func (*CastAddBody) ProtoMessage()

func (*CastAddBody) ProtoReflect 

func (x *CastAddBody) ProtoReflect() protoreflect.Message

func (*CastAddBody) Reset 

func (x *CastAddBody) Reset()

func (*CastAddBody) String 

func (x *CastAddBody) String() string

type CastAddBody_ParentCastId 

type CastAddBody_ParentCastId struct {
	ParentCastId *CastId `protobuf:"bytes,3,opt,name=parent_cast_id,json=parentCastId,proto3,oneof"` // Parent cast of the cast
}

type CastAddBody_ParentUrl 

type CastAddBody_ParentUrl struct {
	ParentUrl string `protobuf:"bytes,7,opt,name=parent_url,json=parentUrl,proto3,oneof"` // Parent URL
}

type CastId 

type CastId struct {
	Fid  uint64 `protobuf:"varint,1,opt,name=fid,proto3" json:"fid,omitempty"`  // Fid of the user who created the cast
	Hash []byte `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"` // Hash of the cast
	// contains filtered or unexported fields
}

* Identifier used to look up a Cast

func (*CastId) Descriptor deprecated 

func (*CastId) Descriptor() ([]byte, []int)

Deprecated: Use CastId.ProtoReflect.Descriptor instead.

func (*CastId) GetFid 

func (x *CastId) GetFid() uint64

func (*CastId) GetHash 

func (x *CastId) GetHash() []byte

func (*CastId) ProtoMessage 

func (*CastId) ProtoMessage()

func (*CastId) ProtoReflect 

func (x *CastId) ProtoReflect() protoreflect.Message

func (*CastId) Reset 

func (x *CastId) Reset()

func (*CastId) String 

func (x *CastId) String() string

type CastRemoveBody 

type CastRemoveBody struct {
	TargetHash []byte `protobuf:"bytes,1,opt,name=target_hash,json=targetHash,proto3" json:"target_hash,omitempty"` // Hash of the cast to remove
	// contains filtered or unexported fields
}

* Removes an existing Cast

func (*CastRemoveBody) Descriptor deprecated 

func (*CastRemoveBody) Descriptor() ([]byte, []int)

Deprecated: Use CastRemoveBody.ProtoReflect.Descriptor instead.

func (*CastRemoveBody) GetTargetHash 

func (x *CastRemoveBody) GetTargetHash() []byte

func (*CastRemoveBody) ProtoMessage 

func (*CastRemoveBody) ProtoMessage()

func (*CastRemoveBody) ProtoReflect 

func (x *CastRemoveBody) ProtoReflect() protoreflect.Message

func (*CastRemoveBody) Reset 

func (x *CastRemoveBody) Reset()

func (*CastRemoveBody) String 

func (x *CastRemoveBody) String() string

type Embed 

type Embed struct {

	// Types that are assignable to Embed:
	//
	//	*Embed_Url
	//	*Embed_CastId
	Embed isEmbed_Embed `protobuf_oneof:"embed"`
	// contains filtered or unexported fields
}

func (*Embed) Descriptor deprecated 

func (*Embed) Descriptor() ([]byte, []int)

Deprecated: Use Embed.ProtoReflect.Descriptor instead.

func (*Embed) GetCastId 

func (x *Embed) GetCastId() *CastId

func (*Embed) GetEmbed 

func (m *Embed) GetEmbed() isEmbed_Embed

func (*Embed) GetUrl 

func (x *Embed) GetUrl() string

func (*Embed) ProtoMessage 

func (*Embed) ProtoMessage()

func (*Embed) ProtoReflect 

func (x *Embed) ProtoReflect() protoreflect.Message

func (*Embed) Reset 

func (x *Embed) Reset()

func (*Embed) String 

func (x *Embed) String() string

type Embed_CastId 

type Embed_CastId struct {
	CastId *CastId `protobuf:"bytes,2,opt,name=cast_id,json=castId,proto3,oneof"`
}

type Embed_Url 

type Embed_Url struct {
	Url string `protobuf:"bytes,1,opt,name=url,proto3,oneof"`
}

type FarcasterNetwork 

type FarcasterNetwork int32

* Farcaster network the message is intended for 

const (
	FarcasterNetwork_FARCASTER_NETWORK_NONE    FarcasterNetwork = 0
	FarcasterNetwork_FARCASTER_NETWORK_MAINNET FarcasterNetwork = 1 // Public primary network
	FarcasterNetwork_FARCASTER_NETWORK_TESTNET FarcasterNetwork = 2 // Public test network
	FarcasterNetwork_FARCASTER_NETWORK_DEVNET  FarcasterNetwork = 3 // Private test network
)

func (FarcasterNetwork) Descriptor 

func (FarcasterNetwork) Descriptor() protoreflect.EnumDescriptor

func (FarcasterNetwork) Enum 

func (x FarcasterNetwork) Enum() *FarcasterNetwork

func (FarcasterNetwork) EnumDescriptor deprecated 

func (FarcasterNetwork) EnumDescriptor() ([]byte, []int)

Deprecated: Use FarcasterNetwork.Descriptor instead.

func (FarcasterNetwork) Number 

func (x FarcasterNetwork) Number() protoreflect.EnumNumber

func (FarcasterNetwork) String 

func (x FarcasterNetwork) String() string

func (FarcasterNetwork) Type 

func (FarcasterNetwork) Type() protoreflect.EnumType

type FrameActionBody 

type FrameActionBody struct {
	Url           []byte  `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`                                          // URL of the Frame triggering the action
	ButtonIndex   uint32  `protobuf:"varint,2,opt,name=button_index,json=buttonIndex,proto3" json:"button_index,omitempty"`      // The index of the button pressed (1-4)
	CastId        *CastId `protobuf:"bytes,3,opt,name=cast_id,json=castId,proto3" json:"cast_id,omitempty"`                      // The cast which contained the frame url
	InputText     []byte  `protobuf:"bytes,4,opt,name=input_text,json=inputText,proto3" json:"input_text,omitempty"`             // Text input from the user, if present
	State         []byte  `protobuf:"bytes,5,opt,name=state,proto3" json:"state,omitempty"`                                      // Serialized frame state value
	TransactionId []byte  `protobuf:"bytes,6,opt,name=transaction_id,json=transactionId,proto3" json:"transaction_id,omitempty"` // Chain-specific transaction ID for tx actions
	// contains filtered or unexported fields
}

* A Farcaster Frame action

func (*FrameActionBody) Descriptor deprecated 

func (*FrameActionBody) Descriptor() ([]byte, []int)

Deprecated: Use FrameActionBody.ProtoReflect.Descriptor instead.

func (*FrameActionBody) GetButtonIndex 

func (x *FrameActionBody) GetButtonIndex() uint32

func (*FrameActionBody) GetCastId 

func (x *FrameActionBody) GetCastId() *CastId

func (*FrameActionBody) GetInputText 

func (x *FrameActionBody) GetInputText() []byte

func (*FrameActionBody) GetState 

func (x *FrameActionBody) GetState() []byte

func (*FrameActionBody) GetTransactionId 

func (x *FrameActionBody) GetTransactionId() []byte

func (*FrameActionBody) GetUrl 

func (x *FrameActionBody) GetUrl() []byte

func (*FrameActionBody) ProtoMessage 

func (*FrameActionBody) ProtoMessage()

func (*FrameActionBody) ProtoReflect 

func (x *FrameActionBody) ProtoReflect() protoreflect.Message

func (*FrameActionBody) Reset 

func (x *FrameActionBody) Reset()

func (*FrameActionBody) String 

func (x *FrameActionBody) String() string

type HashScheme 

type HashScheme int32

* Type of hashing scheme used to produce a digest of MessageData 

const (
	HashScheme_HASH_SCHEME_NONE   HashScheme = 0
	HashScheme_HASH_SCHEME_BLAKE3 HashScheme = 1 // Default scheme for hashing MessageData
)

func (HashScheme) Descriptor 

func (HashScheme) Descriptor() protoreflect.EnumDescriptor

func (HashScheme) Enum 

func (x HashScheme) Enum() *HashScheme

func (HashScheme) EnumDescriptor deprecated 

func (HashScheme) EnumDescriptor() ([]byte, []int)

Deprecated: Use HashScheme.Descriptor instead.

func (HashScheme) Number 

func (x HashScheme) Number() protoreflect.EnumNumber

func (HashScheme) String 

func (x HashScheme) String() string

func (HashScheme) Type 

func (HashScheme) Type() protoreflect.EnumType

type LinkBody 

type LinkBody struct {
	Type             string  `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`                                // Type of link, <= 8 characters
	DisplayTimestamp *uint32 `protobuf:"varint,2,opt,name=displayTimestamp,proto3,oneof" json:"displayTimestamp,omitempty"` // User-defined timestamp that preserves original timestamp when message.data.timestamp needs to be updated for compaction
	// Types that are assignable to Target:
	//
	//	*LinkBody_TargetFid
	Target isLinkBody_Target `protobuf_oneof:"target"`
	// contains filtered or unexported fields
}

* Adds or removes a Link

func (*LinkBody) Descriptor deprecated 

func (*LinkBody) Descriptor() ([]byte, []int)

Deprecated: Use LinkBody.ProtoReflect.Descriptor instead.

func (*LinkBody) GetDisplayTimestamp 

func (x *LinkBody) GetDisplayTimestamp() uint32

func (*LinkBody) GetTarget 

func (m *LinkBody) GetTarget() isLinkBody_Target

func (*LinkBody) GetTargetFid 

func (x *LinkBody) GetTargetFid() uint64

func (*LinkBody) GetType 

func (x *LinkBody) GetType() string

func (*LinkBody) ProtoMessage 

func (*LinkBody) ProtoMessage()

func (*LinkBody) ProtoReflect 

func (x *LinkBody) ProtoReflect() protoreflect.Message

func (*LinkBody) Reset 

func (x *LinkBody) Reset()

func (*LinkBody) String 

func (x *LinkBody) String() string

type LinkBody_TargetFid 

type LinkBody_TargetFid struct {
	TargetFid uint64 `protobuf:"varint,3,opt,name=target_fid,json=targetFid,proto3,oneof"` // The fid the link relates to
}

type Message 

type Message struct {
	Data       *MessageData `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` // Contents of the message
	Hash       []byte       `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"` // Hash digest of data
	HashScheme HashScheme   ``                                                              // Hash scheme that produced the hash digest
	/* 131-byte string literal not displayed */
	Signature       []byte          `protobuf:"bytes,4,opt,name=signature,proto3" json:"signature,omitempty"` // Signature of the hash digest
	SignatureScheme SignatureScheme ``                                                                        // Signature scheme that produced the signature
	/* 151-byte string literal not displayed */
	Signer    []byte `protobuf:"bytes,6,opt,name=signer,proto3" json:"signer,omitempty"`                              // Public key or address of the key pair that produced the signature
	DataBytes []byte `protobuf:"bytes,7,opt,name=data_bytes,json=dataBytes,proto3,oneof" json:"data_bytes,omitempty"` // MessageData serialized to bytes if using protobuf serialization other than ts-proto
	// contains filtered or unexported fields
}

* A Message is a delta operation on the Farcaster network. The message protobuf is an envelope that wraps a MessageData object and contains a hash and signature which can verify its authenticity.

func (*Message) Descriptor deprecated 

func (*Message) Descriptor() ([]byte, []int)

Deprecated: Use Message.ProtoReflect.Descriptor instead.

func (*Message) GetData 

func (x *Message) GetData() *MessageData

func (*Message) GetDataBytes 

func (x *Message) GetDataBytes() []byte

func (*Message) GetHash 

func (x *Message) GetHash() []byte

func (*Message) GetHashScheme 

func (x *Message) GetHashScheme() HashScheme

func (*Message) GetSignature 

func (x *Message) GetSignature() []byte

func (*Message) GetSignatureScheme 

func (x *Message) GetSignatureScheme() SignatureScheme

func (*Message) GetSigner 

func (x *Message) GetSigner() []byte

func (*Message) ProtoMessage 

func (*Message) ProtoMessage()

func (*Message) ProtoReflect 

func (x *Message) ProtoReflect() protoreflect.Message

func (*Message) Reset 

func (x *Message) Reset()

func (*Message) String 

func (x *Message) String() string

type MessageData 

type MessageData struct {
	Type      MessageType      `protobuf:"varint,1,opt,name=type,proto3,enum=farcasterapi.hub.proto.MessageType" json:"type,omitempty"`            // Type of message contained in the body
	Fid       uint64           `protobuf:"varint,2,opt,name=fid,proto3" json:"fid,omitempty"`                                                      // Farcaster ID of the user producing the message
	Timestamp uint32           `protobuf:"varint,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`                                          // Farcaster epoch timestamp in seconds
	Network   FarcasterNetwork `protobuf:"varint,4,opt,name=network,proto3,enum=farcasterapi.hub.proto.FarcasterNetwork" json:"network,omitempty"` // Farcaster network the message is intended for
	// Types that are assignable to Body:
	//
	//	*MessageData_CastAddBody
	//	*MessageData_CastRemoveBody
	//	*MessageData_ReactionBody
	//	*MessageData_VerificationAddAddressBody
	//	*MessageData_VerificationRemoveBody
	//	*MessageData_UserDataBody
	//	*MessageData_LinkBody
	//	*MessageData_UsernameProofBody
	//	*MessageData_FrameActionBody
	Body isMessageData_Body `protobuf_oneof:"body"`
	// contains filtered or unexported fields
}

* A MessageData object contains properties common to all messages and wraps a body object which contains properties specific to the MessageType.

func (*MessageData) Descriptor deprecated 

func (*MessageData) Descriptor() ([]byte, []int)

Deprecated: Use MessageData.ProtoReflect.Descriptor instead.

func (*MessageData) GetBody 

func (m *MessageData) GetBody() isMessageData_Body

func (*MessageData) GetCastAddBody 

func (x *MessageData) GetCastAddBody() *CastAddBody

func (*MessageData) GetCastRemoveBody 

func (x *MessageData) GetCastRemoveBody() *CastRemoveBody

func (*MessageData) GetFid 

func (x *MessageData) GetFid() uint64

func (*MessageData) GetFrameActionBody 

func (x *MessageData) GetFrameActionBody() *FrameActionBody

func (*MessageData) GetLinkBody 

func (x *MessageData) GetLinkBody() *LinkBody

func (*MessageData) GetNetwork 

func (x *MessageData) GetNetwork() FarcasterNetwork

func (*MessageData) GetReactionBody 

func (x *MessageData) GetReactionBody() *ReactionBody

func (*MessageData) GetTimestamp 

func (x *MessageData) GetTimestamp() uint32

func (*MessageData) GetType 

func (x *MessageData) GetType() MessageType

func (*MessageData) GetUserDataBody 

func (x *MessageData) GetUserDataBody() *UserDataBody

func (*MessageData) GetUsernameProofBody 

func (x *MessageData) GetUsernameProofBody() *UserNameProof

func (*MessageData) GetVerificationAddAddressBody 

func (x *MessageData) GetVerificationAddAddressBody() *VerificationAddAddressBody

func (*MessageData) GetVerificationRemoveBody 

func (x *MessageData) GetVerificationRemoveBody() *VerificationRemoveBody

func (*MessageData) ProtoMessage 

func (*MessageData) ProtoMessage()

func (*MessageData) ProtoReflect 

func (x *MessageData) ProtoReflect() protoreflect.Message

func (*MessageData) Reset 

func (x *MessageData) Reset()

func (*MessageData) String 

func (x *MessageData) String() string

type MessageData_CastAddBody 

type MessageData_CastAddBody struct {
	CastAddBody *CastAddBody `protobuf:"bytes,5,opt,name=cast_add_body,json=castAddBody,proto3,oneof"`
}

type MessageData_CastRemoveBody 

type MessageData_CastRemoveBody struct {
	CastRemoveBody *CastRemoveBody `protobuf:"bytes,6,opt,name=cast_remove_body,json=castRemoveBody,proto3,oneof"`
}

type MessageData_FrameActionBody 

type MessageData_FrameActionBody struct {
	FrameActionBody *FrameActionBody `protobuf:"bytes,16,opt,name=frame_action_body,json=frameActionBody,proto3,oneof"`
}

type MessageData_LinkBody 

type MessageData_LinkBody struct {
	// SignerRemoveBody signer_remove_body = 13; // Deprecated
	LinkBody *LinkBody `protobuf:"bytes,14,opt,name=link_body,json=linkBody,proto3,oneof"`
}

type MessageData_ReactionBody 

type MessageData_ReactionBody struct {
	ReactionBody *ReactionBody `protobuf:"bytes,7,opt,name=reaction_body,json=reactionBody,proto3,oneof"`
}

type MessageData_UserDataBody 

type MessageData_UserDataBody struct {
	// SignerAddBody signer_add_body = 11; // Deprecated
	UserDataBody *UserDataBody `protobuf:"bytes,12,opt,name=user_data_body,json=userDataBody,proto3,oneof"`
}

type MessageData_UsernameProofBody 

type MessageData_UsernameProofBody struct {
	UsernameProofBody *UserNameProof `protobuf:"bytes,15,opt,name=username_proof_body,json=usernameProofBody,proto3,oneof"`
}

type MessageData_VerificationAddAddressBody 

type MessageData_VerificationAddAddressBody struct {
	VerificationAddAddressBody *VerificationAddAddressBody `protobuf:"bytes,9,opt,name=verification_add_address_body,json=verificationAddAddressBody,proto3,oneof"`
}

type MessageData_VerificationRemoveBody 

type MessageData_VerificationRemoveBody struct {
	VerificationRemoveBody *VerificationRemoveBody `protobuf:"bytes,10,opt,name=verification_remove_body,json=verificationRemoveBody,proto3,oneof"`
}

type MessageType 

type MessageType int32

* Type of the MessageBody 

const (
	MessageType_MESSAGE_TYPE_NONE                         MessageType = 0
	MessageType_MESSAGE_TYPE_CAST_ADD                     MessageType = 1 // Add a new Cast
	MessageType_MESSAGE_TYPE_CAST_REMOVE                  MessageType = 2 // Remove an existing Cast
	MessageType_MESSAGE_TYPE_REACTION_ADD                 MessageType = 3 // Add a Reaction to a Cast
	MessageType_MESSAGE_TYPE_REACTION_REMOVE              MessageType = 4 // Remove a Reaction from a Cast
	MessageType_MESSAGE_TYPE_LINK_ADD                     MessageType = 5 // Add a new Link
	MessageType_MESSAGE_TYPE_LINK_REMOVE                  MessageType = 6 // Remove an existing Link
	MessageType_MESSAGE_TYPE_VERIFICATION_ADD_ETH_ADDRESS MessageType = 7 // Add a Verification of an Ethereum Address
	MessageType_MESSAGE_TYPE_VERIFICATION_REMOVE          MessageType = 8 // Remove a Verification
	// Deprecated
	// MESSAGE_TYPE_SIGNER_ADD = 9; // Add a new Ed25519 key pair that signs messages for a user
	// MESSAGE_TYPE_SIGNER_REMOVE = 10; // Remove an Ed25519 key pair that signs messages for a user
	MessageType_MESSAGE_TYPE_USER_DATA_ADD  MessageType = 11 // Add metadata about a user
	MessageType_MESSAGE_TYPE_USERNAME_PROOF MessageType = 12 // Add or replace a username proof
	MessageType_MESSAGE_TYPE_FRAME_ACTION   MessageType = 13 // A Farcaster Frame action
)

func (MessageType) Descriptor 

func (MessageType) Descriptor() protoreflect.EnumDescriptor

func (MessageType) Enum 

func (x MessageType) Enum() *MessageType

func (MessageType) EnumDescriptor deprecated 

func (MessageType) EnumDescriptor() ([]byte, []int)

Deprecated: Use MessageType.Descriptor instead.

func (MessageType) Number 

func (x MessageType) Number() protoreflect.EnumNumber

func (MessageType) String 

func (x MessageType) String() string

func (MessageType) Type 

func (MessageType) Type() protoreflect.EnumType

type Protocol 

type Protocol int32

* Type of Protocol to disambiguate verification addresses 

const (
	Protocol_PROTOCOL_ETHEREUM Protocol = 0
	Protocol_PROTOCOL_SOLANA   Protocol = 1
)

func (Protocol) Descriptor 

func (Protocol) Descriptor() protoreflect.EnumDescriptor

func (Protocol) Enum 

func (x Protocol) Enum() *Protocol

func (Protocol) EnumDescriptor deprecated 

func (Protocol) EnumDescriptor() ([]byte, []int)

Deprecated: Use Protocol.Descriptor instead.

func (Protocol) Number 

func (x Protocol) Number() protoreflect.EnumNumber

func (Protocol) String 

func (x Protocol) String() string

func (Protocol) Type 

func (Protocol) Type() protoreflect.EnumType

type ReactionBody 

type ReactionBody struct {
	Type ReactionType `protobuf:"varint,1,opt,name=type,proto3,enum=farcasterapi.hub.proto.ReactionType" json:"type,omitempty"` // Type of reaction
	// Types that are assignable to Target:
	//
	//	*ReactionBody_TargetCastId
	//	*ReactionBody_TargetUrl
	Target isReactionBody_Target `protobuf_oneof:"target"`
	// contains filtered or unexported fields
}

* Adds or removes a Reaction from a Cast

func (*ReactionBody) Descriptor deprecated 

func (*ReactionBody) Descriptor() ([]byte, []int)

Deprecated: Use ReactionBody.ProtoReflect.Descriptor instead.

func (*ReactionBody) GetTarget 

func (m *ReactionBody) GetTarget() isReactionBody_Target

func (*ReactionBody) GetTargetCastId 

func (x *ReactionBody) GetTargetCastId() *CastId

func (*ReactionBody) GetTargetUrl 

func (x *ReactionBody) GetTargetUrl() string

func (*ReactionBody) GetType 

func (x *ReactionBody) GetType() ReactionType

func (*ReactionBody) ProtoMessage 

func (*ReactionBody) ProtoMessage()

func (*ReactionBody) ProtoReflect 

func (x *ReactionBody) ProtoReflect() protoreflect.Message

func (*ReactionBody) Reset 

func (x *ReactionBody) Reset()

func (*ReactionBody) String 

func (x *ReactionBody) String() string

type ReactionBody_TargetCastId 

type ReactionBody_TargetCastId struct {
	TargetCastId *CastId `protobuf:"bytes,2,opt,name=target_cast_id,json=targetCastId,proto3,oneof"` // CastId of the Cast to react to
}

type ReactionBody_TargetUrl 

type ReactionBody_TargetUrl struct {
	TargetUrl string `protobuf:"bytes,3,opt,name=target_url,json=targetUrl,proto3,oneof"` // URL to react to
}

type ReactionType 

type ReactionType int32

* Type of Reaction 

const (
	ReactionType_REACTION_TYPE_NONE   ReactionType = 0
	ReactionType_REACTION_TYPE_LIKE   ReactionType = 1 // Like the target cast
	ReactionType_REACTION_TYPE_RECAST ReactionType = 2 // Share target cast to the user's audience
)

func (ReactionType) Descriptor 

func (ReactionType) Descriptor() protoreflect.EnumDescriptor

func (ReactionType) Enum 

func (x ReactionType) Enum() *ReactionType

func (ReactionType) EnumDescriptor deprecated 

func (ReactionType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ReactionType.Descriptor instead.

func (ReactionType) Number 

func (x ReactionType) Number() protoreflect.EnumNumber

func (ReactionType) String 

func (x ReactionType) String() string

func (ReactionType) Type 

func (ReactionType) Type() protoreflect.EnumType

type SignatureScheme 

type SignatureScheme int32

* Type of signature scheme used to sign the Message hash 

const (
	SignatureScheme_SIGNATURE_SCHEME_NONE    SignatureScheme = 0
	SignatureScheme_SIGNATURE_SCHEME_ED25519 SignatureScheme = 1 // Ed25519 signature (default)
	SignatureScheme_SIGNATURE_SCHEME_EIP712  SignatureScheme = 2 // ECDSA signature using EIP-712 scheme
)

func (SignatureScheme) Descriptor 

func (SignatureScheme) Descriptor() protoreflect.EnumDescriptor

func (SignatureScheme) Enum 

func (x SignatureScheme) Enum() *SignatureScheme

func (SignatureScheme) EnumDescriptor deprecated 

func (SignatureScheme) EnumDescriptor() ([]byte, []int)

Deprecated: Use SignatureScheme.Descriptor instead.

func (SignatureScheme) Number 

func (x SignatureScheme) Number() protoreflect.EnumNumber

func (SignatureScheme) String 

func (x SignatureScheme) String() string

func (SignatureScheme) Type 

func (SignatureScheme) Type() protoreflect.EnumType

type UserDataBody 

type UserDataBody struct {
	Type  UserDataType `protobuf:"varint,1,opt,name=type,proto3,enum=farcasterapi.hub.proto.UserDataType" json:"type,omitempty"` // Type of metadata
	Value string       `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`                                         // Value of the metadata
	// contains filtered or unexported fields
}

* Adds metadata about a user

func (*UserDataBody) Descriptor deprecated 

func (*UserDataBody) Descriptor() ([]byte, []int)

Deprecated: Use UserDataBody.ProtoReflect.Descriptor instead.

func (*UserDataBody) GetType 

func (x *UserDataBody) GetType() UserDataType

func (*UserDataBody) GetValue 

func (x *UserDataBody) GetValue() string

func (*UserDataBody) ProtoMessage 

func (*UserDataBody) ProtoMessage()

func (*UserDataBody) ProtoReflect 

func (x *UserDataBody) ProtoReflect() protoreflect.Message

func (*UserDataBody) Reset 

func (x *UserDataBody) Reset()

func (*UserDataBody) String 

func (x *UserDataBody) String() string

type UserDataType 

type UserDataType int32

* Type of UserData 

const (
	UserDataType_USER_DATA_TYPE_NONE     UserDataType = 0
	UserDataType_USER_DATA_TYPE_PFP      UserDataType = 1 // Profile Picture for the user
	UserDataType_USER_DATA_TYPE_DISPLAY  UserDataType = 2 // Display Name for the user
	UserDataType_USER_DATA_TYPE_BIO      UserDataType = 3 // Bio for the user
	UserDataType_USER_DATA_TYPE_URL      UserDataType = 5 // URL of the user
	UserDataType_USER_DATA_TYPE_USERNAME UserDataType = 6 // Preferred Name for the user
)

func (UserDataType) Descriptor 

func (UserDataType) Descriptor() protoreflect.EnumDescriptor

func (UserDataType) Enum 

func (x UserDataType) Enum() *UserDataType

func (UserDataType) EnumDescriptor deprecated 

func (UserDataType) EnumDescriptor() ([]byte, []int)

Deprecated: Use UserDataType.Descriptor instead.

func (UserDataType) Number 

func (x UserDataType) Number() protoreflect.EnumNumber

func (UserDataType) String 

func (x UserDataType) String() string

func (UserDataType) Type 

func (UserDataType) Type() protoreflect.EnumType

type UserNameProof 

type UserNameProof struct {
	Timestamp uint64       `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Name      []byte       `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Owner     []byte       `protobuf:"bytes,3,opt,name=owner,proto3" json:"owner,omitempty"`
	Signature []byte       `protobuf:"bytes,4,opt,name=signature,proto3" json:"signature,omitempty"`
	Fid       uint64       `protobuf:"varint,5,opt,name=fid,proto3" json:"fid,omitempty"`
	Type      UserNameType `protobuf:"varint,6,opt,name=type,proto3,enum=farcasterapi.hub.proto.UserNameType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*UserNameProof) Descriptor deprecated 

func (*UserNameProof) Descriptor() ([]byte, []int)

Deprecated: Use UserNameProof.ProtoReflect.Descriptor instead.

func (*UserNameProof) GetFid 

func (x *UserNameProof) GetFid() uint64

func (*UserNameProof) GetName 

func (x *UserNameProof) GetName() []byte

func (*UserNameProof) GetOwner 

func (x *UserNameProof) GetOwner() []byte

func (*UserNameProof) GetSignature 

func (x *UserNameProof) GetSignature() []byte

func (*UserNameProof) GetTimestamp 

func (x *UserNameProof) GetTimestamp() uint64

func (*UserNameProof) GetType 

func (x *UserNameProof) GetType() UserNameType

func (*UserNameProof) ProtoMessage 

func (*UserNameProof) ProtoMessage()

func (*UserNameProof) ProtoReflect 

func (x *UserNameProof) ProtoReflect() protoreflect.Message

func (*UserNameProof) Reset 

func (x *UserNameProof) Reset()

func (*UserNameProof) String 

func (x *UserNameProof) String() string

type UserNameType 

type UserNameType int32
const (
	UserNameType_USERNAME_TYPE_NONE   UserNameType = 0
	UserNameType_USERNAME_TYPE_FNAME  UserNameType = 1
	UserNameType_USERNAME_TYPE_ENS_L1 UserNameType = 2
)

func (UserNameType) Descriptor 

func (UserNameType) Descriptor() protoreflect.EnumDescriptor

func (UserNameType) Enum 

func (x UserNameType) Enum() *UserNameType

func (UserNameType) EnumDescriptor deprecated 

func (UserNameType) EnumDescriptor() ([]byte, []int)

Deprecated: Use UserNameType.Descriptor instead.

func (UserNameType) Number 

func (x UserNameType) Number() protoreflect.EnumNumber

func (UserNameType) String 

func (x UserNameType) String() string

func (UserNameType) Type 

func (UserNameType) Type() protoreflect.EnumType

type VerificationAddAddressBody 

type VerificationAddAddressBody struct {
	Address          []byte   `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`                                            // Address being verified for a given Protocol
	ClaimSignature   []byte   `protobuf:"bytes,2,opt,name=claim_signature,json=claimSignature,proto3" json:"claim_signature,omitempty"`        // Signature produced by the user's address for a given Protocol
	BlockHash        []byte   `protobuf:"bytes,3,opt,name=block_hash,json=blockHash,proto3" json:"block_hash,omitempty"`                       // Hash of the latest Ethereum block when the signature was produced
	VerificationType uint32   `protobuf:"varint,4,opt,name=verification_type,json=verificationType,proto3" json:"verification_type,omitempty"` // Type of verification. 0 = EOA, 1 = contract
	ChainId          uint32   `protobuf:"varint,5,opt,name=chain_id,json=chainId,proto3" json:"chain_id,omitempty"`                            // 0 for EOA verifications, 1 or 10 for contract verifications
	Protocol         Protocol `protobuf:"varint,7,opt,name=protocol,proto3,enum=farcasterapi.hub.proto.Protocol" json:"protocol,omitempty"`    // Protocol of the Verification
	// contains filtered or unexported fields
}

* Adds a Verification of ownership of an Address based on Protocol

func (*VerificationAddAddressBody) Descriptor deprecated 

func (*VerificationAddAddressBody) Descriptor() ([]byte, []int)

Deprecated: Use VerificationAddAddressBody.ProtoReflect.Descriptor instead.

func (*VerificationAddAddressBody) GetAddress 

func (x *VerificationAddAddressBody) GetAddress() []byte

func (*VerificationAddAddressBody) GetBlockHash 

func (x *VerificationAddAddressBody) GetBlockHash() []byte

func (*VerificationAddAddressBody) GetChainId 

func (x *VerificationAddAddressBody) GetChainId() uint32

func (*VerificationAddAddressBody) GetClaimSignature 

func (x *VerificationAddAddressBody) GetClaimSignature() []byte

func (*VerificationAddAddressBody) GetProtocol 

func (x *VerificationAddAddressBody) GetProtocol() Protocol

func (*VerificationAddAddressBody) GetVerificationType 

func (x *VerificationAddAddressBody) GetVerificationType() uint32

func (*VerificationAddAddressBody) ProtoMessage 

func (*VerificationAddAddressBody) ProtoMessage()

func (*VerificationAddAddressBody) ProtoReflect 

func (x *VerificationAddAddressBody) ProtoReflect() protoreflect.Message

func (*VerificationAddAddressBody) Reset 

func (x *VerificationAddAddressBody) Reset()

func (*VerificationAddAddressBody) String 

func (x *VerificationAddAddressBody) String() string

type VerificationRemoveBody 

type VerificationRemoveBody struct {
	Address  []byte   `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`                                         // Address of the Verification to remove
	Protocol Protocol `protobuf:"varint,2,opt,name=protocol,proto3,enum=farcasterapi.hub.proto.Protocol" json:"protocol,omitempty"` // Protocol of the Verification to remove
	// contains filtered or unexported fields
}

* Removes a Verification of a given protocol

func (*VerificationRemoveBody) Descriptor deprecated 

func (*VerificationRemoveBody) Descriptor() ([]byte, []int)

Deprecated: Use VerificationRemoveBody.ProtoReflect.Descriptor instead.

func (*VerificationRemoveBody) GetAddress 

func (x *VerificationRemoveBody) GetAddress() []byte

func (*VerificationRemoveBody) GetProtocol 

func (x *VerificationRemoveBody) GetProtocol() Protocol

func (*VerificationRemoveBody) ProtoMessage 

func (*VerificationRemoveBody) ProtoMessage()

func (*VerificationRemoveBody) ProtoReflect 

func (x *VerificationRemoveBody) ProtoReflect() protoreflect.Message

func (*VerificationRemoveBody) Reset 

func (x *VerificationRemoveBody) Reset()

func (*VerificationRemoveBody) String 

func (x *VerificationRemoveBody) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.