mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
Merge pull request #309 from oceanprotocol/feature/events-handler
document Events Handler
This commit is contained in:
commit
3518745bfe
@ -42,16 +42,31 @@ Aquarius supports several options for the off-chain database (OceanDB), includin
|
|||||||
<repo name="oceandb-elasticsearch-driver"></repo>
|
<repo name="oceandb-elasticsearch-driver"></repo>
|
||||||
<repo name="oceandb-mongodb-driver"></repo>
|
<repo name="oceandb-mongodb-driver"></repo>
|
||||||
|
|
||||||
Note: There is also a BigchainDB driver but it hasn't been maintained.
|
> There is also a [BigchainDB driver](https://github.com/oceanprotocol/oceandb-bigchaindb-driver) but it hasn't been maintained.
|
||||||
|
|
||||||
|
You can create your own OceanDB drivers by extending on the `oceandb-driver-interface`.
|
||||||
|
|
||||||
|
<repo name="oceandb-driver-interface"></repo>
|
||||||
|
|
||||||
## Brizo
|
## Brizo
|
||||||
|
|
||||||
Publishers run Brizo to manage interactions with marketplaces and consumers.
|
Publishers run Brizo to manage interactions with marketplaces and consumers.
|
||||||
It interacts with the publisher's cloud and/or on-premise infrastructure.
|
It interacts with the publisher's cloud and/or on-premise infrastructure.
|
||||||
|
|
||||||
The most basic scenario for a publisher is to provide access to the [assets](/concepts/terminology/#asset-or-data-asset) the publisher owns or manages, but [Brizo can do much more](/concepts/architecture/#brizo).
|
The most basic scenario for a publisher is to provide access to the [assets](/concepts/terminology/#asset-or-data-asset) the publisher owns or manages, but [Brizo can do much more](/concepts/architecture/#brizo).
|
||||||
|
|
||||||
<repo name="brizo"></repo>
|
<repo name="brizo"></repo>
|
||||||
|
|
||||||
|
### Events Handler
|
||||||
|
|
||||||
|
Brizo communicates with the Events Handler to deal with Keeper Contracts events.
|
||||||
|
|
||||||
|
The Events Handler monitors Service Execution Agreement (SEA) events and acts as a provider agent to grant access and release rewards for the publisher/provider. This is a critical part in the process of consuming data sets in the Ocean Protocol network.
|
||||||
|
|
||||||
|
Every provider in the network must run some sort of an events handler to be able to fulfill the access condition of an `Access` service in a Service Execution Agreement.
|
||||||
|
|
||||||
|
<repo name="events-handler"></repo>
|
||||||
|
|
||||||
### Osmosis Drivers
|
### Osmosis Drivers
|
||||||
|
|
||||||
Brizo supports several options for file storage, including Azure Storage, Amazon S3 and on-premise storage. One can add support for another file storage option by creating a new driver similar to one of the existing Osmosis drivers.
|
Brizo supports several options for file storage, including Azure Storage, Amazon S3 and on-premise storage. One can add support for another file storage option by creating a new driver similar to one of the existing Osmosis drivers.
|
||||||
@ -60,6 +75,10 @@ Brizo supports several options for file storage, including Azure Storage, Amazon
|
|||||||
<repo name="osmosis-aws-driver"></repo>
|
<repo name="osmosis-aws-driver"></repo>
|
||||||
<repo name="osmosis-on-premise-driver"></repo>
|
<repo name="osmosis-on-premise-driver"></repo>
|
||||||
|
|
||||||
|
You can create your own Osmosis drivers by extending on the `osmosis-driver-interface`.
|
||||||
|
|
||||||
|
<repo name="osmosis-driver-interface"></repo>
|
||||||
|
|
||||||
## Squid Libraries
|
## Squid Libraries
|
||||||
|
|
||||||
Client libraries used by applications (such as Pleuston or Jupyter notebooks) to interact with Ocean components, including Keepers, Aquarius nodes, Brizo nodes, etc.
|
Client libraries used by applications (such as Pleuston or Jupyter notebooks) to interact with Ocean components, including Keepers, Aquarius nodes, Brizo nodes, etc.
|
||||||
|
@ -8,7 +8,7 @@ description: Terminology specific to Ocean Protocol.
|
|||||||
Any EVM-compatible network where all[^1] the Ocean Protocol smart contracts ([keeper contracts](https://github.com/oceanprotocol/keeper-contracts)) are deployed. There can be many Ocean networks and you can use the Ocean Protocol in several EVM-compatible networks, including:
|
Any EVM-compatible network where all[^1] the Ocean Protocol smart contracts ([keeper contracts](https://github.com/oceanprotocol/keeper-contracts)) are deployed. There can be many Ocean networks and you can use the Ocean Protocol in several EVM-compatible networks, including:
|
||||||
|
|
||||||
- the Ethereum Mainnet (also called the Main Ethereum Network)
|
- the Ethereum Mainnet (also called the Main Ethereum Network)
|
||||||
- the Ocean [Pacific Network](/concepts/pacific-network/)
|
- the Ocean [Pacific Main Network](/concepts/pacific-network/)
|
||||||
- various Ocean [test networks](/concepts/testnets/)
|
- various Ocean [test networks](/concepts/testnets/)
|
||||||
|
|
||||||
## Asset or Data Asset
|
## Asset or Data Asset
|
||||||
@ -43,11 +43,13 @@ A person or a software service that checks some steps in transactions. For examp
|
|||||||
|
|
||||||
A contract-like agreement between a publisher, a consumer, and a verifier, specifying what assets are to be delivered (from publisher to consumer), the conditions that must be met, and the rewards for fulfilling the conditions.
|
A contract-like agreement between a publisher, a consumer, and a verifier, specifying what assets are to be delivered (from publisher to consumer), the conditions that must be met, and the rewards for fulfilling the conditions.
|
||||||
|
|
||||||
We published an [Ocean Protocol blog post that explains SEAs in more detail](https://blog.oceanprotocol.com/exploring-the-sea-service-execution-agreements-65f7523d85e2).
|
We published a blog post that explains SEAs in more detail:
|
||||||
|
|
||||||
|
- [Blog: Exploring the SEA: Service Execution Agreements](https://blog.oceanprotocol.com/exploring-the-sea-service-execution-agreements-65f7523d85e2)
|
||||||
|
|
||||||
## More Terminology
|
## More Terminology
|
||||||
|
|
||||||
- See [the page about Ocean's Software Components](/concepts/components/).
|
- See the page about Ocean's [Software Components](/concepts/components/).
|
||||||
- See [the page about wallets (and other Ethereum terminology)](/concepts/wallets/).
|
- See the page about [wallets (and other Ethereum terminology)](/concepts/wallets/).
|
||||||
|
|
||||||
[^1]: The _Dispenser_ smart contract should only be deployed to testnets.
|
[^1]: The _Dispenser_ smart contract should only be deployed to testnets.
|
||||||
|
@ -14,7 +14,7 @@
|
|||||||
links:
|
links:
|
||||||
- name: API reference
|
- name: API reference
|
||||||
url: /references/brizo/
|
url: /references/brizo/
|
||||||
|
- name: events-handler
|
||||||
- name: pleuston
|
- name: pleuston
|
||||||
- name: commons
|
- name: commons
|
||||||
|
|
||||||
|
2
external/dev-ocean
vendored
2
external/dev-ocean
vendored
@ -1 +1 @@
|
|||||||
Subproject commit 3865e1905c1309970359adb5e984fa7e0e49b5cb
|
Subproject commit ba2c2994b238efdb30e89a5a769557862187a679
|
Loading…
Reference in New Issue
Block a user