sorare-rewards 0.1.0.beta11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77c0cb011e78b240a5708daaef48b59be3bd6919c44fc0a84515314c77e2ee10
+  data.tar.gz: d248dd322adda855d1668f9b6cc3424d98c0c0a33dc95f5d7caf2b9b457b3fd7
+SHA512:
+  metadata.gz: 921aa2e26ae7271027c6c91887e6a8a4bf975f4084bfce759871ca1a25192e8420c8aa25a5a9ed1e3854d4ec99d756fd267f7b66ee8c3bf5f36c0f7c3f33f49e
+  data.tar.gz: fc32cd8862c4de110f9a6d2f101755230a5aaa9c1b0c89bfbbba48b4d8ce5b9ab1d0a09afb2772d3db9f026d1879bee37c6c5ddd11faebb47e4385242a9baf97

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,43 @@
+image: ruby:2.7.1
+
+workflow:
+  rules:
+    - if: $CI_MERGE_REQUEST_ID
+      when: never
+    - when: always
+
+stages:
+  - test
+
+cache:
+  key: sorare-rewards-v1
+  paths:
+    - vendor/ruby
+
+variables:
+  BUNDLE_BIN: vendor/bin
+
+before_script:
+  - export PATH="$BUNDLE_BIN:$PATH"
+  - bundle config set path 'vendor'
+  - bundle install --jobs $(nproc)
+
+rspec:
+  stage: test
+  cache:
+    # it is useless to have both rspec and lint update the cache
+    policy: pull
+    key: sorare-rewards-v1
+    paths:
+      - vendor/ruby
+  script:
+    - rspec
+  except:
+    - master
+
+lint:
+  stage: test
+  script:
+    - rubocop --extra-details --display-style-guide
+  except:
+    - master

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,87 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7.1
+  Exclude:
+    - "bin/*"
+    - "vendor/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "Rakefile"
+    - "**/*.rake"
+    - "spec/**/*.rb"
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 12
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/NonNilCheck:
+  Enabled: true
+  IncludeSemanticChanges: true
+
+Naming/VariableNumber:
+  Enabled: false
+
+RSpec/ImplicitSubject:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/FilePath:
+  SpecSuffixOnly: true
+
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - within
+    - without
+    - if
+    - unless
+    - for
+    - by
+    - in
+    - that
+    - who
+    - from
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Exclude:
+    - "*.gemspec"

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sorare-rewards.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    sorare-rewards (0.1.0.beta11)
+      activesupport (~> 6.1)
+      interactor (~> 3.0)
+      json (~> 2)
+      net-http (~> 0.1.1)
+      yaml (~> 0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    interactor (3.1.2)
+    json (2.5.1)
+    minitest (5.14.4)
+    net-http (0.1.1)
+      net-protocol
+      uri
+    net-protocol (0.1.0)
+    ostruct (0.2.0)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    uri (0.10.1)
+    yaml (0.1.1)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ostruct (~> 0.2.0)
+  rake (~> 12.0)
+  rspec (~> 3.10)
+  rubocop (~> 1.12.1)
+  rubocop-rake (~> 0.5.1)
+  rubocop-rspec (~> 2.2.0)
+  sorare-rewards!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 pierre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# Sorare::Rewards
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sorare/rewards`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sorare-rewards'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sorare-rewards
+
+## Usage
+
+To compute the rewards distribution for a given Game Week :
+
+```ruby
+Sorare::Rewards::build_rewards(slug)
+```
+
+With `slug` being the Fixture slug.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sorare/rewards"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sorare/rewards/allocation_configuration.yml

@@ -0,0 +1,165 @@
+rare: &rare
+  tier_0:
+    - loop: 0
+    - loop: 0
+    - loop: 2
+    - loop: 1
+  tier_1:
+    - loop: 0
+    - loop: 0
+    - loop: 2
+    - loop: 1
+  tier_2:
+    - loop: 0
+    - loop: 0
+    - loop: 0
+    - loop: 1
+  tier_3:
+    - loop: 0
+    - loop: 0
+    - loop: 0
+    - loop: 1
+
+super_rare: &super_rare
+  tier_0:
+    - loop: 2
+    - loop: 1
+    - loop: 0
+    - loop: 0
+  tier_1:
+    - loop: 1
+    - loop: 1
+    - loop: 0
+    - loop: 0
+  tier_2:
+    - loop: 0
+    - loop: 1
+    - loop: 0
+    - loop: 0
+  tier_3:
+    - loop: 0
+    - loop: 1
+    - loop: 0
+    - loop: 0
+
+unique: &unique
+  tier_0:
+    - cards: 0
+    - cards: 0
+    - cards: 0
+    - cards: 0
+  tier_1:
+    - cards: 0
+    - cards: 0
+    - cards: 0
+    - cards: 0
+  tier_2:
+    - cards: 0
+    - cards: 0
+    - cards: 0
+    - cards: 0
+  tier_3:
+    - cards: 0
+    - cards: 0
+    - cards: 0
+    - cards: 0
+
+empty: &empty
+  tier_0:
+    - cards: 0
+    - cards: 0
+    - cards: 0
+    - cards: 0
+  tier_1:
+    - cards: 0
+    - cards: 0
+    - cards: 0
+    - cards: 0
+  tier_2:
+    - cards: 0
+    - cards: 0
+    - cards: 0
+    - cards: 0
+  tier_3:
+    - cards: 0
+    - cards: 0
+    - cards: 0
+    - cards: 0
+
+leagues:
+  global-all_star:
+    rare: *rare
+    super_rare: *super_rare
+    unique: *unique
+  global-under_twenty_one:
+    rare: *rare
+    super_rare: *super_rare
+    unique: *unique
+  champion-europe:
+    rare: *rare
+    super_rare: *super_rare
+    unique: *unique
+  challenger-europe:
+    rare: *rare
+    super_rare: *super_rare
+    unique: *unique
+  champion-asia:
+    rare: *rare
+    super_rare: *super_rare
+    unique: *unique
+  champion-america:
+    rare: *rare
+    super_rare: *super_rare
+    unique: *unique
+  special-weekly:
+    rare:
+      tier_0:
+        - pct: 1
+      tier_1:
+        - pct: 1
+      tier_2:
+        - pct: 1
+      tier_3:
+        - pct: 1
+    super_rare:
+      tier_0:
+        - pct: 1
+      tier_1:
+        - pct: 1
+      tier_2:
+        - pct: 1
+      tier_3:
+        - pct: 1
+    unique: *empty
+  starter-rookie:
+    unique:
+      tier_0:
+        - cards: 0
+      tier_1:
+        - cards: 0
+      tier_2:
+        - cards: 0
+      tier_3:
+        - cards: 0
+    super_rare:
+      tier_0:
+        - cards: 0
+      tier_1:
+        - cards: 0
+      tier_2:
+        - cards: 0
+      tier_3:
+        - cards: 0
+    rare:
+      tier_0:
+        - cards: 0
+      tier_1:
+        - cards: 1
+      tier_2:
+        - cards: 2
+      tier_3:
+        - cards: 0
+  global-unique_only:
+    rare: *empty
+    super_rare: *empty
+    unique: *empty

data/lib/sorare/rewards/configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Sorare
+  module Rewards
+    # Configuration stores the runtime configuration
+    class Configuration
+      attr_accessor :tiers, :gateway, :transform_tier, :transform_division, :allocation_configuration
+
+      def initialize
+        @tiers = 4
+        @gateway = 'https://gateway.pinata.cloud/ipfs/'
+        @transform_tier = ->(tier) { "tier_#{tier}" }
+        @transform_division = ->(division) { "D#{division}" }
+        @allocation_configuration = load_configuration
+      end
+
+      def load_configuration
+        YAML.safe_load(File.read("#{File.dirname(__FILE__)}/allocation_configuration.yml"), [], [], true)
+            .with_indifferent_access['leagues']
+      end
+    end
+  end
+end

data/lib/sorare/rewards/interactors/allocations/compute_for_game_week.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/enumerable'
+require 'interactor'
+
+module Sorare
+  module Rewards
+    module Allocations
+      # ComputeForGameWeek computes the reward allocations for a game week given a supply and seed
+      class ComputeForGameWeek
+        include Interactor
+
+        delegate :supply, :randomizer, :public_seed, :salt, to: :context
+
+        def call
+          context.randomizer = Sorare::Rewards::Random.new(public_seed, salt)
+          context.game_week_allocations = allocations
+        end
+
+        def allocations
+          supply.keys.index_with do |league|
+            Allocations::ComputeForLeague.call!(
+              **context.to_h, supply: supply[league], config: config[league]
+            ).league_allocations
+          end
+        end
+
+        def config
+          Sorare::Rewards.configuration.allocation_configuration
+        end
+      end
+    end
+  end
+end

data/lib/sorare/rewards/interactors/allocations/compute_for_league.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/enumerable'
+require 'interactor'
+
+module Sorare
+  module Rewards
+    module Allocations
+      # ComputeForLeague computes the reward allocations for a league given a supply and configuration
+      class ComputeForLeague
+        include Interactor
+
+        delegate :supply, :config, to: :context
+
+        def call
+          context.league_allocations = allocate_and_format!
+        end
+
+        def allocate_and_format!
+          allocations = allocate!
+
+          allocations.keys.index_with do |rarity|
+            allocations[rarity].first.keys.index_with do |division|
+              allocations[rarity].each_with_index.map do |qualified_allocations, tier|
+                [Sorare::Rewards.configuration.transform_tier.call(tier), qualified_allocations[division]]
+              end.to_h
+            end
+          end
+        end
+
+        def allocate!
+          supply.keys.index_with do |rarity|
+            ComputeForRarity.call!(**context.to_h, supply: supply[rarity], config: config[rarity]).rarity_allocations
+          end
+        end
+      end
+    end
+  end
+end