Skip to content

Commit

Permalink
Rename Chain Reader to Contract Reader (#759)
Browse files Browse the repository at this point in the history
Co-authored-by: Jordan Krage <[email protected]>
  • Loading branch information
ilija42 and jmank88 authored Sep 10, 2024
1 parent 33f9178 commit ed9f50d
Show file tree
Hide file tree
Showing 42 changed files with 951 additions and 953 deletions.
4 changes: 2 additions & 2 deletions pkg/loop/adapters/relay/relay_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ func (s staticMedianProvider) ReportCodec() median.ReportCodec {
return nil
}

// ChainReader implements types.MedianProvider.
func (s staticMedianProvider) ChainReader() types.ContractReader {
// ContractReader implements types.MedianProvider.
func (s staticMedianProvider) ContractReader() types.ContractReader {
return nil
}

Expand Down
4 changes: 2 additions & 2 deletions pkg/loop/internal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ for details ensuring backward compatibility of protobufs.

### Relayer abstraction Development

There are three kinds of abstractions with the relayer: common components, such as the `chainreader`, ocr-specific shared components, such as `offchain digester` and the ocr-specific, product-specific components, known as `Providers`. Note that the line between the latter two categories is blurry, ocr-specific shared component should be thought as component that have a well defined and reasonable default value; custom `Providers` clearly fall outside this domain, yet custom `Providers` may also implement OCR components that have a default implementation.
There are three kinds of abstractions with the relayer: common components, such as the `contractreader`, ocr-specific shared components, such as `offchain digester` and the ocr-specific, product-specific components, known as `Providers`. Note that the line between the latter two categories is blurry, ocr-specific shared component should be thought as component that have a well defined and reasonable default value; custom `Providers` clearly fall outside this domain, yet custom `Providers` may also implement OCR components that have a default implementation.

Go to [Production abstraction Development] for more information about custom `Provider` development.

Developing common relayer components such as `chainreader` follows the same pattern as [Core node abstraction Development]. The primary difference is the package location. Instead of adding code to `chainlink-common/pkg/loop/internal/core/services` you will work in `chainlink-common/pkg/loop/internal/relayer` or `chainlink-common/pkg/loop/internal/relayer/pluginprovider` depending on the scope of your changes.
Developing common relayer components such as `contractreader` follows the same pattern as [Core node abstraction Development]. The primary difference is the package location. Instead of adding code to `chainlink-common/pkg/loop/internal/core/services` you will work in `chainlink-common/pkg/loop/internal/relayer` or `chainlink-common/pkg/loop/internal/relayer/pluginprovider` depending on the scope of your changes.

### Product abstraction Development

Expand Down
258 changes: 0 additions & 258 deletions pkg/loop/internal/pb/chain_reader_grpc.pb.go

This file was deleted.

Loading

0 comments on commit ed9f50d

Please sign in to comment.