MIME-Version: 1.0
From: Craig Raw <craigraw@gmail.com>
Date: Wed, 24 Aug 2022 11:18:43 +0200
Message-ID: <CAPR5oBNKQEPCAXcMoneGv2vLVmOLZGyxNEoZ4_=tyQT_mkAkmw@mail.gmail.com>
To: Bitcoin Protocol Discussion <bitcoin-dev@lists.linuxfoundation.org>
Content-Type: multipart/alternative; boundary="00000000000087903905e6f92b4f"
Subject: [bitcoin-dev] BIP Proposal: Wallet Labels Export Format
Precedence: list

--00000000000087903905e6f92b4f
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

Hi all,

I would like to propose a BIP that specifies a format for the export and
import of labels from a wallet. While transferring access to funds across
wallet applications has been made simple through standards such as BIP39,
wallet labels remain siloed and difficult to extract despite their value,
particularly in a privacy context.

The proposed format is a simple two column CSV file, with the reference to
a transaction, address, input or output in the first column, and the label
in the second column. CSV was chosen for its wide accessibility, especially
to users without specific technical expertise. Similarly, the CSV file may
be compressed using the ZIP format, and optionally encrypted using AES.

The full text of the BIP can be found at
https://github.com/craigraw/bips/blob/master/bip-wallet-labels.mediawiki
and also copied below.

Feedback is appreciated.

Thanks,
Craig Raw

---

<pre>
  BIP: wallet-labels
  Layer: Applications
  Title: Wallet Labels Export Format
  Author: Craig Raw <craig@sparrowwallet.com>
  Comments-Summary: No comments yet.
  Comments-URI:
https://github.com/bitcoin/bips/wiki/Comments:BIP-wallet-labels
  Status: Draft
  Type: Informational
  Created: 2022-08-23
  License: BSD-2-Clause
</pre>

=3D=3DAbstract=3D=3D

This document specifies a format for the export of labels that may be
attached to the transactions, addresses, input and outputs in a wallet.

=3D=3DCopyright=3D=3D

This BIP is licensed under the BSD 2-clause license.

=3D=3DMotivation=3D=3D

The export and import of funds across different Bitcoin wallet applications
is well defined through standards such as BIP39, BIP32, BIP44 etc.
These standards are well supported and allow users to move easily between
different wallets.
There is, however, no defined standard to transfer any labels the user may
have applied to the transactions, addresses, inputs or outputs in their
wallet.
The UTXO model that Bitcoin uses makes these labels particularly valuable
as they may indicate the source of funds, whether received externally or as
a result of change from a prior transaction.
In both cases, care must be taken when spending to avoid undesirable leaks
of private information.
Labels provide valuable guidance in this regard, and have even become
mandatory when spending in several Bitcoin wallets.
Allowing users to export their labels in a standardized way ensures that
they do not experience lock-in to a particular wallet application.
In addition, by using common formats, this BIP seeks to make manual or bulk
management of labels accessible to users without specific technical
expertise.

=3D=3DSpecification=3D=3D

In order to make the import and export of labels as widely accessible as
possible, this BIP uses the comma separated values (CSV) format, which is
widely supported by consumer, business, and scientific applications.
Although the technical specification of CSV in RFC4180 is not always
followed, the application of the format in this BIP is simple enough that
compatibility should not present a problem.
Moreover, the simplicity and forgiving nature of CSV (over for example
JSON) lends itself well to bulk label editing using spreadsheet and text
editing tools.

A CSV export of labels from a wallet must be a UTF-8 encoded text file,
containing one record per line, with records containing two fields
delimited by a comma.
The fields may be quoted, but this is unnecessary, as the first comma in
the line will always be the delimiter.
The first line in the file is a header, and should be ignored on import.
Thereafter, each line represents a record that refers to a label applied in
the wallet.
The order in which these records appear is not defined.

The first field in the record contains a reference to the transaction,
address, input or output in the wallet.
This is specified as one of the following:
* Transaction ID (<tt>txid</tt>)
* Address
* Input (rendered as <tt>txid<index</tt>)
* Output (rendered as <tt>txid>index</tt> or <tt>txid:index</tt>)

The second field contains the label applied to the reference.
Exporting applications may omit records with no labels or labels of zero
length.
Files exported should use the <tt>.csv</tt> file extension.

In order to reduce file size while retaining wide accessibility, the CSV
file may be compressed using the ZIP file format, using the <tt>.zip</tt>
file extension.
This <tt>.zip</tt> file may optionally be encrypted using either AES-128 or
AES-256 encryption, which is supported by numerous applications including
Winzip and 7-zip.
In order to ensure that weak encryption does not proliferate, importers
following this standard must refuse to import <tt>.zip</tt> files encrypted
with the weaker Zip 2.0 standard.
The textual representation of the wallet's extended public key (as defined
by BIP32, with an <tt>xpub</tt> header) should be used as the password.

=3D=3DImporting=3D=3D

When importing, a naive algorithm may simply match against any reference,
but it is possible to disambiguate between transactions, addresses, inputs
and outputs.
For example in the following pseudocode:
<pre>
  if reference length < 64
    Set address label
  else if reference length =3D=3D 64
    Set transaction label
  else if reference contains '<'
    Set input label
  else
    Set output label
</pre>

Importing applications may truncate labels if necessary.

=3D=3DTest Vectors=3D=3D

The following fragment represents a wallet label export:
<pre>
Reference,Label
c3bdad6e7dcd7997e16a5b7b7cf4d8f6079820ff2eedd5fcbb2ad088f767b37b=E2=80=8E,T=
ransaction
1A69TXnEM2ms9fMaY9UuiJ7415X7xZaUSg,Address
c3bdad6e7dcd7997e16a5b7b7cf4d8f6079820ff2eedd5fcbb2ad088f767b37b=E2=80=8E<0=
,Input
c3bdad6e7dcd7997e16a5b7b7cf4d8f6079820ff2eedd5fcbb2ad088f767b37b=E2=80=8E>0=
,Output
c3bdad6e7dcd7997e16a5b7b7cf4d8f6079820ff2eedd5fcbb2ad088f767b37b=E2=80=8E:0=
,Output
(alternative)
</pre>

=3D=3DReference Implementation=3D=3D

TBD

--00000000000087903905e6f92b4f
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">Hi all,<div><br></div><div>I would=C2=A0like to propose a =
BIP that specifies a format=C2=A0for the export and import of labels from a=
 wallet. While transferring access to funds across wallet applications has =
been made simple through standards such as BIP39, wallet=C2=A0labels remain=
 siloed and difficult to extract despite their value, particularly in a pri=
vacy context.</div><div><br></div><div>The proposed format is a simple two =
column CSV file, with the reference to a transaction, address, input or out=
put in the first column, and the label in the second column. CSV was chosen=
 for its wide accessibility, especially to users without specific technical=
 expertise. Similarly, the CSV file may be compressed using the ZIP format,=
 and optionally encrypted using AES.</div><div><br></div><div>The full text=
 of the BIP can be found at=C2=A0<a href=3D"https://github.com/craigraw/bip=
s/blob/master/bip-wallet-labels.mediawiki">https://github.com/craigraw/bips=
/blob/master/bip-wallet-labels.mediawiki</a> and also copied below.</div><d=
iv><br></div><div>Feedback is appreciated.</div><div><br></div><div>Thanks,=
</div><div>Craig Raw</div><div><br></div><div>---</div><div><br></div><div>=
&lt;pre&gt;<br>=C2=A0 BIP: wallet-labels<br>=C2=A0 Layer: Applications<br>=
=C2=A0 Title: Wallet Labels Export Format<br>=C2=A0 Author: Craig Raw &lt;<=
a href=3D"mailto:craig@sparrowwallet.com">craig@sparrowwallet.com</a>&gt;<b=
r>=C2=A0 Comments-Summary: No comments yet.<br>=C2=A0 Comments-URI: <a href=
=3D"https://github.com/bitcoin/bips/wiki/Comments:BIP-wallet-labels">https:=
//github.com/bitcoin/bips/wiki/Comments:BIP-wallet-labels</a><br>=C2=A0 Sta=
tus: Draft<br>=C2=A0 Type: Informational<br>=C2=A0 Created: 2022-08-23<br>=
=C2=A0 License: BSD-2-Clause<br>&lt;/pre&gt;<br><br>=3D=3DAbstract=3D=3D<br=
><br>This document specifies a format for the export of labels that may be =
attached to the transactions, addresses, input and outputs in a wallet.<br>=
<br>=3D=3DCopyright=3D=3D<br><br>This BIP is licensed under the BSD 2-claus=
e license.<br><br>=3D=3DMotivation=3D=3D<br><br>The export and import of fu=
nds across different Bitcoin wallet applications is well defined through st=
andards such as BIP39, BIP32, BIP44 etc.<br>These standards are well suppor=
ted and allow users to move easily between different wallets.<br>There is, =
however, no defined standard to transfer any labels the user may have appli=
ed to the transactions, addresses, inputs or outputs in their wallet.<br>Th=
e UTXO model that Bitcoin uses makes these labels particularly valuable as =
they may indicate the source of funds, whether received externally or as a =
result of change from a prior transaction.<br>In both cases, care must be t=
aken when spending to avoid undesirable leaks of private information.<br>La=
bels provide valuable guidance in this regard, and have even become mandato=
ry when spending in several Bitcoin wallets.<br>Allowing users to export th=
eir labels in a standardized way ensures that they do not experience lock-i=
n to a particular wallet application.<br>In addition, by using common forma=
ts, this BIP seeks to make manual or bulk management of labels accessible t=
o users without specific technical expertise.<br><br>=3D=3DSpecification=3D=
=3D<br><br>In order to make the import and export of labels as widely acces=
sible as possible, this BIP uses the comma separated values (CSV) format, w=
hich is widely supported by consumer, business, and scientific applications=
.<br>Although the technical specification of CSV in RFC4180 is not always f=
ollowed, the application of the format in this BIP is simple enough that co=
mpatibility should not present a problem.<br>Moreover, the simplicity and f=
orgiving nature of CSV (over for example JSON) lends itself well to bulk la=
bel editing using spreadsheet and text editing tools. <br><br>A CSV export =
of labels from a wallet must be a UTF-8 encoded text file, containing one r=
ecord per line, with records containing two fields delimited by a comma.<br=
>The fields may be quoted, but this is unnecessary, as the first comma in t=
he line will always be the delimiter.<br>The first line in the file is a he=
ader, and should be ignored on import.<br>Thereafter, each line represents =
a record that refers to a label applied in the wallet.<br>The order in whic=
h these records appear is not defined.<br><br>The first field in the record=
 contains a reference to the transaction, address, input or output in the w=
allet.<br>This is specified as one of the following:<br>* Transaction ID (&=
lt;tt&gt;txid&lt;/tt&gt;)<br>* Address<br>* Input (rendered as &lt;tt&gt;tx=
id&lt;index&lt;/tt&gt;)<br>* Output (rendered as &lt;tt&gt;txid&gt;index&lt=
;/tt&gt; or &lt;tt&gt;txid:index&lt;/tt&gt;)<br><br>The second field contai=
ns the label applied to the reference. <br>Exporting applications may omit =
records with no labels or labels of zero length.<br>Files exported should u=
se the &lt;tt&gt;.csv&lt;/tt&gt; file extension.<br><br>In order to reduce =
file size while retaining wide accessibility, the CSV file may be compresse=
d using the ZIP file format, using the &lt;tt&gt;.zip&lt;/tt&gt; file exten=
sion.<br>This &lt;tt&gt;.zip&lt;/tt&gt; file may optionally be encrypted us=
ing either AES-128 or AES-256 encryption, which is supported by numerous ap=
plications including Winzip and 7-zip. <br>In order to ensure that weak enc=
ryption does not proliferate, importers following this standard must refuse=
 to import &lt;tt&gt;.zip&lt;/tt&gt; files encrypted with the weaker Zip 2.=
0 standard.<br>The textual representation of the wallet&#39;s extended publ=
ic key (as defined by BIP32, with an &lt;tt&gt;xpub&lt;/tt&gt; header) shou=
ld be used as the password.<br><br>=3D=3DImporting=3D=3D<br><br>When import=
ing, a naive algorithm may simply match against any reference, but it is po=
ssible to disambiguate between transactions, addresses, inputs and outputs.=
 <br>For example in the following pseudocode:<br>&lt;pre&gt;<br>=C2=A0 if r=
eference length &lt; 64<br>=C2=A0 =C2=A0 Set address label<br>=C2=A0 else i=
f reference length =3D=3D 64<br>=C2=A0 =C2=A0 Set transaction label<br>=C2=
=A0 else if reference contains &#39;&lt;&#39;<br>=C2=A0 =C2=A0 Set input la=
bel<br>=C2=A0 else<br>=C2=A0 =C2=A0 Set output label<br>&lt;/pre&gt;<br><br=
>Importing applications may truncate labels if necessary.<br><br>=3D=3DTest=
 Vectors=3D=3D<br><br>The following fragment represents a wallet label expo=
rt:<br>&lt;pre&gt;<br>Reference,Label<br>c3bdad6e7dcd7997e16a5b7b7cf4d8f607=
9820ff2eedd5fcbb2ad088f767b37b=E2=80=8E,Transaction<br>1A69TXnEM2ms9fMaY9Uu=
iJ7415X7xZaUSg,Address<br>c3bdad6e7dcd7997e16a5b7b7cf4d8f6079820ff2eedd5fcb=
b2ad088f767b37b=E2=80=8E&lt;0,Input<br>c3bdad6e7dcd7997e16a5b7b7cf4d8f60798=
20ff2eedd5fcbb2ad088f767b37b=E2=80=8E&gt;0,Output<br>c3bdad6e7dcd7997e16a5b=
7b7cf4d8f6079820ff2eedd5fcbb2ad088f767b37b=E2=80=8E:0,Output (alternative)<=
br>&lt;/pre&gt;<br><br>=3D=3DReference Implementation=3D=3D<br><br>TBD<br><=
/div><div><br></div><div><br></div></div>

--00000000000087903905e6f92b4f--