osrs-226-model/net.rsprot.protocol.loginprot.incoming.pow.challenges.sha256

Package-level declarations

Types

class DefaultSha256ChallengeGenerator : ChallengeGenerator<Sha256MetaData, Sha256Challenge>

The default SHA-256 challenge generator is used to generate challenges which align up with what OldSchool RuneScape is generating, which is a combination of epoch time millis, the world id and a 495-byte BigInteger that is turned into a hexadecimal string, which will have a length of 1004 or 1005 characters, depending on if the BigInteger was negative.

DefaultSha256MetaDataProvider

class DefaultSha256MetaDataProvider(world: Int) : ChallengeMetaDataProvider<Sha256MetaData>

The default SHA-256 metadata provider will return a metadata object that matches what OldSchool RuneScape sends.

DefaultSha256ProofOfWorkProvider

class DefaultSha256ProofOfWorkProvider : ProofOfWorkProvider<Sha256Challenge, Sha256MetaData>

A class to wrap the properties of a SHA-256 into a single instance.

Sha256Challenge

class Sha256Challenge(val version: Int, val difficulty: Int, val salt: String) : ChallengeType<Sha256MetaData>

A SHA-256 challenge is a challenge which forces the client to find a hash which has at least difficulty number of leading zero bits in the hash. As hashing returns pseudo-random results, as a general rule of thumb, the work needed to solve a challenge doubles with each difficulty increase, since each bit can be either true or false, and the solution must have at least difficulty amount of false (zero) bits. Since the requirement is that there are at least difficulty amount of leading zero bits, these challenges aren't constrained to only having a single successful answer.

Sha256ChallengeVerifier

class Sha256ChallengeVerifier(hashFunction: Sha256HashFunction = DefaultSha256MessageDigestHashFunction) : ChallengeVerifier<Sha256Challenge>

The SHA-256 challenge verifier is a replica of the client's implementation of the SHA-256 proof of work verifier.

Sha256MetaData

class Sha256MetaData @JvmOverloads constructor(val world: Int, val difficulty: Int = 18, val epochTimeMillis: Long = System.currentTimeMillis(), val version: Int = 1) : ChallengeMetaData

The SHA-256 metadata is what the default SHA-256 implementation requires in order to construct new challenges.