README.md

# BazVenueAdapters
[![Build Status](https://github.com/atlas-xyz/baz-venue-adapters/workflows/test/badge.svg?branch=main)](https://github.com/atlas-xyz/baz-venue-adapters/actions?query=workflow%3Atest)
[![hex.pm version](https://img.shields.io/hexpm/v/baz-venue-adapters.svg?style=flat)](https://hex.pm/packages/baz-venue-adapters)

All venue adapters officially supported by [`baz`](https://github.com/atlas-xyz/baz)

## Venues

| Venue      | Repository                                                |
| ---------- | --------------------------------------------------------- |
| OpenSea    | https://github.com/atlas-xyz/baz-venue-adapter-open-sea   |
| LooksRare  | https://github.com/atlas-xyz/baz-venue-adapter-looks-rare |
| X2Y2       | https://github.com/atlas-xyz/baz-venue-adapter-x2y2       |
| Magic Eden | https://github.com/atlas-xyz/baz-venue-adapter-magic-eden |
| Hyperspace | https://github.com/atlas-xyz/baz-venue-adapter-hyperspace |

## Installation

Add the `baz_venue_adapters` package to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:baz_venue_adapters, "~> 0.0.1"}
  ]
end
```

## Usage

```elixir
config :baz,
  venues: %{
    "open_sea" => %{
      adapter: BazVenueAdapterOpenSea,
      collections: "*",
      start_on_boot: false,
      poll_stream_enabled: true,
      websocket_stream_enabled: false,
      credentials: %{
        api_key: System.get_env("OPEN_SEA_API_KEY")
      }
    },
    "looks_rare" => %{
      adapter: BazVenueAdapterLooksRare,
      collections: "*",
      start_on_boot: false,
      poll_stream_enabled: true,
      websocket_stream_enabled: false,
      credentials: %{}
    },
    "x2y2" => %{
      adapter: BazVenueAdapterX2Y2,
      collections: "*",
      start_on_boot: false,
      poll_stream_enabled: true,
      websocket_stream_enabled: false,
      credentials: %{}
    },
    "magic_eden" => %{
      adapter: BazVenueAdapterMagicEden,
      collections: "*",
      start_on_boot: false,
      poll_stream_enabled: true,
      websocket_stream_enabled: false,
      credentials: %{}
    },
    "hyperspace" => %{
      adapter: BazVenueAdapterHyperspace,
      collections: "*",
      start_on_boot: false,
      poll_stream_enabled: true,
      websocket_stream_enabled: false,
      credentials: %{}
    }
  }
```

## Authors

- Alex Kwiatkowski - alex@atlas.xyz