PoolzRanking 1.0.0

PoolzRanking

Overview

PoolzRanking is a .NET library for calculating a ranking system based on provided key-value pairs of addresses and amounts. The ranking system uses a top-down weighting system to distribute an allocation of funds based on user ranking.

Usage

To use PoolzRanking in your .NET project, simply install the package from NuGet:

Install-Package PoolzRanking -Version 1.0.0

You can then use the library by importing the PoolzRanking namespace and creating an instance of the RankingModel class:

using PoolzRanking;

var keyValuePairs = new Dictionary<string, decimal>
{
    { "Address1", 100m },
    { "Address2", 200m },
    { "Address3", 300m },
};

var totalAllocation = 1000m;
var top = 0.5m;
var bottom = 0.1m;

var rankingModel = new RankingModel(keyValuePairs, totalAllocation, top, bottom);
var results = rankingModel.GetResults();

Get the Results

To get the ranked results, call the GetResults method on the RankingModel instance:

var results = model.GetResults();

The results variable will contain a list of ResultItem instances, which have the following properties:

Address: The address of the item. Amount: The value of the item. Allocation: The allocation that the item should receive.

Create Random Winners

To create random winners from a list of sign-ups, create a list of SignUp instances, and pass it to the RandomWinners constructor:

var signUps = new List<SignUp>
{
    new SignUp { Address = "Alice", Amount = 10m },
    new SignUp { Address = "Bob", Amount = 20m },
    new SignUp { Address = "Charlie", Amount = 30m },
    new SignUp { Address = "David", Amount = 40m },
    new SignUp { Address = "Eve", Amount = 50m },
};

var min = 50m;
var take = 2;
var set = 100m;

var randomWinners = new RandomWinners(signUps, min, take, set);

The randomWinners.Results property will contain a list of ResultItem instances, which have the following properties:

Address: The address of the item. Amount: The value of the item. Allocation: The allocation that the item should receive.

License

This project is licensed under the MIT License - see the LICENSE file for details.