Changing names for RGB wallet and standard library #58
Closed
dr-orlovsky
started this conversation in
General
Replies: 0 comments 2 replies
-
Personally I agree that the current situation is a bit confusing and a clean up would have benefits, but at the same time I am worried about using the same name |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Right now we have two RGB repositories providing client-facing APIs:
rgb-wallet
andrgb
. However, this naming is confusing in multiple ways.rgb-wallet
repository providesrgb-std
crate (having no "wallet" functionality and not depending onrust-bitcoin
)rgb-invoice
crate (since v0.11 will also not depend onrust-bitcoin
)rgb-psbt
crate (since v0.11 will also not depend onrust-bitcoin
and supporting PSBTv2)The last two crates were the reason for the naming since in
v0.10
since they were constituting a singlergb-wallet
crate inside the repo. However, withv0.11
I am splitting them since many projects will need just invoice parsing/generator functionality without requiring the whole RGB consensus + standard library + PSBT functionality. Also, some wallet projects may need invoicing and the standard library, and will use some alternative PSBT likerust-bitcoin
+ BDK + rgb tools, etc.In other words, there is no "wallet" in
rgb-wallet
repo: we can't filter RGB data from the standard library for a specific wallet descriptor or generate a PSBT spending some existing RGB assignments.Now, on the other hand, the other repo
rgb
(the most user/client-facing repo) has received the actual wallet facilities allowing all of that functionality and providing a command-line wallet tool able to work with descriptors and do the filtering + generate PSBTs. Still this command-line tool has a crate namergb-contracts
(since justrgb
is not available and is used by some color-managing lib), which is confusing (since it is not "contracts" but an actual command-line RGB wallet).So I propose to rename
rgb-wallet
repository intorgb-std
- and usergb-wallet
as a name for the crate containing the command-line wallet tool - so it can be installed by users with justcargo install rgb-wallet
command (instead ofcargo install rgb-contracts --all-features
used today).This will also reflect the same approach I used for @BP-WG in v0.11 stack:
bp-std
repo andbp-wallet
repo, with the last one providing the actual wallet APIs (runtime) and a command-line tool wrapping it.Beta Was this translation helpful? Give feedback.
All reactions