sorare-rewards 1.0.0.beta8 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a0830eade606c23536297db4a6ce44271d419163722adebe70f2a2a6f5edf1c
-  data.tar.gz: 5cf895682f14241b6c6a4d242a3d152927b099f171f49117cbf6ebc71d60c420
+  metadata.gz: dd12e11f5b4eb146655a6944d6ffd4b541a3cfe926e38b5bb77e7235d4cc92fd
+  data.tar.gz: 12acbcb47c3d6f366855278b96d75ab787414f802cbbfe9c597f98a96867c8ae
 SHA512:
-  metadata.gz: 8a52f0aaca38e0cf7b17438caeecbe150b4d843e3355fdfb2cd2840ee2046a2de44ad17e0e066b066eaaa01faf8f77b6961ae1f2a1fabe52d8df5a2a8249ada4
-  data.tar.gz: 365cd2a82541403d1f4ee0b2ad4cf515abe6e0bcd6a9b20ff3a8e2143ac1583198a90b5f17c85f6991f1a8b821dfe3e0035047a97fe1f69bc742282fbd12bf11
+  metadata.gz: 858689cacfc5e20404a485c5500266c613c47ec4838fbf909b7975594a6e1eb59cc96d0e3fa14cdc3cfdf4cea2b0f1ad9cd01adc215d02c0369d3ef02a3a7351
+  data.tar.gz: ba9f2aa66b4332ba1611f38a9b7fad80582bc1d03f67530bb356d203d4a71f9405ac353461ea4f6383775a03145adb923ade0762b9f1d89041299f7aa2b27e74

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sorare-rewards (1.0.0.beta8)
+    sorare-rewards (1.1.0)
       activesupport (~> 6.1)
       interactor (~> 3.0)
       json (~> 2)
@@ -23,12 +23,15 @@ GEM
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     interactor (3.1.2)
+    io-wait (0.1.0)
     json (2.5.1)
     minitest (5.14.4)
     net-http (0.1.1)
       net-protocol
       uri
-    net-protocol (0.1.0)
+    net-protocol (0.1.1)
+      io-wait
+      timeout
     ostruct (0.2.0)
     parallel (1.20.1)
     parser (3.0.1.0)
@@ -67,6 +70,7 @@ GEM
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
+    timeout (0.1.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)

data/README.md

@@ -1,9 +1,5 @@
 # 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:
@@ -22,13 +18,31 @@ Or install it yourself as:
 
 ## Usage
 
-To compute the rewards distribution for a given Game Week :
+
+First you need to load a game week
 
 ```ruby
-Sorare::Rewards::build_rewards(slug)
+game_week = Sorare::Rewards::GameWeek.new(hash: 'QmbwCo1fuhRN1T2DyEQtETefsBH6yCj8h7VjMW5iGfT11Z', salt: 'dce0053984405687efcdf3d1a61ffa67')
 ```
 
-With `slug` being the Fixture slug.
+Game Week's `hash` and `salt` can be retrieved using the GQL API, the salt is made public after the rewards have been distributed.
+
+
+To compute the number of rewards for the game week :
+
+```ruby
+# Card rewards :
+game_week.card_allocations
+
+# Eth rewards :
+game_week.prize_pools
+```
+
+To get the cards rewarded for a GameWeek :
+
+```ruby
+game_week.cards_picked
+```
 
 ## Development
 

data/lib/sorare/rewards/allocation_configuration.yml

@@ -1,64 +1,96 @@
+limited: &limited
+  tier_0:
+    - pct: 0
+    - pct: 0
+    - pct: 0
+    - pct: 0
+    - pct: 0.33
+  tier_1:
+    - pct: 0
+    - pct: 0
+    - pct: 0
+    - pct: 0
+    - pct: 0.33
+  tier_2:
+    - pct: 0
+    - pct: 0
+    - pct: 0
+    - pct: 0
+    - pct: 0.8
+  tier_3:
+    - pct: 0
+    - pct: 0
+    - pct: 0
+    - pct: 0
+    - pct: 1
+
 rare: &rare
   tier_0:
-    - loop: 0
-    - loop: 0
-    - loop: 2
-    - loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 2
+    - cards_per_loop: 1
   tier_1:
-    - loop: 0
-    - loop: 0
-    - loop: 2
-    - loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 2
+    - cards_per_loop: 1
   tier_2:
-    - loop: 0
-    - loop: 0
-    - loop: 1
-    - loop: 4
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 1
+    - cards_per_loop: 4
   tier_3:
-    - loop: 0
-    - loop: 0
-    - loop: 0
-    - loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 1
 
 super_rare: &super_rare
   tier_0:
-    - loop: 2
-    - loop: 1
-    - loop: 0
-    - loop: 0
+    - cards_per_loop: 2
+    - cards_per_loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
   tier_1:
-    - loop: 1
-    - loop: 1
-    - loop: 0
-    - loop: 0
+    - cards_per_loop: 1
+    - cards_per_loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
   tier_2:
-    - loop: 0
-    - loop: 1
-    - loop: 0
-    - loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
   tier_3:
-    - loop: 0
-    - loop: 1
-    - loop: 0
-    - loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
 
 leagues:
   global-all_star:
+    limited: *limited
     rare: *rare
     super_rare: *super_rare
   global-under_twenty_one:
+    limited: *limited
     rare: *rare
     super_rare: *super_rare
   champion-europe:
+    limited: *limited
     rare: *rare
     super_rare: *super_rare
   challenger-europe:
+    limited: *limited
     rare: *rare
     super_rare: *super_rare
   champion-asia:
+    limited: *limited
     rare: *rare
     super_rare: *super_rare
   champion-america:
+    limited: *limited
     rare: *rare
     super_rare: *super_rare
   special-weekly:

data/lib/sorare/rewards/game_week.rb

@@ -2,17 +2,20 @@
 
 require 'json'
 require 'net/http'
+require 'active_support/core_ext/module/delegation'
 
 module Sorare
   module Rewards
     # GameWeek stores the reward data of a game week
     class GameWeek
-      attr_reader :data, :config, :salt
+      attr_reader :salt
+
+      delegate :card_allocations, :prize_pools, to: :reward_allocations
+      delegate :cards_picked, to: :card_rewards
 
       def initialize(data: nil, hash: nil, salt: nil)
-        uri = URI("#{Sorare::Rewards.configuration.gateway}#{hash}")
-        @data = data || JSON.parse(::Net::HTTP.get(uri))
-        @config = GameWeekConfig.new(@data['config'])
+        @uri = URI("#{Sorare::Rewards.configuration.gateway}#{hash}")
+        @data = data
         @salt = salt
       end
 
@@ -22,6 +25,14 @@ module Sorare
         end
       end
 
+      def data
+        @data ||= JSON.parse(::Net::HTTP.get(@uri))
+      end
+
+      def config
+        @config ||= GameWeekConfig.new(@data['config'])
+      end
+
       def supply_for(league, rarity: nil, player: nil)
         return (supply.dig(league, rarity, player) || 0) if rarity && player
         return (supply.dig(league, rarity) || {}) if rarity
@@ -37,14 +48,14 @@ module Sorare
         end
       end
 
-      def rewards
+      def reward_allocations
         raise 'Salt required' unless salt
 
-        @rewards ||= Sorare::Rewards::Build.call!(game_week: self, salt: salt)
+        @reward_allocations ||= Sorare::Rewards::Build.call!(game_week: self, salt: salt)
       end
 
       def card_rewards
-        @card_rewards ||= Sorare::Rewards::Pick.call!(rewards.to_h)
+        @card_rewards ||= Sorare::Rewards::Pick.call!(reward_allocations.to_h)
       end
 
       def league(name)

data/lib/sorare/rewards/game_week_config.rb

@@ -12,7 +12,7 @@ module Sorare
         @config = config
       end
 
-      %w[cooldown limits prize_pool_currency].each do |key|
+      %w[cooldown limits prize_pool_currency rewards_ratio_per_cards_in_circulation].each do |key|
         define_method(key) do
           config[key]
         end

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

@@ -29,7 +29,7 @@ module Sorare
           allocate_cards
           allocate_pct if has?('pct')
           allocate_extra if has?('pct')
-          allocate_loop if has?('loop')
+          allocate_loop if has?('cards_per_loop')
         end
 
         def allocate_divisions(&block)
@@ -55,7 +55,7 @@ module Sorare
         def allocate_loop
           while remaining_supply.positive?
             allocate_divisions do |division_config, division|
-              allocated[division] += [division_config['loop'] || 0, remaining_supply].min
+              allocated[division] += [division_config['cards_per_loop'] || 0, remaining_supply].min
             end
           end
         end
@@ -85,7 +85,7 @@ module Sorare
         end
 
         def check_config!
-          return if config && [0, 1].include?(config.sum { |q| q['pct'] || 0 })
+          return if config
 
           context.fail!(error: 'Invalid config')
         end

data/lib/sorare/rewards/interactors/cards/pick_for_division.rb

@@ -25,13 +25,13 @@ module Sorare
         delegate :league, :allocations, :pickers, :qualified_players, to: :context
 
         def call
-          context.division_picks = allocations.keys.index_with do |rarity|
+          context.cards_picked = allocations.keys.index_with do |rarity|
             PickForDivisionAndRarity.call!(
               **context.to_h,
               rarity: rarity,
               pickers: pickers[rarity],
               allocations: allocations[rarity]
-            ).rarity_picks
+            ).cards_picked
           end
         end
       end

data/lib/sorare/rewards/interactors/cards/pick_for_division_and_rarity.rb

@@ -20,7 +20,7 @@ module Sorare
         delegate :league, :rarity, :allocations, :pickers, to: :context
 
         def call
-          context.rarity_picks = supply!
+          context.cards_picked = supply!
         end
 
         def supply!
@@ -28,7 +28,7 @@ module Sorare
             next [] if pickers&.dig(tier).nil?
 
             PickForDivisionRarityAndQuality.call!(**context.to_h, allocations: allocations[tier],
-                                                                  picker: pickers[tier]).picks
+                                                                  picker: pickers[tier]).cards_picked
           end
         end
       end

data/lib/sorare/rewards/interactors/cards/pick_for_division_rarity_and_quality.rb

@@ -15,11 +15,11 @@ module Sorare
 
         MISSING_CARDS = 'There are not enough cards to fulfill the requirements'
 
-        delegate :picker, :allocations, :league, :rarity, :force, :picks, to: :context
+        delegate :picker, :allocations, :league, :rarity, :force, :cards_picked, to: :context
         delegate :game_week, to: :league
 
         def call
-          context.picks = []
+          context.cards_picked = []
 
           pick!
           check_length! unless force
@@ -27,24 +27,24 @@ module Sorare
         end
 
         def pick!
-          pick_if_available! while picks.length != allocations && picker.length.positive?
+          pick_if_available! while cards_picked.length != allocations && picker.length.positive?
         end
 
         def pick_if_available!
           player = picker.pick
-          return if picker.player_counter[player] > game_week.player(player).supply(league, rarity).ceil
+          return if picker.player_counter[player] > game_week.player(player).pickable_supply(league, rarity)
 
-          picks.push(player)
+          cards_picked.push(player)
         end
 
         def reorder!
-          picks.sort! do |a, b|
+          cards_picked.sort! do |a, b|
             game_week.player(a).rank(league, rarity) <=> game_week.player(b).rank(league, rarity)
           end
         end
 
         def check_length!
-          return if picks.length == allocations
+          return if cards_picked.length == allocations
 
           context.fail!(error: MISSING_CARDS)
         end

data/lib/sorare/rewards/interactors/cards/pick_for_game_week.rb

@@ -22,14 +22,14 @@ module Sorare
         delegate :game_week, :allocations, :salt, :picks, to: :context
 
         def call
-          context.picks = picks
+          context.cards_picked = pick!
         end
 
-        def picks
+        def pick!
           allocations.each_league_allocations.each_with_object({}) do |(league_name, league_allocations), picks|
             picks[league_name] = PickForLeague.call!(
               **context.to_h, league: game_week.league(league_name), allocations: league_allocations
-            ).league_picks
+            ).cards_picked
           end
         end
       end

data/lib/sorare/rewards/interactors/cards/pick_for_league.rb

@@ -24,10 +24,10 @@ module Sorare
           context.pickers = {}
           add_pickers!
 
-          context.league_picks = allocations.keys.index_with do |division|
+          context.cards_picked = allocations.keys.index_with do |division|
             PickForDivision.call!(
               **context.to_h, pickers: pickers, allocations: allocations[division]
-            ).division_picks
+            ).cards_picked
           end
         end
 

data/lib/sorare/rewards/interactors/pick.rb

@@ -24,11 +24,11 @@ module Sorare
       # Depending on the way the allocations interpreter is implemented it could be done by him or we
       # update the allocations process to match the structure
       def call
-        context.picks = Sorare::Rewards::Cards::PickForGameWeek.call!(
+        context.cards_picked = Sorare::Rewards::Cards::PickForGameWeek.call!(
           **context.to_h,
           salt: salt,
           allocations: transposed_allocations
-        ).picks
+        ).cards_picked
       end
 
       def transposed_allocations

data/lib/sorare/rewards/interactors/prize_pools/compute_for_division.rb

@@ -13,7 +13,7 @@ module Sorare
 
         def call
           context.division_prize_pools = available_prize_pools.map do |available_prize_pool|
-            available_prize_pool * percentage_rewarded
+            (available_prize_pool * percentage_rewarded).round(2)
           end
         end
 

data/lib/sorare/rewards/interactors/supply/compute_for_rarity.rb

@@ -16,16 +16,14 @@ module Sorare
         def call
           context.rarity_supply = []
 
-          context.rewardable = compute_rewardable_supply!
+          context.rewardable = rewardable_supply
           distribute_in_tiers!
         end
 
-        def compute_rewardable_supply!
-          total_supply = supply.keys.sum do |player|
-            player_supply(player)
-          end
+        def rewardable_supply
+          total_float_supply = supply.keys.sum { |player| player_supply(player) }
 
-          rounded_supply(total_supply)
+          round_and_cap_supply(total_float_supply)
         end
 
         def distribute_in_tiers!
@@ -43,12 +41,15 @@ module Sorare
           end
         end
 
-        def player_supply(slug)
-          game_week.player(slug).supply(league, rarity)
+        def round_and_cap_supply(float_supply)
+          [
+            float_supply.floor + remaining_supply(float_supply.modulo(1)), # Supply limit
+            league.cards_in_circulation_limit(rarity) # Circulation limit
+          ].compact.min
         end
 
-        def rounded_supply(float_supply)
-          float_supply.floor + remaining_supply(float_supply.modulo(1))
+        def player_supply(slug)
+          game_week.player(slug).reward_pool_supply_contribution(league, rarity)
         end
 
         def remaining_supply(reward_probability)

data/lib/sorare/rewards/league.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'time'
+require 'active_support/core_ext/module/delegation'
 
 module Sorare
   module Rewards
@@ -17,12 +17,18 @@ module Sorare
         @game_week = game_week
       end
 
-      %w[playing_rate prize_pools].each do |key|
+      %w[playing_rate prize_pools cards_in_circulation].each do |key|
         define_method(key) do
           config[key]
         end
       end
 
+      def cards_in_circulation_limit(rarity)
+        return unless cards_in_circulation&.dig(rarity) && game_week.config.rewards_ratio_per_cards_in_circulation
+
+        (cards_in_circulation[rarity] * game_week.config.rewards_ratio_per_cards_in_circulation).floor
+      end
+
       def each_division_prize_pools
         prize_pools.each_with_index do |prize_pool, index|
           return to_enum(:each_division_prize_pools) unless block_given?

data/lib/sorare/rewards/picker.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'net/http'
+require 'active_support/core_ext/module/delegation'
 
 module Sorare
   module Rewards

data/lib/sorare/rewards/player.rb

@@ -25,11 +25,18 @@ module Sorare
         @game_data.present?
       end
 
-      def supply(league, rarity)
+      def reward_pool_supply_contribution(league, rarity)
         return 0 unless playing? && remaining_games_for_supply.positive?
 
         [
-          uncapped_supply_for_game_week(league, rarity), # Remaining supply
+          uncapped_supply_for_game_week(league, rarity),
+          pickable_supply(league, rarity)
+        ].min
+      end
+
+      def pickable_supply(league, rarity)
+        [
+          overall_supply(league, rarity), # Remaining supply
           available_during_cooldown(league, rarity), # Cooldown limit
           @config.distribution_limit(rarity) # Hard limit
         ].min
@@ -52,10 +59,12 @@ module Sorare
       end
 
       def rewarded_during_cooldown(league, rarity)
-        (rewards&.dig(league) || []).count { |at| (Time.parse(at) + @config.cooldown_since(rarity)) < Time.now }
+        (@game_data&.dig(league.name, rarity) || []).count do |at|
+          (Time.parse(at) + @config.cooldown_since(rarity)) > Time.now
+        end
       end
 
-      %w[rewards remaining_games_for_supply remaining_games].each do |key|
+      %w[remaining_games_for_supply remaining_games].each do |key|
         define_method(key) do
           @game_data&.dig(key)
         end

data/lib/sorare/rewards/version.rb

@@ -2,6 +2,6 @@
 
 module Sorare
   module Rewards
-    VERSION = '1.0.0.beta8'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorare-rewards
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta8
+  version: 1.1.0
 platform: ruby
 authors:
 - pierre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,9 +220,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: