package chainlink.v1beta

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the Msg gPRC service.

• rpc AddAccountTx (MsgAccount, MsgResponse)

  tx.proto:26

• rpc AddDataProviderTx (MsgAddDataProvider, MsgResponse)

  tx.proto:18

  message MsgAddDataProvider

  tx.proto:79

  MsgAddProvider is the type defined for adding new data provider of the feed

  • string feedId = 1

    FeedId is the unique identifier of the feed

  • optional DataProvider dataProvider = 2

    DataProvider is the new data provider of the feed to add

  • bytes signer = 3

    Signer is the feed owner who signs the add feed provided tx

• rpc AddFeedTx (MsgFeed, MsgResponse)

  tx.proto:17

• rpc AddModuleOwnerTx (MsgModuleOwner, MsgResponse)

  tx.proto:15

• rpc EditAccountTx (MsgEditAccount, MsgResponse)

  tx.proto:27

  message MsgEditAccount

  tx.proto:191

  MsgEditAccount is the type defined to edit a Chainlink account

  • bytes submitter = 1

    submitter - associated cosmos account address

  • bytes piggyAddress = 2

    piggyAddress - cosmos account address receivable for reward and fee distribution

• rpc FeedOwnershipTransferTx (MsgFeedOwnershipTransfer, MsgResponse)

  tx.proto:25

  message MsgFeedOwnershipTransfer

  tx.proto:139

  MsgFeedOwnershipTransfer is the type defined for feed ownership transfer

  • string feedId = 1

    FeedId is the unique identifier of the feed

  • bytes newFeedOwnerAddress = 2

    NewFeedOwnerAddress is the address of the new owner of the feed

  • bytes signer = 3

    Signer is the feed owner who signs the tx

• rpc ModuleOwnershipTransferTx (MsgModuleOwnershipTransfer, MsgResponse)

  tx.proto:16

  message MsgModuleOwnershipTransfer

  tx.proto:31

  MsgModuleOwnershipTransfer is the type defined for module ownership transfer

  • bytes assignerAddress = 1

    current module owner address

  • bytes newModuleOwnerAddress = 2

  • bytes newModuleOwnerPubKey = 3

• rpc RemoveDataProviderTx (MsgRemoveDataProvider, MsgResponse)

  tx.proto:19

  message MsgRemoveDataProvider

  tx.proto:89

  MsgRemoveProvider is the type defined for removing a data provider of the feed

  • string feedId = 1

    FeedId is the unique identifier of the feed

  • bytes address = 2

    Address of the data provider to remove from the feed

  • bytes signer = 3

    Signer is the feed owner who signs the remove feed provided tx

• rpc RequestNewRoundTx (MsgRequestNewRound, MsgResponse)

  tx.proto:24

  message MsgRequestNewRound

  tx.proto:171

  MsgRequestNewRound is the type defined for requesting new rounds to be triggered for a given feed

  • string feedId = 1

    FeedId is the unique identifier of the feed

  • bytes signer = 3

    Signer is the feed owner who signs the tx

• rpc SetDeviationThresholdTriggerTx (MsgSetDeviationThresholdTrigger, MsgResponse)

  tx.proto:22

  message MsgSetDeviationThresholdTrigger

  tx.proto:117

  • string feedId = 1

    FeedId is the unique identifier of the feed

  • uint32 deviationThresholdTrigger = 2

    The fraction of deviation in the feed data required to trigger a new round. For example if the price of ATOM/USD changes by 1% then a new round should occur even if the heartbeat interval has not elapsed.

  • bytes signer = 3

    Signer is the feed owner who signs the tx

• rpc SetFeedRewardTx (MsgSetFeedReward, MsgResponse)

  tx.proto:23

  message MsgSetFeedReward

  tx.proto:128

  • string feedId = 1

    FeedId is the unique identifier of the feed

  • optional FeedRewardSchema feedReward = 2

    The reward distributed to the data providers in a given feed. The reward will be given as the native token in the application, denominated as "link"

  • bytes signer = 3

    Signer is the feed owner who signs the tx

• rpc SetHeartbeatTriggerTx (MsgSetHeartbeatTrigger, MsgResponse)

  tx.proto:21

  message MsgSetHeartbeatTrigger

  tx.proto:107

  • string feedId = 1

    FeedId is the unique identifier of the feed

  • uint32 heartbeatTrigger = 2

    The interval between which a new round should automatically be triggered. The given value in milliseconds will only be approximate within block intervals

  • bytes signer = 3

    Signer is the feed owner who signs the tx

• rpc SetSubmissionCountTx (MsgSetSubmissionCount, MsgResponse)

  tx.proto:20

  message MsgSetSubmissionCount

  tx.proto:98

  • string feedId = 1

    FeedId is the unique identifier of the feed

  • uint32 submissionCount = 2

    The number of signatures required for a feedData submission to be valid

  • bytes signer = 3

    Signer is the feed owner who signs the tx

• rpc SubmitFeedDataTx (MsgFeedData, MsgResponse)

  tx.proto:12

Query defines the gRPC querier service.

• rpc GetAccountInfo (GetAccountRequest, GetAccountResponse)

  query.proto:26

  message GetAccountRequest

  query.proto:73

  • bytes accountAddress = 1

  message GetAccountResponse

  query.proto:77

  • optional MsgAccount account = 1

• rpc GetAllModuleOwner (GetModuleOwnerRequest, GetModuleOwnerResponse)

  query.proto:20

  message GetModuleOwnerRequest

  query.proto:42

  (message has no fields)

  message GetModuleOwnerResponse

  query.proto:45

  • repeated MsgModuleOwner moduleOwner = 1

• rpc GetFeedByFeedId (GetFeedByIdRequest, GetFeedByIdResponse)

  query.proto:23

  message GetFeedByIdRequest

  query.proto:34

  • string feedId = 1

  message GetFeedByIdResponse

  query.proto:38

  • optional MsgFeed feed = 1

• rpc GetFeedRewardAvailStrategy (GetFeedRewardAvailStrategiesRequest, GetFeedRewardAvailStrategiesResponse)

  query.proto:29

  message GetFeedRewardAvailStrategiesRequest

  query.proto:80

  (message has no fields)

  message GetFeedRewardAvailStrategiesResponse

  query.proto:83

  • repeated string availStrategies = 1

• rpc GetRoundData (GetRoundDataRequest, GetRoundDataResponse)

  query.proto:14

  message GetRoundDataRequest

  query.proto:49

  • string feedId = 1

  • uint64 roundId = 2

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 3

  message GetRoundDataResponse

  query.proto:55

  • repeated RoundData roundData = 1

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 2

• rpc LatestRoundData (GetLatestRoundDataRequest, GetLatestRoundDataResponse)

  query.proto:17

  message GetLatestRoundDataRequest

  query.proto:60

  • string feedId = 1

  message GetLatestRoundDataResponse

  query.proto:64

  • repeated RoundData roundData = 1

Used in: MsgFeedData

• string denom = 1

• uint64 amount = 2

DataProvider is the type defined for feed data provider

Used in: MsgAddDataProvider, MsgFeed, MsgFeedDataValidationFailedEvent, MsgNewFeedEvent

• bytes address = 1

• bytes pubKey = 2

Used in: MsgFeed, MsgSetFeedReward

• uint64 amount = 1

  amount is the base value that rewarded to each valid data provider before designated strategy applied amount is not allowed to be zero

• string strategy = 2

  reward strategy name, must be a registered strategy this is allowed to be empty, in which case every data provider will be rewarded the same amount token

• repeated MsgModuleOwner moduleOwners = 1

  MsgModuleOwner is an array containing the chainlink init module owner accounts.

MsgAccount is the type defined for account associated with the Chainlink node

Used as request type in: Msg.AddAccountTx

Used as field type in: GetAccountResponse

• bytes submitter = 1

  submitter - associated cosmos account address

• bytes chainlinkPublicKey = 2

  chainlinkPublicKey - public key of the associated Chainlink Oracle account

• bytes chainlinkSigningKey = 3

  chainlinkSigningKey - signing key of the associated Chainlink Oracle account

• bytes piggyAddress = 4

  piggyAddress - cosmos account address receivable for reward and fee distribution

• string feedId = 1

• string changeType = 2

  changeType: either add or remove

• bytes dataProviderAddr = 3

• bytes signer = 4

MsgFeed is the type defined for new feed

Used as request type in: Msg.AddFeedTx

Used as field type in: GetFeedByIdResponse

• string feedId = 1

  FeedId is the unique identifier of the feed

• bytes feedOwner = 2

  FeedOwner is the owner of the feed

• repeated DataProvider dataProviders = 3

  DataProviders is the init list of data provider of the feed

• uint32 submissionCount = 4

  The number of signatures required for a feedData submission to be valid

• uint32 heartbeatTrigger = 5

  The interval between which a new round should automatically be triggered. The given value in milliseconds will only be approximate within block intervals

• uint32 deviationThresholdTrigger = 6

  The fraction of deviation in the feed data required to trigger a new round. For example if the price of ATOM/USD changes by 1% then a new round should occur even if the heartbeat interval has not elapsed.

• bytes moduleOwnerAddress = 7

  Module owner who signs the add feed tx

• optional FeedRewardSchema feedReward = 8

  feedReward struct describing how rewards should be paid

• string desc = 9

  Feed description

MsgFeedData is the type defined for the data of the feed It could be an OCR report feed, or any general feed data in the future

Used as request type in: Msg.SubmitFeedDataTx

Used as field type in: OCRFeedDataInStore

• string feedId = 1

  FeedId is the unique identifier of the feed

• bytes submitter = 2

  Submitter is the leader of the current round who is calling the module to submit feed data

• repeated bytes observationFeedData = 3

  observationFeedData is the report for price feed, could be used for general feed data From proposal: The reports generated by Chainlink nodes off-chain using the OCR protocol are ABI encoded byte arrays which means each report contains a byte array which could be deserialized to OCRAbiEncoded type this is the original observation data array from each data provider

• repeated bytes observationFeedDataSignatures = 4

  observationFeedData is the list of the data provider observation data signature of the current round, signed by chainlink prikey. This is observation signatures

• bool isFeedDataValid = 5

  isFeedDataValid is the indicator whether feed data is valid against the external validation func, it's true by default

• repeated bytes cosmosPubKeys = 6

  cosmosPubKeys is the cosmos account pubKey slice of the data providers who signed this round

• optional Coin txFee = 7

  txFee is the tx fee of submitting feed data

• string feedId = 1

• bytes feedOwner = 2

• repeated DataProvider dataProviders = 3

  DataProviders is the init list of data provider of the feed

• bytes submitter = 4

• repeated bytes feedData = 5

• repeated bytes signatures = 6

  Signatures is the data provider signature list of the current round

• string feedId = 1

• bytes newFeedOwnerAddr = 2

• bytes signer = 3

• string feedId = 1

• string changeType = 2

  changeType: either DeviationThreshold, heartbeatTrigger, submissionCount

• uint32 newParameterValue = 3

• bytes signer = 4

• string feedId = 1

• string newStrategy = 2

• uint64 newBaseAmount = 3

• bytes signer = 4

Used as request type in: Msg.AddModuleOwnerTx

Used as field type in: GenesisState, GetModuleOwnerResponse

• bytes address = 1

  address defines the address of the module owner

• bytes pubKey = 2

  pubKey defined the public key of the module owner

• bytes assignerAddress = 3

  the module owner who assigned this new module owner

• bytes newModuleOwnerAddr = 1

• bytes signer = 4

• string feedId = 1

• repeated DataProvider dataProviders = 2

• bytes feedOwner = 3

• string feedId = 1

• uint64 roundId = 2

• repeated bytes feedData = 3

• string feedId = 1

• string feedId = 1

• bytes account = 2

  The account that was paid to

• uint64 value = 3

Used as response type in: Msg.AddAccountTx, Msg.AddDataProviderTx, Msg.AddFeedTx, Msg.AddModuleOwnerTx, Msg.EditAccountTx, Msg.FeedOwnershipTransferTx, Msg.ModuleOwnershipTransferTx, Msg.RemoveDataProviderTx, Msg.RequestNewRoundTx, Msg.SetDeviationThresholdTriggerTx, Msg.SetFeedRewardTx, Msg.SetHeartbeatTriggerTx, Msg.SetSubmissionCountTx, Msg.SubmitFeedDataTx

• uint64 height = 1

• string txHash = 2

this will be the implementation used later will use pseudo OCR ABI encoded data instead because the structure of how the OCR will be generalized is still unknown OCRAbiEncoded implments the OCR data that is ABCI encoded. The use and form will conform to the Chainlink protocol specification.

Used in: OCRFeedDataInStore, RoundData

• bytes Context = 1

  Context should be a 32-byte array struct.

• bytes Oracles = 2

  Oracles should be a 32-byte record of all participating oracles. Assuming this is data provider address?

• repeated Observation Observations = 3

  Observations should be an array on int192 containing the providers' independent observations.

OCRFeedDataInStore defines the type for OCR report that persists into the store

• optional MsgFeedData feedData = 1

• optional OCRAbiEncoded deserializedOCRReport = 2

• uint64 RoundId = 3

Used in: OCRAbiEncoded

• bytes data = 1

Used in: GetLatestRoundDataResponse, GetRoundDataResponse

• string feedId = 1

• optional OCRAbiEncoded feedData = 2