Stratum mining protocol - Revision history

Luke-jr: Use archive link since Braiins killed the doc

2024-05-29T16:30:06Z

Use archive link since Braiins killed the doc

← Older revision		Revision as of 16:30, 29 May 2024
Line 1:		Line 1:
	The [[stratum]] overlay protocol was extended to support pooled mining as a replacement for obsolete [[Getwork\|getwork]] protocol in late 2012.		The [[stratum]] overlay protocol was extended to support pooled mining as a replacement for obsolete [[Getwork\|getwork]] protocol in late 2012.
	The mining service specification was initially announced via [[Slush's pool]]'s website<ref>[http://mining.bitcoin.cz/stratum-mining/ Stratum mining protocol specification at slush's pool's website]</ref>.		The mining service specification was initially announced via [[Slush's pool]]'s website<ref>[https://web.archive.org/web/20150307191254/http://mining.bitcoin.cz/stratum-mining Stratum mining protocol specification at slush's pool's website]</ref>.
	Shortly thereafter, alternative "cheat sheet" style documentation was provided by [[BTCGuild]]<ref>[https://www.btcguild.com/new_protocol.php Stratum mining protocol cheat sheet at BTCGuild's website]</ref>.		Shortly thereafter, alternative "cheat sheet" style documentation was provided by [[BTCGuild]]<ref>[https://www.btcguild.com/new_protocol.php Stratum mining protocol cheat sheet at BTCGuild's website]</ref>.
	As the extension lacks a formal [[BIP]] describing an official standard, it has further developed only by discussion and implementation<ref>[https://bitcointalk.org/?topic=108533.0 Stratum discussion thread on BitcoinTalk Forum]</ref>.		As the extension lacks a formal [[BIP]] describing an official standard, it has further developed only by discussion and implementation<ref>[https://bitcointalk.org/?topic=108533.0 Stratum discussion thread on BitcoinTalk Forum]</ref>.

Luke-jr: /* mining.notify */ fix

2024-05-29T16:26:22Z

mining.notify: fix

← Older revision		Revision as of 16:26, 29 May 2024
Line 108:		Line 108:
	# ''nBits.'' The encoded network difficulty. Used in the block header.		# ''nBits.'' The encoded network difficulty. Used in the block header.
	# ''nTime.'' The current time. nTime rolling should be supported, but should not increase faster than actual time.		# ''nTime.'' The current time. nTime rolling should be supported, but should not increase faster than actual time.
	# ''Clean Jobs.'' If true, miners should abort their current work and immediately use the new job. If false, they can still use the current job, but should move to the new one ~~after exhausting the current nonce range~~.		# ''Clean Jobs.'' If true, miners should abort their current work and immediately use the new job, even if it degrades hashrate in the short term. If false, they can still use the current job, but should move to the new one as soon as possible without impacting hashrate.

	====mining.set_difficulty====		====mining.set_difficulty====

Luke-jr: /* mining.subscribe */ Correct resume parameter

2015-10-10T05:29:12Z

mining.subscribe: Correct resume parameter

← Older revision		Revision as of 05:29, 10 October 2015
Line 55:		Line 55:
	mining.subscribe("user agent/version", "extranonce1")		mining.subscribe("user agent/version", "extranonce1")

	The optional second parameter specifies ~~an extranonce1~~ the client wishes to resume working with (possibly due to a dropped connection).		The optional second parameter specifies a mining.notify subscription id the client wishes to resume working with (possibly due to a dropped connection).
	If provided, a server MAY (at its option) issue the connection the same extranonce1.		If provided, a server MAY (at its option) issue the connection the same extranonce1.
			Note that the extranonce1 may be the same (allowing a resumed connection) even if the subscription id is changed!

	The client receives a result:		The client receives a result:

Luke-jr: Reverted edits by Kano (talk) to last revision by Luke-jr

2014-12-20T23:13:08Z

Reverted edits by Kano (talk) to last revision by Luke-jr

← Older revision		Revision as of 23:13, 20 December 2014
Line 66:		Line 66:

	====mining.suggest_difficulty====		====mining.suggest_difficulty====
	mining.suggest_difficulty(preferred share difficulty ~~integer~~)		mining.suggest_difficulty(preferred share difficulty Number)

	Used to indicate a preference for share difficulty to the pool.		Used to indicate a preference for share difficulty to the pool.
Line 144:		Line 144:

	The mining extensions were announced after the community had spent months developing a mostly superior open standard protocol for mining ([[getblocktemplate]])<ref>[https://bitcointalk.org/?topic=557991.msg6105355#msg6105355 BitcoinTalk: Criticism of stratum displacing GBT]</ref>.		The mining extensions were announced after the community had spent months developing a mostly superior open standard protocol for mining ([[getblocktemplate]])<ref>[https://bitcointalk.org/?topic=557991.msg6105355#msg6105355 BitcoinTalk: Criticism of stratum displacing GBT]</ref>.
			Because stratum's mining extensions launched backed by a major mining pool, GBT adoption suffered, and decentralised mining is often neglected while stratum is deployed.

	==References==		==References==
	<references/>		<references/>

Kano: json has integer types: http://jansson.readthedocs.org/en/latest/apiref.html#number The jansson function json_typeof() returns the number type as INTEGER or REAL. The implementations of this method expect an integer

2014-12-20T07:04:37Z

json has integer types: http://jansson.readthedocs.org/en/latest/apiref.html#number The jansson function json_typeof() returns the number type as INTEGER or REAL. The implementations of this method expect an integer

← Older revision		Revision as of 07:04, 20 December 2014
Line 66:		Line 66:

	====mining.suggest_difficulty====		====mining.suggest_difficulty====
	mining.suggest_difficulty(preferred share difficulty ~~Number~~)		mining.suggest_difficulty(preferred share difficulty integer)

	Used to indicate a preference for share difficulty to the pool.		Used to indicate a preference for share difficulty to the pool.

Kano: Removed false statement about stratum implementation. The issue with using GBT on the miner facing side of a pool is the excessively large amount of data required per work item sent to the miner vs stratum. Pools use GBT to talk to bitcoind

2014-12-20T06:51:56Z

Removed false statement about stratum implementation. The issue with using GBT on the miner facing side of a pool is the excessively large amount of data required per work item sent to the miner vs stratum. Pools use GBT to talk to bitcoind

← Older revision		Revision as of 06:51, 20 December 2014
Line 144:		Line 144:

	The mining extensions were announced after the community had spent months developing a mostly superior open standard protocol for mining ([[getblocktemplate]])<ref>[https://bitcointalk.org/?topic=557991.msg6105355#msg6105355 BitcoinTalk: Criticism of stratum displacing GBT]</ref>.		The mining extensions were announced after the community had spent months developing a mostly superior open standard protocol for mining ([[getblocktemplate]])<ref>[https://bitcointalk.org/?topic=557991.msg6105355#msg6105355 BitcoinTalk: Criticism of stratum displacing GBT]</ref>.
	~~Because stratum's mining extensions launched backed by a major mining pool, GBT adoption suffered, and decentralised mining is often neglected while stratum is deployed.~~

	==References==		==References==
	<references/>		<references/>

Luke-jr: /* mining.suggest_difficulty */ Parameter is a Number, not a String (note JSON does not have integer types)

2014-12-20T02:20:25Z

mining.suggest_difficulty: Parameter is a Number, not a String (note JSON does not have integer types)

← Older revision		Revision as of 02:20, 20 December 2014
Line 66:		Line 66:

	====mining.suggest_difficulty====		====mining.suggest_difficulty====
	mining.suggest_difficulty(~~"integer target~~ share difficulty")		mining.suggest_difficulty(preferred share difficulty Number)

	Used to indicate a preference for share difficulty to the pool.		Used to indicate a preference for share difficulty to the pool.

Kano: add share difficulty

2014-12-19T02:32:59Z

add share difficulty

← Older revision		Revision as of 02:32, 19 December 2014
Line 64:		Line 64:
	* ''ExtraNonce1.'' - Hex-encoded, per-connection unique string which will be used for creating generation transactions later.		* ''ExtraNonce1.'' - Hex-encoded, per-connection unique string which will be used for creating generation transactions later.
	* ''ExtraNonce2_size.'' - The number of bytes that the miner users for its ExtraNonce2 counter.		* ''ExtraNonce2_size.'' - The number of bytes that the miner users for its ExtraNonce2 counter.

			====mining.suggest_difficulty====
			mining.suggest_difficulty("integer target share difficulty")

			Used to indicate a preference for share difficulty to the pool.
			Servers are not required to honour this request, even if they support the stratum method.

	====mining.suggest_target====		====mining.suggest_target====

Luke-jr: /* mining.capabilities (DRAFT) */ Update

2014-11-18T23:46:14Z

mining.capabilities (DRAFT): Update

← Older revision		Revision as of 23:46, 18 November 2014
Line 20:		Line 20:
	NOTE: This is a draft extension proposal. It is not yet in use, and may change at any moment.		NOTE: This is a draft extension proposal. It is not yet in use, and may change at any moment.

	mining.capabilities(["notify", "set_difficulty", "set_goal"], {"suggested_target": "hex target"})		mining.capabilities({"notify":[], "set_difficulty":{}, "set_goal":{}, "suggested_target": "hex target"})

	The client may send this to inform the server of its capabilities and options.		The client may send this to inform the server of its capabilities and options.
	The ~~first~~ parameter is ~~a list of~~ capabilities;		The singleton parameter is an Object describing capabilities;
	~~the implied list defaults to [~~"notify", "set_difficulty"], but as soon as this method is used these must be explicitly included if desired.		by default, it is considered as {"notify":{}, "set_difficulty":[]}, but as soon as this method is used these must be explicitly included if desired.
	~~The second parameter is an Object with key/value option pairs~~.
	The "suggested_target" key may supersede the mining.suggest_target method.		The "suggested_target" key may supersede the mining.suggest_target method.

			Note that most of the keys do not have any meaningful value at this time, and the values thereof should be ignored (ie, only their presence matters).

	====mining.extranonce.subscribe====		====mining.extranonce.subscribe====

Luke-jr: Avoid confusing use of [] for optional

2014-11-07T20:45:16Z

Avoid confusing use of [] for optional

← Older revision		Revision as of 20:45, 7 November 2014
Line 12:		Line 12:

	====mining.authorize====		====mining.authorize====
	mining.authorize("username"[, "password"])		mining.authorize("username", "password")

	The result from an authorize request is usually true (successful), or false.		The result from an authorize request is usually true (successful), or false.
Line 52:		Line 52:

	====mining.subscribe====		====mining.subscribe====
	mining.subscribe("user agent/version"[, "extranonce1"])		mining.subscribe("user agent/version", "extranonce1")

	The optional second parameter specifies an extranonce1 the client wishes to resume working with (possibly due to a dropped connection).		The optional second parameter specifies an extranonce1 the client wishes to resume working with (possibly due to a dropped connection).
Line 78:		Line 78:

	====client.reconnect====		====client.reconnect====
	client.reconnect(["hostname", port[, waittime]])		client.reconnect("hostname", port, waittime)

	The client should disconnect, wait ''waittime'' seconds, then connect to the given host/port (which defaults to the current server).		The client should disconnect, wait ''waittime'' seconds (if provided), then connect to the given host/port (which defaults to the current server).
	Note that for security purposes, clients may ignore such requests if the destination is not the same or similar.		Note that for security purposes, clients may ignore such requests if the destination is not the same or similar.

Line 110:		Line 110:

	====mining.set_extranonce====		====mining.set_extranonce====
	mining.set_extranonce("extranonce1"[, extranonce2_size])		mining.set_extranonce("extranonce1", extranonce2_size)

	These values, when provided, replace the initial subscription values beginning with the next mining.notify job.		These values, when provided, replace the initial subscription values beginning with the next mining.notify job.