Documentation
¶
Overview ¶
Package common provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- type ContractId
- type DisclosedContract
- type EDSBaseUrl
- type ErrorResponse
- type HashedInstrumentId
- type InstanceAddress
- type InstrumentId
- type Message
- type MessageExecutorType
- type N400
- type N404
- type N500
- type PartyId
- type RawInstanceAddress
- type RawOrHashedAddress
- func (t RawOrHashedAddress) AsInstanceAddress() (InstanceAddress, error)
- func (t RawOrHashedAddress) AsRawInstanceAddress() (RawInstanceAddress, error)
- func (t *RawOrHashedAddress) FromInstanceAddress(v InstanceAddress) error
- func (t *RawOrHashedAddress) FromRawInstanceAddress(v RawInstanceAddress) error
- func (t RawOrHashedAddress) MarshalJSON() ([]byte, error)
- func (t *RawOrHashedAddress) MergeInstanceAddress(v InstanceAddress) error
- func (t *RawOrHashedAddress) MergeRawInstanceAddress(v RawInstanceAddress) error
- func (t *RawOrHashedAddress) UnmarshalJSON(b []byte) error
- type RawOrHashedInstrumentId
- func (t RawOrHashedInstrumentId) AsHashedInstrumentId() (HashedInstrumentId, error)
- func (t RawOrHashedInstrumentId) AsInstrumentId() (InstrumentId, error)
- func (t *RawOrHashedInstrumentId) FromHashedInstrumentId(v HashedInstrumentId) error
- func (t *RawOrHashedInstrumentId) FromInstrumentId(v InstrumentId) error
- func (t RawOrHashedInstrumentId) MarshalJSON() ([]byte, error)
- func (t *RawOrHashedInstrumentId) MergeHashedInstrumentId(v HashedInstrumentId) error
- func (t *RawOrHashedInstrumentId) MergeInstrumentId(v InstrumentId) error
- func (t *RawOrHashedInstrumentId) UnmarshalJSON(b []byte) error
- type TokenTransfer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DisclosedContract ¶
type DisclosedContract struct {
// ContractId The unique identifier of a contract.
ContractId ContractId `json:"contractId"`
CreatedEventBlob string `json:"createdEventBlob"`
// SynchronizerId The synchronizer to which the contract is currently assigned.
SynchronizerId string `json:"synchronizerId"`
TemplateId string `json:"templateId"`
}
DisclosedContract A disclosed contract, to be used by the caller during submission.
type ErrorResponse ¶
type ErrorResponse struct {
Details *string `json:"details,omitempty"`
Error string `json:"error"`
}
ErrorResponse defines model for ErrorResponse.
type HashedInstrumentId ¶
type HashedInstrumentId = string
HashedInstrumentId The hashed identifier of an instrument, the keccak256 hash of the concatenated InstrumentId in the form of `id@admin`.
type InstanceAddress ¶
type InstanceAddress = string
InstanceAddress The InstanceAddress of a contract, the keccak256 hash of the RawInstanceAddress.
type InstrumentId ¶
type InstrumentId struct {
// Admin The unique identifier of a party.
Admin PartyId `json:"admin"`
Id string `json:"id"`
}
InstrumentId A globally unique identifier for instruments.
type Message ¶
type Message struct {
// DestinationChainSelector The chain selector of the destination chain.
DestinationChainSelector string `json:"destinationChainSelector"`
// Executor The executor of the message, which determines the executor the message will be forwarded to on the source chain.
// If not specified, or if type is "", the message will be executed with the default executor on the remote chain.
// If type is "noExecutor", the message will not be executed automatically on the remote chain.
// If type is "withAddress", the message will be executed with an executor at the specified address.
Executor struct {
// Address An address which can be either a RawInstanceAddress or an InstanceAddress.
Address *RawOrHashedAddress `json:"address,omitempty"`
Type MessageExecutorType `json:"type"`
} `json:"executor"`
// FeeToken A globally unique identifier for instruments.
FeeToken InstrumentId `json:"feeToken"`
// Payload The payload of the message, encoded as a hex string.
Payload string `json:"payload"`
// Receiver The receiver of the message on the remote chain, encoded as a hex string.
Receiver string `json:"receiver"`
// TokenTransfer A token transfer to be included in the message, set to null if the message does not include a token transfer.
TokenTransfer *TokenTransfer `json:"tokenTransfer,omitempty"`
}
Message A message to be sent from Canton.
type MessageExecutorType ¶
type MessageExecutorType string
MessageExecutorType defines model for Message.Executor.Type.
const ( Empty MessageExecutorType = "" NoExecutor MessageExecutorType = "noExecutor" WithAddress MessageExecutorType = "withAddress" )
Defines values for MessageExecutorType.
type RawInstanceAddress ¶
type RawInstanceAddress = string
RawInstanceAddress The raw InstanceAddress of a contract, in the form of "prefix@owner", where prefix is the InstanceId of the contract.
type RawOrHashedAddress ¶
type RawOrHashedAddress struct {
// contains filtered or unexported fields
}
RawOrHashedAddress An address which can be either a RawInstanceAddress or an InstanceAddress.
func (RawOrHashedAddress) AsInstanceAddress ¶
func (t RawOrHashedAddress) AsInstanceAddress() (InstanceAddress, error)
AsInstanceAddress returns the union data inside the RawOrHashedAddress as a InstanceAddress
func (RawOrHashedAddress) AsRawInstanceAddress ¶
func (t RawOrHashedAddress) AsRawInstanceAddress() (RawInstanceAddress, error)
AsRawInstanceAddress returns the union data inside the RawOrHashedAddress as a RawInstanceAddress
func (*RawOrHashedAddress) FromInstanceAddress ¶
func (t *RawOrHashedAddress) FromInstanceAddress(v InstanceAddress) error
FromInstanceAddress overwrites any union data inside the RawOrHashedAddress as the provided InstanceAddress
func (*RawOrHashedAddress) FromRawInstanceAddress ¶
func (t *RawOrHashedAddress) FromRawInstanceAddress(v RawInstanceAddress) error
FromRawInstanceAddress overwrites any union data inside the RawOrHashedAddress as the provided RawInstanceAddress
func (RawOrHashedAddress) MarshalJSON ¶
func (t RawOrHashedAddress) MarshalJSON() ([]byte, error)
func (*RawOrHashedAddress) MergeInstanceAddress ¶
func (t *RawOrHashedAddress) MergeInstanceAddress(v InstanceAddress) error
MergeInstanceAddress performs a merge with any union data inside the RawOrHashedAddress, using the provided InstanceAddress
func (*RawOrHashedAddress) MergeRawInstanceAddress ¶
func (t *RawOrHashedAddress) MergeRawInstanceAddress(v RawInstanceAddress) error
MergeRawInstanceAddress performs a merge with any union data inside the RawOrHashedAddress, using the provided RawInstanceAddress
func (*RawOrHashedAddress) UnmarshalJSON ¶
func (t *RawOrHashedAddress) UnmarshalJSON(b []byte) error
type RawOrHashedInstrumentId ¶
type RawOrHashedInstrumentId struct {
// contains filtered or unexported fields
}
RawOrHashedInstrumentId An instrument identifier which can be either a RawInstrumentId or a HashedInstrumentId.
func (RawOrHashedInstrumentId) AsHashedInstrumentId ¶
func (t RawOrHashedInstrumentId) AsHashedInstrumentId() (HashedInstrumentId, error)
AsHashedInstrumentId returns the union data inside the RawOrHashedInstrumentId as a HashedInstrumentId
func (RawOrHashedInstrumentId) AsInstrumentId ¶
func (t RawOrHashedInstrumentId) AsInstrumentId() (InstrumentId, error)
AsInstrumentId returns the union data inside the RawOrHashedInstrumentId as a InstrumentId
func (*RawOrHashedInstrumentId) FromHashedInstrumentId ¶
func (t *RawOrHashedInstrumentId) FromHashedInstrumentId(v HashedInstrumentId) error
FromHashedInstrumentId overwrites any union data inside the RawOrHashedInstrumentId as the provided HashedInstrumentId
func (*RawOrHashedInstrumentId) FromInstrumentId ¶
func (t *RawOrHashedInstrumentId) FromInstrumentId(v InstrumentId) error
FromInstrumentId overwrites any union data inside the RawOrHashedInstrumentId as the provided InstrumentId
func (RawOrHashedInstrumentId) MarshalJSON ¶
func (t RawOrHashedInstrumentId) MarshalJSON() ([]byte, error)
func (*RawOrHashedInstrumentId) MergeHashedInstrumentId ¶
func (t *RawOrHashedInstrumentId) MergeHashedInstrumentId(v HashedInstrumentId) error
MergeHashedInstrumentId performs a merge with any union data inside the RawOrHashedInstrumentId, using the provided HashedInstrumentId
func (*RawOrHashedInstrumentId) MergeInstrumentId ¶
func (t *RawOrHashedInstrumentId) MergeInstrumentId(v InstrumentId) error
MergeInstrumentId performs a merge with any union data inside the RawOrHashedInstrumentId, using the provided InstrumentId
func (*RawOrHashedInstrumentId) UnmarshalJSON ¶
func (t *RawOrHashedInstrumentId) UnmarshalJSON(b []byte) error
type TokenTransfer ¶
type TokenTransfer struct {
// Amount The decimal amount of the token to be transferred.
Amount string `json:"amount"`
// Token A globally unique identifier for instruments.
Token InstrumentId `json:"token"`
}
TokenTransfer A token transfer to be included in the message, set to null if the message does not include a token transfer.