Sweepprivkey proposal - Revision history

Furunodo at 12:55, 27 June 2020

2020-06-27T12:55:17Z

← Older revision		Revision as of 12:55, 27 June 2020
Line 24:		Line 24:

	==Proposed flowchart==		==Proposed flowchart==
	The ''sweepprivkey'' function depends on the ability to quickly find transactions in the UTXO set controlled by a given private key; simply, a UTXO index on scriptPubKey.		The ''sweepprivkey'' function depends on the ability to quickly find transactions in the [[UTXO]] set controlled by a given private key; simply, a UTXO index on scriptPubKey.

	When the ''sweepprivkey'' command is run, bitcoind will:		When the ''sweepprivkey'' command is run, bitcoind will:

Luke-jr: Current status

2014-05-01T21:03:23Z

Current status

← Older revision		Revision as of 21:03, 1 May 2014
Line 1:		Line 1:
	'''sweepprivkey''' is a PROPOSED Bitcoin RPC command that, given a Bitcoin private key, allows sweeping of some or all of the funds to another address.		'''sweepprivkey''' is a PROPOSED Bitcoin RPC command that, given a Bitcoin private key, allows sweeping of some or all of the funds to another address.
			Despite this specification, this proposal has never been implemented, and cannot be considered for inclusion until it is.

	This function is useful for merchants who wish to accept typed or scanned Bitcoin private keys as payments, without imposing any specific methodology on how the payments must be processed. ''sweepprivkey'' has no direct effect on anything in the local wallet or transaction history -- the function simply generates a transaction in real-time to sweep the funds to another address, and broadcasts it. That destination address may or may not be in the local wallet.		This function is useful for merchants who wish to accept typed or scanned Bitcoin private keys as payments, without imposing any specific methodology on how the payments must be processed. ''sweepprivkey'' has no direct effect on anything in the local wallet or transaction history -- the function simply generates a transaction in real-time to sweep the funds to another address, and broadcasts it. That destination address may or may not be in the local wallet.

Luke-jr: /* Proposed flowchart */ Only the UTXO set needs to be searched; keypairs are not addresses

2014-05-01T21:02:31Z

Proposed flowchart: Only the UTXO set needs to be searched; keypairs are not addresses

← Older revision		Revision as of 21:02, 1 May 2014
Line 23:		Line 23:

	==Proposed flowchart==		==Proposed flowchart==
	The ''sweepprivkey'' function depends on the ability to quickly find transactions in the ~~block chain belonging to~~ a given ~~address. It relies on an in-memory hashtable that is built the first time it is needed~~, ~~and is maintained in memory until bitcoind is shut down. As~~ a result, the first time ''sweepprivkey'' is used, a delay of a few minutes can be expected. This delay can be avoided by starting bitcoind with the --(whatever) command line switch. ''(ideally this should be persistable to disk, as this delay only gets longer as the blockchain grows).''		The ''sweepprivkey'' function depends on the ability to quickly find transactions in the UTXO set controlled by a given private key; simply, a UTXO index on scriptPubKey.

	To conserve resources, the hash table is simple. It associates the first 32 bits of the Bitcoin address (in hash160 form) with a list of the blocks that reference addresses with that prefix. The hashtable is created upon first use, and updated each time a block is received.

	~~''sweepprivkey'' will also scan the in-memory transaction pool and incorporate unconfirmed transactions when the ''minconfirms'' parameter is zero~~.

	When the ''sweepprivkey'' command is run, bitcoind will:		When the ''sweepprivkey'' command is run, bitcoind will:

	# Ensure the ~~address hash table~~ is being maintained ~~in memory~~. If not, it will be built before continuing.		# Ensure the necessary UTXO index is being maintained. If not, it will be built before continuing.
	# ~~Scan all of~~ the ~~blocks that might contain unspent transactions belonging~~ to the ~~address. If minconfirms=0~~, ~~then scan~~ the ~~in-memory transaction pool as well, to create a list~~ of ~~such transactions~~.		# Find the UTXO which is assigned to a standard scriptPubKey redeemable with only the given private key, and ensure it is buried under enough blocks to satisfy the desired level of ''minconfirms''.
	# Confirm that ~~there is a non-zero balance available~~, ~~and that (~~if ''amount'' is specified), ~~that~~ the ~~balance~~ is equal to or greater than it.		# Confirm that, if ''amount'' is specified, the amount received is equal to or greater than it.
	# Do getnewaddress if a wallet account was specified.		# Do getnewaddress if a wallet account was specified.
	~~# If ''amount'' is specified, eliminate all transactions from the list from largest to smallest that will not be needed to satisfy the amount.~~		# Construct a new transaction in memory that spends funds from the found UTXO to the destination address and, if necessary, the change address. Sign the transaction with ''privkey''.
	# Construct a new transaction in memory that ~~sends~~ funds from the ~~Bitcoin address represented by ''privkey''~~ to the destination address and ~~change address~~, if necessary. Sign the transaction with ''privkey''.
	# Treat the signed transaction the same as if it had come from a peer, including relaying it to all connected peers.		# Treat the signed transaction the same as if it had come from a peer, including relaying it to all connected peers.
	# Return success with the txid and (if applicable) the new address that was gathered via ''getnewaddress''.		# Return success with the txid and (if applicable) the new address that was gathered via ''getnewaddress''.

Luke-jr: Put amount and changeaddress together; change should never reuse an address, and it doesn't make sense to generate a change address for the current wallet here

2014-05-01T20:55:13Z

Put amount and changeaddress together; change should never reuse an address, and it doesn't make sense to generate a change address for the current wallet here

← Older revision		Revision as of 20:55, 1 May 2014
Line 13:		Line 13:
	The syntax of ''sweepprivkey'' is as follows:		The syntax of ''sweepprivkey'' is as follows:

	sweepprivkey <privkey> <minconfirms> [<destinationtype> <destination>] [<fee>] [<amount>~~] [~~<changeaddress>]		sweepprivkey <privkey> <minconfirms> [<destinationtype> <destination>] [<fee>] [<amount> <changeaddress>]

	*''privkey'' is required. It can be in any private key format normally accepted for wallet imports with the [[importprivkey]] function.		*''privkey'' is required. It can be in any private key format normally accepted for wallet imports with the [[importprivkey]] function.
Line 20:		Line 20:
	*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.		*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.
	*''fee'' is optional, but must be provided if ''amount'' is provided (so that the command knows which parameter is which). This determines how much of a transaction fee to pay. This can be either an amount, or the word ''"default"'', or the word ''"minimum"''. ''Default'' means to pay the transaction fee configured in the bitcoin client, and is the choice assumed if omitted. ''Minimum'' means to pay the minimum fee that the client believes will be required to ensure that the transaction is relayed by the network (which is based on the transaction's age, size, and other factors - see [[GetMinFee]]). In many cases, the fee may be zero. If you specify an amount but it is below the minimum, or the private key doesn't have a balance large enough to meet the minimum, the command reports failure. Fees are always paid from the funds held by the swept private key, not the wallet.		*''fee'' is optional, but must be provided if ''amount'' is provided (so that the command knows which parameter is which). This determines how much of a transaction fee to pay. This can be either an amount, or the word ''"default"'', or the word ''"minimum"''. ''Default'' means to pay the transaction fee configured in the bitcoin client, and is the choice assumed if omitted. ''Minimum'' means to pay the minimum fee that the client believes will be required to ensure that the transaction is relayed by the network (which is based on the transaction's age, size, and other factors - see [[GetMinFee]]). In many cases, the fee may be zero. If you specify an amount but it is below the minimum, or the private key doesn't have a balance large enough to meet the minimum, the command reports failure. Fees are always paid from the funds held by the swept private key, not the wallet.
	*''amount'' is optional. When not present ~~(or entered as "all")~~, the command will attempt to sweep all funds available via the private key to the extent those funds have enough confirmations to satisfy ''minconfirms''. If an amount is present, the command will only sweep that amount, reporting a failure if amount (plus fee) is greater than the funds available. If the private key contains funds that satisfy ''minconfirms'' as well as funds that do not, only the sufficiently confirmed funds are swept. If a specific amount is requested and a transaction fee must be paid, it will be deducted out of the change rather than the requested transfer amount.		*''amount'' and ''changeaddress'' are optional. When not present, the command will attempt to sweep all funds available via the private key to the extent those funds have enough confirmations to satisfy ''minconfirms''. If an amount is present, the command will only sweep that amount, reporting a failure if amount (plus fee) is greater than the funds available. If the private key contains funds that satisfy ''minconfirms'' as well as funds that do not, only the sufficiently confirmed funds are swept. If a specific amount is requested and a transaction fee must be paid, it will be deducted out of the change rather than the requested transfer amount (FIXME: this seems irrational). ''changeaddress'' address specifies a destination for any leftover change that may be the result of sweeping a partial amount. Not all partial-balance transactions will generate change, particularly if the private key's received amount satisfies exactly the sweep amount. If there is no change, the change address is ignored.
	*''changeaddress'' ~~is optional and must only be provided in conjunction with ''amount'' and ''fee''. This~~ address specifies a destination for any leftover change that may be the result of sweeping a partial amount~~. If ''changeaddress'' is not provided, change is sent back to the original Bitcoin address corresponding to ''privkey''~~. Not all partial-balance transactions will generate change, particularly if the private key's ~~balance arrived in separate smaller transactions that can be used individually to satisfy~~ the sweep amount. If there is no change, the change address is ignored.

	==Proposed flowchart==		==Proposed flowchart==

Casascius: /* Usage */

2011-09-30T03:45:49Z

Usage

← Older revision		Revision as of 03:45, 30 September 2011
Line 19:		Line 19:
	*''destinationtype'' is either the word ''"address"'' or ''"account"'', and indicates what ''destination'' is. ''"address"'' means sweep funds to another Bitcoin address, and ''"account"'' will perform a ''[[getnewaddress]]'' operation to get an address on the local wallet and sweep the funds there. ''destinationtype'' and ''destination'' are optional, but must both be present together when used. If these are absent, the command is treated as a simple query which returns the total funds available to the private key.		*''destinationtype'' is either the word ''"address"'' or ''"account"'', and indicates what ''destination'' is. ''"address"'' means sweep funds to another Bitcoin address, and ''"account"'' will perform a ''[[getnewaddress]]'' operation to get an address on the local wallet and sweep the funds there. ''destinationtype'' and ''destination'' are optional, but must both be present together when used. If these are absent, the command is treated as a simple query which returns the total funds available to the private key.
	*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.		*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.
	*''fee'' is optional, but must be provided if ''amount'' is provided (so that the command knows which parameter is which). This determines how much of a transaction fee to pay. This can be either an amount, or the word ''"default"'', or the word ''"minimum"''. ''Default'' means to pay the transaction fee configured in the bitcoin client, and is the choice assumed if omitted. ''Minimum'' means to pay the minimum fee that the client believes will be required to ensure that the transaction is relayed by the network (which is based on the transaction's age, size, and other factors - see [[GetMinFee]]). In many cases, the fee may be zero. If you specify an amount but it is below the minimum, or the private key doesn't have a balance large enough to meet the minimum, the command reports failure. Fees are always paid ~~out of~~ the swept ~~balance~~, not the wallet.		*''fee'' is optional, but must be provided if ''amount'' is provided (so that the command knows which parameter is which). This determines how much of a transaction fee to pay. This can be either an amount, or the word ''"default"'', or the word ''"minimum"''. ''Default'' means to pay the transaction fee configured in the bitcoin client, and is the choice assumed if omitted. ''Minimum'' means to pay the minimum fee that the client believes will be required to ensure that the transaction is relayed by the network (which is based on the transaction's age, size, and other factors - see [[GetMinFee]]). In many cases, the fee may be zero. If you specify an amount but it is below the minimum, or the private key doesn't have a balance large enough to meet the minimum, the command reports failure. Fees are always paid from the funds held by the swept private key, not the wallet.
	*''amount'' is optional. When not present (or entered as "all"), the command will attempt to sweep all funds available via the private key to the extent those funds have enough confirmations to satisfy ''minconfirms''. If an amount is present, the command will only sweep that amount, reporting a failure if amount (plus fee) is greater than the funds available. If the private key contains funds that satisfy ''minconfirms'' as well as funds that do not, only the sufficiently confirmed funds are swept. If a specific amount is requested and a transaction fee must be paid, it will be deducted out of the change rather than the requested transfer amount.		*''amount'' is optional. When not present (or entered as "all"), the command will attempt to sweep all funds available via the private key to the extent those funds have enough confirmations to satisfy ''minconfirms''. If an amount is present, the command will only sweep that amount, reporting a failure if amount (plus fee) is greater than the funds available. If the private key contains funds that satisfy ''minconfirms'' as well as funds that do not, only the sufficiently confirmed funds are swept. If a specific amount is requested and a transaction fee must be paid, it will be deducted out of the change rather than the requested transfer amount.
	*''changeaddress'' is optional and must only be provided in conjunction with ''amount'' and ''fee''. This address specifies a destination for any leftover change that may be the result of sweeping a partial amount. If ''changeaddress'' is not provided, change is sent back to the original Bitcoin address corresponding to ''privkey''. Not all partial-balance transactions will generate change, particularly if the private key's balance arrived in separate smaller transactions that can be used individually to satisfy the sweep amount. If there is no change, the change address is ignored.		*''changeaddress'' is optional and must only be provided in conjunction with ''amount'' and ''fee''. This address specifies a destination for any leftover change that may be the result of sweeping a partial amount. If ''changeaddress'' is not provided, change is sent back to the original Bitcoin address corresponding to ''privkey''. Not all partial-balance transactions will generate change, particularly if the private key's balance arrived in separate smaller transactions that can be used individually to satisfy the sweep amount. If there is no change, the change address is ignored.

Casascius: /* Usage */ swapped positions, because amount is more optional than fee

2011-09-30T03:43:54Z

Usage: swapped positions, because amount is more optional than fee

← Older revision		Revision as of 03:43, 30 September 2011
Line 13:		Line 13:
	The syntax of ''sweepprivkey'' is as follows:		The syntax of ''sweepprivkey'' is as follows:

	sweepprivkey <privkey> <minconfirms> [<destinationtype> <destination>] [<~~amount~~>] [<~~fee~~>] [<changeaddress>]		sweepprivkey <privkey> <minconfirms> [<destinationtype> <destination>] [<fee>] [<amount>] [<changeaddress>]

	*''privkey'' is required. It can be in any private key format normally accepted for wallet imports with the [[importprivkey]] function.		*''privkey'' is required. It can be in any private key format normally accepted for wallet imports with the [[importprivkey]] function.
Line 19:		Line 19:
	*''destinationtype'' is either the word ''"address"'' or ''"account"'', and indicates what ''destination'' is. ''"address"'' means sweep funds to another Bitcoin address, and ''"account"'' will perform a ''[[getnewaddress]]'' operation to get an address on the local wallet and sweep the funds there. ''destinationtype'' and ''destination'' are optional, but must both be present together when used. If these are absent, the command is treated as a simple query which returns the total funds available to the private key.		*''destinationtype'' is either the word ''"address"'' or ''"account"'', and indicates what ''destination'' is. ''"address"'' means sweep funds to another Bitcoin address, and ''"account"'' will perform a ''[[getnewaddress]]'' operation to get an address on the local wallet and sweep the funds there. ''destinationtype'' and ''destination'' are optional, but must both be present together when used. If these are absent, the command is treated as a simple query which returns the total funds available to the private key.
	*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.		*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.
	*''amount'' is optional. When not present, the command will attempt to sweep all funds available via the private key to the extent those funds have enough confirmations to satisfy ''minconfirms''. If an amount is present, the command will only sweep that amount, reporting a failure if amount is greater than the funds available. If the private key contains funds that satisfy ''minconfirms'' as well as funds that do not, only the sufficiently confirmed funds are swept.		*''fee'' is optional, but must be provided if ''amount'' is provided (so that the command knows which parameter is which). This determines how much of a transaction fee to pay. This can be either an amount, or the word ''"default"'', or the word ''"minimum"''. ''Default'' means to pay the transaction fee configured in the bitcoin client, and is the choice assumed if omitted. ''Minimum'' means to pay the minimum fee that the client believes will be required to ensure that the transaction is relayed by the network (which is based on the transaction's age, size, and other factors - see [[GetMinFee]]). In many cases, the fee may be zero. If you specify an amount but it is below the minimum, or the private key doesn't have a balance large enough to meet the minimum, the command reports failure. Fees are always paid out of the swept balance, not the wallet.
	*''fee'' is optional, but must be provided if ''~~changeaddress~~'' is provided. This determines how much of a transaction fee to pay. This can be either an amount, or the word ''"default"'', or the word ''"minimum"''. ''Default'' means to pay the transaction fee configured in the bitcoin client. ''Minimum'' means to pay the minimum fee that the client believes will be required to ensure that the transaction is relayed by the network (which is based on the transaction's age, size, and other factors - see [[GetMinFee]]). In many cases, the fee may be zero. If you specify an amount but it is below the minimum, or the private key doesn't have a balance large enough to meet the minimum, the command reports failure. Fees are always paid out of the swept balance, not the wallet.		*''amount'' is optional. When not present (or entered as "all"), the command will attempt to sweep all funds available via the private key to the extent those funds have enough confirmations to satisfy ''minconfirms''. If an amount is present, the command will only sweep that amount, reporting a failure if amount (plus fee) is greater than the funds available. If the private key contains funds that satisfy ''minconfirms'' as well as funds that do not, only the sufficiently confirmed funds are swept. If a specific amount is requested and a transaction fee must be paid, it will be deducted out of the change rather than the requested transfer amount.
	*''changeaddress'' is optional and must only be provided in conjunction with ''amount'' and ''fee''. This address specifies a destination for any leftover change that may be the result of sweeping a partial amount. If ''changeaddress'' is not provided, change is sent back to the original Bitcoin address corresponding to ''privkey''. Not all partial-balance transactions will generate change, particularly if the private key's balance arrived in separate smaller transactions that can be used individually to satisfy the sweep amount.		*''changeaddress'' is optional and must only be provided in conjunction with ''amount'' and ''fee''. This address specifies a destination for any leftover change that may be the result of sweeping a partial amount. If ''changeaddress'' is not provided, change is sent back to the original Bitcoin address corresponding to ''privkey''. Not all partial-balance transactions will generate change, particularly if the private key's balance arrived in separate smaller transactions that can be used individually to satisfy the sweep amount. If there is no change, the change address is ignored.

	==Proposed flowchart==		==Proposed flowchart==

Casascius: /* Usage */

2011-09-30T02:37:50Z

Usage

← Older revision		Revision as of 02:37, 30 September 2011
Line 13:		Line 13:
	The syntax of ''sweepprivkey'' is as follows:		The syntax of ''sweepprivkey'' is as follows:

	sweepprivkey <privkey> <minconfirms> [<destinationtype> <destination>] [<amount>] [<changeaddress>]		sweepprivkey <privkey> <minconfirms> [<destinationtype> <destination>] [<amount>] [<fee>] [<changeaddress>]

	*''privkey'' is required. It can be in any private key format normally accepted for wallet imports with the [[importprivkey]] function.		*''privkey'' is required. It can be in any private key format normally accepted for wallet imports with the [[importprivkey]] function.
Line 20:		Line 20:
	*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.		*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.
	*''amount'' is optional. When not present, the command will attempt to sweep all funds available via the private key to the extent those funds have enough confirmations to satisfy ''minconfirms''. If an amount is present, the command will only sweep that amount, reporting a failure if amount is greater than the funds available. If the private key contains funds that satisfy ''minconfirms'' as well as funds that do not, only the sufficiently confirmed funds are swept.		*''amount'' is optional. When not present, the command will attempt to sweep all funds available via the private key to the extent those funds have enough confirmations to satisfy ''minconfirms''. If an amount is present, the command will only sweep that amount, reporting a failure if amount is greater than the funds available. If the private key contains funds that satisfy ''minconfirms'' as well as funds that do not, only the sufficiently confirmed funds are swept.
	*''changeaddress'' is optional and must only be provided in conjunction with ''amount''. This address specifies a destination for any leftover change that may be the result of sweeping a partial amount. If ''changeaddress'' is not provided, change is sent back to the original Bitcoin address corresponding to ''privkey''. Not all partial-balance transactions will generate change, particularly if the private key's balance arrived in separate smaller transactions that can be used individually to satisfy the sweep amount.		*''fee'' is optional, but must be provided if ''changeaddress'' is provided. This determines how much of a transaction fee to pay. This can be either an amount, or the word ''"default"'', or the word ''"minimum"''. ''Default'' means to pay the transaction fee configured in the bitcoin client. ''Minimum'' means to pay the minimum fee that the client believes will be required to ensure that the transaction is relayed by the network (which is based on the transaction's age, size, and other factors - see [[GetMinFee]]). In many cases, the fee may be zero. If you specify an amount but it is below the minimum, or the private key doesn't have a balance large enough to meet the minimum, the command reports failure. Fees are always paid out of the swept balance, not the wallet.
			*''changeaddress'' is optional and must only be provided in conjunction with ''amount'' and ''fee''. This address specifies a destination for any leftover change that may be the result of sweeping a partial amount. If ''changeaddress'' is not provided, change is sent back to the original Bitcoin address corresponding to ''privkey''. Not all partial-balance transactions will generate change, particularly if the private key's balance arrived in separate smaller transactions that can be used individually to satisfy the sweep amount.

	==Proposed flowchart==		==Proposed flowchart==

Casascius at 18:52, 24 September 2011

2011-09-24T18:52:38Z

← Older revision		Revision as of 18:52, 24 September 2011
Line 1:		Line 1:
	~~The~~ '''sweepprivkey''' is a PROPOSED Bitcoin RPC command that, given a Bitcoin private key, allows sweeping of some or all of the funds to another address.		'''sweepprivkey''' is a PROPOSED Bitcoin RPC command that, given a Bitcoin private key, allows sweeping of some or all of the funds to another address.

	This function is useful for merchants who wish to accept typed or scanned Bitcoin private keys as payments, without imposing any specific methodology on how the payments must be processed. ''sweepprivkey'' has no direct effect on anything in the local wallet or transaction history -- the function simply generates a transaction in real-time to sweep the funds to another address, and broadcasts it. That destination address may or may not be in the local wallet.		This function is useful for merchants who wish to accept typed or scanned Bitcoin private keys as payments, without imposing any specific methodology on how the payments must be processed. ''sweepprivkey'' has no direct effect on anything in the local wallet or transaction history -- the function simply generates a transaction in real-time to sweep the funds to another address, and broadcasts it. That destination address may or may not be in the local wallet.

Casascius: /* Usage */

2011-09-24T18:47:20Z

Usage

← Older revision		Revision as of 18:47, 24 September 2011
Line 19:		Line 19:
	*''destinationtype'' is either the word ''"address"'' or ''"account"'', and indicates what ''destination'' is. ''"address"'' means sweep funds to another Bitcoin address, and ''"account"'' will perform a ''[[getnewaddress]]'' operation to get an address on the local wallet and sweep the funds there. ''destinationtype'' and ''destination'' are optional, but must both be present together when used. If these are absent, the command is treated as a simple query which returns the total funds available to the private key.		*''destinationtype'' is either the word ''"address"'' or ''"account"'', and indicates what ''destination'' is. ''"address"'' means sweep funds to another Bitcoin address, and ''"account"'' will perform a ''[[getnewaddress]]'' operation to get an address on the local wallet and sweep the funds there. ''destinationtype'' and ''destination'' are optional, but must both be present together when used. If these are absent, the command is treated as a simple query which returns the total funds available to the private key.
	*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.		*''destination'' is either a Bitcoin address (if ''destinationtype'' is ''"address"''), or is an account name (if ''destinationtype'' is ''"account"''). Funds are sent here.
	*''amount'' is optional. If not present, the command will attempt to sweep all funds available to the private key. If present, the command will only sweep that amount, reporting a failure if amount is greater than the funds available.		*''amount'' is optional. When not present, the command will attempt to sweep all funds available via the private key to the extent those funds have enough confirmations to satisfy ''minconfirms''. If an amount is present, the command will only sweep that amount, reporting a failure if amount is greater than the funds available. If the private key contains funds that satisfy ''minconfirms'' as well as funds that do not, only the sufficiently confirmed funds are swept.
	*''changeaddress'' is optional and must only be provided in conjunction with ''amount''. This address specifies a ~~specific~~ destination for any leftover change that may be the result of sweeping a partial amount. Not all partial-balance transactions generate change, particularly if the private key's balance arrived as smaller transactions that can be used ~~separately~~ to satisfy the ~~transfer request. If ''changeaddress'' is not provided, change is sent back to the original Bitcoin address corresponding to ''privkey''~~.		*''changeaddress'' is optional and must only be provided in conjunction with ''amount''. This address specifies a destination for any leftover change that may be the result of sweeping a partial amount. If ''changeaddress'' is not provided, change is sent back to the original Bitcoin address corresponding to ''privkey''. Not all partial-balance transactions will generate change, particularly if the private key's balance arrived in separate smaller transactions that can be used individually to satisfy the sweep amount.

	==Proposed flowchart==		==Proposed flowchart==

Casascius: /* Proposed flowchart */

2011-09-24T18:42:13Z

Proposed flowchart

← Older revision		Revision as of 18:42, 24 September 2011
Line 27:		Line 27:
	To conserve resources, the hash table is simple. It associates the first 32 bits of the Bitcoin address (in hash160 form) with a list of the blocks that reference addresses with that prefix. The hashtable is created upon first use, and updated each time a block is received.		To conserve resources, the hash table is simple. It associates the first 32 bits of the Bitcoin address (in hash160 form) with a list of the blocks that reference addresses with that prefix. The hashtable is created upon first use, and updated each time a block is received.

	''sweepprivkey'' will also scan the in-memory transaction pool and ~~attempt~~		''sweepprivkey'' will also scan the in-memory transaction pool and incorporate unconfirmed transactions when the ''minconfirms'' parameter is zero.

	When the ''sweepprivkey'' command is run, bitcoind will:		When the ''sweepprivkey'' command is run, bitcoind will: