Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Ack ¶
type Ack struct {
// message
Message string `json:"message,omitempty"`
// status
Status string `json:"status,omitempty"`
}
Ack ack
swagger:model Ack
func (*Ack) ContextValidate ¶
ContextValidate validates this ack based on context it is used
func (*Ack) MarshalBinary ¶
MarshalBinary interface implementation
func (*Ack) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// code
// Required: true
Code *int32 `json:"code"`
// fields
Fields string `json:"fields,omitempty"`
// message
// Required: true
Message *string `json:"message"`
}
Error error
swagger:model Error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type GatewayRegister ¶
type GatewayRegister struct {
// RootKey is the gateway's public key,
// and can be used to derive the filecoin wallet address for payment.
// It is a 65 bytes hex string.
RootKey string `json:"root_key,omitempty"`
// NodeIDD is derived from the root key, it is set by the smart contract.
// It is a 32 bytes hex string.
NodeID string `json:"node_id,omitempty"`
// MsgSigningKey is the message signing public key.
// It is a 65 bytes hex string.
// This can be updated via smart contract.
MsgSigningKey string `json:"msg_signing_key,omitempty"`
// MsgSigningKeyVer is the message signing public key version.
// This can be updated via smart contract.
MsgSigningKeyVer byte `json:"msg_signing_key_ver,omitempty"`
// RegionCode is the region code of this gateway.
// It is a ISO 3166-1 alpha-2 string.
RegionCode string `json:"region_code,omitempty"`
// NetworkAddr is the network address of this gateway.
// It should be a valid libp2p address.
NetworkAddr string `json:"network_addr,omitempty"`
// Deregistering indicates whether or not this gateway is in the middle of deregistering itself.
// It is set by the smart contract.
Deregistering bool `json:"deregistering,omitempty"`
// DeregisteringHeight is the height of the block which contains the deregistering transaction.
// It is set by the smart contract.
DeregisteringHeight uint64 `json:"deregistering_height,omitempty"`
}
GatewayRegister Register entry
swagger:model GatewayRegister
func (*GatewayRegister) ContextValidate ¶
ContextValidate validates this gateway register based on context it is used
func (*GatewayRegister) MarshalBinary ¶
func (m *GatewayRegister) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GatewayRegister) UnmarshalBinary ¶
func (m *GatewayRegister) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Principal ¶
type Principal string
Principal principal
swagger:model Principal
func (Principal) ContextValidate ¶
ContextValidate validates this principal based on context it is used
type ProviderRegister ¶
type ProviderRegister struct {
// RootKey is the provider's public key,
// and can be used to derive the filecoin wallet address for payment.
// It is a 65 bytes hex string.
RootKey string `json:"root_key,omitempty"`
// NodeIDD is derived from the root key, it is set by the smart contract.
// It is a 32 bytes hex string.
NodeID string `json:"node_id,omitempty"`
// MsgSigningKey is the message signing public key.
// It is a 65 bytes hex string.
// This can be updated via smart contract.
MsgSigningKey string `json:"msg_signing_key,omitempty"`
// MsgSigningKeyVer is the message signing public key version.
// This can be updated via smart contract.
MsgSigningKeyVer byte `json:"msg_signing_key_ver,omitempty"`
// OfferSigningKey is the offer signing public key.
// It is a 65 bytes hex string.
OfferSigningKey string `json:"offer_signing_key,omitempty"`
// RegionCode is the region code of this provider.
// It is a ISO 3166-1 alpha-2 string.
RegionCode string `json:"region_code,omitempty"`
// NetworkAddr is the network address of this provider.
// It should be a valid libp2p address.
NetworkAddr string `json:"network_addr,omitempty"`
// Deregistering indicates whether or not this provider is in the middle of deregistering itself.
// It is set by the smart contract.
Deregistering bool `json:"deregistering,omitempty"`
// DeregisteringHeight is the height of the block which contains the deregistering transaction.
// It is set by the smart contract.
DeregisteringHeight uint64 `json:"deregistering_height,omitempty"`
}
ProviderRegister Register entry
swagger:model ProviderRegister
func (*ProviderRegister) ContextValidate ¶
ContextValidate validates this provider register based on context it is used
func (*ProviderRegister) MarshalBinary ¶
func (m *ProviderRegister) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProviderRegister) UnmarshalBinary ¶
func (m *ProviderRegister) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation