Adopting to v0.12 by dr-orlovsky · Pull Request #6 · rgb-protocol/rgb-sandbox

dr-orlovsky · 2025-01-07T14:33:14Z

No description provided.

dr-orlovsky · 2025-02-02T14:17:07Z

Changed the base to v0.11-beta.9 so it will be easier to review v0.12-specific changes

still not working...

dr-orlovsky · 2025-02-03T18:03:07Z

demo.sh


-# closing method / derivation variables
-CLOSING_METHODS=("opret1st" "tapret1st")
-
-# rgb-schemata variables
-SCHEMATA_DIR="./rgb-schemata/schemata"
+# RGB wallet types
+WALLET_TYPES=("wpkh" "tapret-key-only")


We do not have seal types anymore. However, we have wallet types, which work in the following way: if you have a taproot wallet, it will always produce tapret commitments; all other wallet descriptor types will always do opret. Since BP so far supports only one taproot descriptor (key-only), thus, in order to produce tapret commitments you need to create a wallet with tapret-key-only descriptor.

I expect this would be the same with your changes to v0.11x

dr-orlovsky · 2025-02-03T18:03:33Z

demo.sh


 # maps
 declare -A CONTRACT_ID_MAP
-declare -A CONTRACT_SCHEMA_MAP


No more schemata; now we have codexes, which are specified right inside the YAML files for contract issuance.

dr-orlovsky · 2025-02-03T18:04:34Z

demo.sh

-declare -A CONTRACT_SCHEMA_MAP
+declare -A CONTRACT_NAME_MAP
 declare -A DESC_MAP
-declare -A IFACE_MAP


No more interfaces in v0.12; contracts are using so-called APIs, which always ships with them, and since there always a default one, there is no need to specify it neither in rust APIs nor in command-line

dr-orlovsky · 2025-02-03T18:06:09Z

demo.sh

+CONTRACT_NAME_MAP["usdt"]=USDT
+CONTRACT_NAME_MAP["collectible"]=OtherToken


In v0.12 we have a concept of contract name. Contract directories inside the stash are organized by names (to simplify debugging), and thus, we using this index in order to do import/export with cp (as I explain below, I didn't get time to do import/export commands for rgb cli, and used simple directory cp, since contracts are now reside in independent directories - and not all in one mixed stock file as before)

dr-orlovsky · 2025-02-03T18:06:57Z

demo.sh

    _subtit "syncing $wallet"
    local wallet_id=${WLT_ID_MAP[$wallet]}
-    _trace "${RGB[@]}" -d "data${wallet_id}" utxos -w "$wallet" --sync
+    _trace "${RGB[@]}" -d "data${wallet_id}" sync "$INDEXER_CLI" "$wallet"


I did a dedicated sync command. Also, if a command works with wallet, you provide wallet name as an unnamed argument, instead of using -w

dr-orlovsky · 2025-02-03T18:12:16Z

demo.sh

        _subtit "(recipient) preparing invoice"
        if [ "$witness" = 1 ]; then
-            address_mode="-a"
+            address_mode="--wout"


pay-to-address invoices are called "witness output-invoices"

dr-orlovsky · 2025-02-03T18:17:43Z

demo.sh

+        _trace "${RGB[@]}" -d "$rcpt_data" invoice "$address_mode" \
+            -w "$RCPT_WLT" "$contract_id" "$send_amt" >$TRACE_OUT


invoicing now simpler: no need to provide interface name.

Also, no more "amounts"; invoice includes now arbitrary state, encoded as a strict value. Good news: for numbers, it is just like writing the number. And it is now a positional argument

Both contract_id and state as positional arguments are now optional, allowing creating invoices in form of "pay anything" and "pay any amount under this contract"

This is where the script execution always fails, with

error: invalid value '' for '[CONTRACT]': invalid contract reference '' For more information, try '--help'. ERROR: command 'rgb-wallet/bin/rgb -n regtest -d data1 invoice -w wallet_1 contract:Ko_9~W2J-YXwpN8e-ZTY9X2l-PtqSsUN-g2Wu0ij-onReuzw 100' returned a non-zero exit code (transfer 0)

Spent a lot of time trying to figure why....

Ok, solved this: the reason was that "$address_mode" didn't worked producing an excessive argument in a form of '' when a UTXO payment is used. Spent a day figuring that out... Pity

dr-orlovsky · 2025-02-03T18:18:51Z

demo.sh

    CONSIGNMENT="consignment_${TRANSFER_NUM}.rgb"
    PSBT=tx_${TRANSFER_NUM}.psbt
-    local sats=(--sats 2000)
+    local sats=()


We have a default value in sats for pay-to-address now

dr-orlovsky · 2025-02-03T18:20:29Z

demo.sh

+    # TODO: Re-enable with `rgbx` tool
+    # _trace "${RGB[@]}" -d "$send_data" inspect \
+    #     "$send_data/$CONSIGNMENT" "$CONSIGNMENT.yaml"
+    # _log "consignment exported to file: $CONSIGNMENT.yaml"


Inspection and other pro debug tasks has moved to a dedicated tool from rgb-std named rgbx. It will be good to install it alongside rgb, but this is too complex for my poor bash knowledge.

The reason is that rgb always has an internal runtime, which relies (and reads) on certain hardcoded directory structure, while rgbx allows to work with individual binary files without any runtime.

dr-orlovsky · 2025-02-03T18:21:31Z

demo.sh

-        _die "accept failed (transfer $TRANSFER_NUM)"
-    fi
-
    ## ending situation


No more consignment verification command; only accept.

The real reason is the fact that consignments now are streams parsed by runtime right into stash - and the stash is an abstract object which can't be cloned in memory. Thus, there is no such thing as a "dumb run": the consignment (if valid) will always get into the stash.

dr-orlovsky

A bit more of explanations

dr-orlovsky · 2025-04-30T15:35:58Z

demo.sh

+SATS=800 # TODO: This is required only for witness-out transfers. We need to account for it
+FEE=260


Without these changes we had non-deterministic failures since we run out of sats for transfers (at round 7 or 8)

dr-orlovsky · 2025-04-30T15:37:17Z

demo.sh


 # internal functions
-_check_method() {
+_check_wallet_type() {


Now opret and tapret is not a seal closing method but a type of a wallet

dr-orlovsky · 2025-04-30T15:37:56Z

demo.sh

    local wallet="$1"
-    local keychain="$2"
-    if [ -z "$keychain" ]; then
-        if [ "${WLT_CM_MAP[$wallet]}" = "opret1st" ]; then


no more RGB-specific keychains

dr-orlovsky · 2025-04-30T15:38:26Z

demo.sh

    local wallet="$1"
    local contract_name="$2"
    local sync="$3"
-    local contract_id iface schema wallet_id


iface and schema are now the same and provided in the YAML as codex_id

dr-orlovsky · 2025-04-30T15:39:10Z

demo.sh

    if [ "$subtit" = 0 ]; then
        _tit "checking $contract_name balance for $wallet"
-    else
+    elif [ "$subtit" = 1 ]; then


with 2 we suppress the printout completely

dr-orlovsky · 2025-04-30T15:40:43Z

demo.sh

    _subtit "issuing"
-    _trace "${RGB[@]}" -d "data${wallet_id}" issue -w "$wallet" \
-        "$schema_id" "ssi:$wallet" "$contract_yaml" >$TRACE_OUT 2>&1
+    _trace "${RGB[@]}" -d "data${wallet_id}" import issuers/*


We have a new concept of issuers which we need to import

dr-orlovsky · 2025-04-30T15:41:34Z

demo.sh

-            _trace "${RGB[@]}" -d "data${wallet_id}" interfaces -w "$wallet"
-        fi
-    fi
+    _trace "${RGB[@]}" -d "data${wallet_id}" init -q


A dedicated command to initialize persistence; -q makes it quiet if the persistence is already initialized

dr-orlovsky · 2025-04-30T15:42:02Z

demo.sh

-            _log "interfaces:"
-            _trace "${RGB[@]}" -d "data${wallet_id}" interfaces -w "$wallet"
-        fi
-    fi


Without schemata the things got much simpler

dr-orlovsky · 2025-04-30T15:42:36Z

demo.sh

    unset BLNC_RCPT BLNC_SEND RCPT_WLT SEND_WLT
 }

+transfer_aborted() {


We need to sync wallet in order to abort a transfer, to make wallet see that the tx is not in a mempool anymore.

dr-orlovsky · 2025-04-30T15:43:18Z

demo.sh

-    _trace "${RGB[@]}" -d "$send_data" transfer -w "$SEND_WLT" \
-        "${sats[@]}" "${fee[@]}" \
+    _trace "${RGB[@]}" -d "$send_data" pay -w "$SEND_WLT" \
+        "${sats[@]}" "${fee[@]}" --force \


--force is needed to overwrite consignment if it already exists (like in aborted transfers)

dr-orlovsky · 2025-04-30T15:48:26Z

All tests are passing against v0.12.0 beta 6

dr-orlovsky marked this pull request as draft January 7, 2025 16:24

dr-orlovsky force-pushed the v0.12 branch from e209c67 to e7129e1 Compare January 18, 2025 17:50

dr-orlovsky force-pushed the v0.12 branch from e7129e1 to a5a9c01 Compare February 1, 2025 14:14

refactor for v0.12

65db199

dr-orlovsky force-pushed the v0.12 branch from a5a9c01 to 65db199 Compare February 2, 2025 14:15

dr-orlovsky marked this pull request as ready for review February 2, 2025 14:16

dr-orlovsky changed the base branch from master to v0.11-beta.9 February 2, 2025 14:16

dr-orlovsky added 2 commits February 3, 2025 18:56

Debugging v0.12

e3708d3

hacks

85bae3e

dr-orlovsky force-pushed the v0.12 branch from 8ae7ce8 to 85bae3e Compare February 3, 2025 17:56

Fix for invoice command arguments

792c5d8

still not working...

dr-orlovsky commented Feb 3, 2025

View reviewed changes

dr-orlovsky added 9 commits February 5, 2025 20:24

solve invoicing and repeated run issues

54af911

fix check for consignment validation

62eda3d

enable rust backtracing

bb5c01f

wip: disable unworking tests

6d45232

add recompile argument

ea0f514

fix broadcast instruction args

b5cb26c

add dedicated flag for skipping final cleanup

4a47a2d

improvements and fixes

e35876c

add missed variable defaults (SATS and FEE)

54c4675

dr-orlovsky force-pushed the v0.12 branch from b771001 to 54c4675 Compare February 11, 2025 17:42

dr-orlovsky added 3 commits February 14, 2025 11:27

uncomment all tests. Update to new issuers

d0c42f2

fix typo

98ac85f

update to v0.12.0-beta.6 candidate

7f75273

dr-orlovsky force-pushed the v0.12 branch from f67f1f2 to 7f75273 Compare April 28, 2025 18:21

dr-orlovsky added 3 commits April 28, 2025 20:58

further v0.12.0-beta.6 adoption

fd67dff

increase SATS to prevent tests from non-deterministic failures

cee33b0

improve verbosiity; use new args

9f0e82b

do correct transfer aborting

7dda9d4

dr-orlovsky force-pushed the v0.12 branch from fe51ceb to 7dda9d4 Compare April 30, 2025 15:25

revert temporary debug changes

17fd9e2

dr-orlovsky commented Apr 30, 2025

View reviewed changes

chore: update to v0.12 RC2 pre-publication

e975b88

		CONTRACT_NAME_MAP["usdt"]=USDT
		CONTRACT_NAME_MAP["collectible"]=OtherToken

		_trace "${RGB[@]}" -d "$rcpt_data" invoice "$address_mode" \
		-w "$RCPT_WLT" "$contract_id" "$send_amt" >$TRACE_OUT

		SATS=800 # TODO: This is required only for witness-out transfers. We need to account for it
		FEE=260

Conversation

dr-orlovsky commented Jan 7, 2025

Uh oh!

dr-orlovsky commented Feb 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dr-orlovsky Feb 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dr-orlovsky left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dr-orlovsky commented Apr 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

dr-orlovsky Feb 5, 2025 •

edited

Loading

dr-orlovsky left a comment •

edited

Loading