Testing_Guide.md

Testing Guide for Tuxedo dApp

Prerequisites

Make sure you have Rust, Node.js and Yarn installed on your system.

Build environment used

• Rust: 1.77.2 (last test 1.78.0)

• Node.js: 22.3.0 (last test 22.7)

• yarn: 1.22.22

Clone and run the Tuxedo Node

Open your terminal.

Run the following command to clone the Tuxedo repo on the main branch:

git clone https://github.com/mlabs-haskell/Tuxedo.git

Build and Run the Node

Navigate to the cloned Tuxedo repo directory:

cd Tuxedo

Build the node using Cargo:

cargo build --release -p node-template

Run the node in dev mode:

./target/release/node-template --dev

Build and run the Webservice:

On a separate terminal, navigate to the webservice-wallet folder within the Tuxedo repo:

cd webservice-wallet

Build the webservice using Cargo:

cargo build

Run the webservice:

cargo run

Running the dApp

Open a new terminal window. Clone the dApp repo:

git clone https://github.com/mlabs-haskell/TuxedoDapp.git

Navigate to the cloned dApp directory:

cd TuxedoDapp

Install the dependencies using Yarn:

yarn install

Start the dApp locally:

yarn start

You should now have the Tuxedo node running in dev mode, the webservice running, and the dApp running locally. You can test out the functionality of the dApp and interact with the Tuxedo blockchain.

Testing the dApp functionality

1. Fetch the local keys by running:

curl --location 'http://localhost:3000/debug-get-keys'

2. Make a POST request to http://localhost:3000/debug-generate-key to generate a key in the local keystore in the wallet-cli

curl --location 'http://localhost:3000/debug-generate-key' \
--header 'Content-Type: application/json' \
--data '{
  "password": ""
}'

Sample output:

{"message":"Keys generated successfully","public_key":"4875f18ce60479b935b257b2cfe17a03432f80af93b368f4653f2381fded9674","phrase":"convince defy athlete buyer truly inside inmate pool foil noodle barely supreme"}

3. Make a request by debug-get-key again by running:

curl --location 'http://localhost:3000/debug-get-keys'

4. Copy the phrase from the output of the command above and import it to Talisman (Settings -> Account -> Add New Account -> Import -> Import via Recovery Phrase -> Polkadot)

Note: You need at least another wallet for the trading process, so reproduce the previous steps again.

5. Access the DApp on http://localhost:3006/ on Windows to test out the available dapp features. The port can also be customized by modifying the package.json file. Make sure that it's running on a different port than 3000, because the webservice is running on 3000:

6. Creation of the genesis parent kitties via APIs:

• Create the male parent, make sure to replace the owner_public_key with the public key copied at the previous step (step 3):

curl --location 'http://localhost:3000/post-create-kitty' \
--header 'Content-Type: application/json' \
--data '{
  "name": "kit1",
  "owner_public_key": "4875f18ce60479b935b257b2cfe17a03432f80af93b368f4653f2381fded9674",
  "gender": "Male"
}'

• Create the female parent:

curl --location 'http://localhost:3000/post-create-kitty' \
--header 'Content-Type: application/json' \
--data '{
  "name": "kit2",
  "owner_public_key": "4875f18ce60479b935b257b2cfe17a03432f80af93b368f4653f2381fded9674",
  "gender": "Female"
}'

Note: For the name of the kitty it is mandatory to use 4 characters

7. Search displays all the available kitties in each wallet

8. My Kitties displays the available kitties of the user's wallet

Fetching owned kitties under /my-kitties page

Note: The Kitties for sale are not displayed

9. Breed generates a new kitty by specifying male and female parent kitties

• The /breed page displays the parents as dropdowns
• Enter a 4 letter kitty name to breed the child kitty
• On submission, the talisman should open up to sign the transaction

10. Update the kitty's properties (name, price, for sale) using the Search page, by clicking on the owned kitty

11. Buy now button will appear in the kitty page details of a listed kitty from another wallet, use it to change the kitty's ownership

To test this functionality, you'll need two keys, one for the seller and one for the buyer. For the seller, you can follow these steps:

• Create an initial kitty by calling the API by specifying yourself as the owner. See the command on the breeding section

• Go to kitty details, mark a kitty for sale using the radio button enter the price and click on Update

For the buyer, we'll need to mint some tokens, the process can be as follows:

• If not done yet, generate a new key (following step 2) and add it to Talisman as the "Buyer"

• Mint enough coins for the buyer. The amount parameter should be more than the kitty price and the owner_public_key will need to be fetched by calling debug-get-key as done with the seller public key from the previous steps

Note: The change does not return to the wallet. Every time you purchase a kitty, you have to mint coins.

curl --location 'http://localhost:3000/post-mint-coin' \
--header 'Content-Type: application/json' \
--data '{
  "owner_public_key": "4050f574baa3c9af13b264560925e98d0750cb428b8f97562225a26a7fecd178",
  "amount": 200
}'

• Connect to the site as the buyer's wallet through Talisman.

• Go to the details page for the kitten that was listed and you should see the option to "Buy"

• Once you click on "Buy", you'll be able to select the coins minted previously.

• Select it and click on "Proceed"

• Go to kitty details and you will see that you are the owner of the kitty as you have the option to Update and Breed

Note: As mentioned to see the kitty in "My Kitties" it must be set as not for sell

Running wallet cli tests

Run cargo test inside the webservice-wallet directory. Two tests might fail on the first run due to the initial state of the local blockchain, but should succeed on the subsequent runs:

Finished test [unoptimized + debuginfo] target(s) in 0.48s

Running unittests src/main.rs (/Users/philoniare/mlabs/Tuxedo/target/debug/deps/tuxedo_template_web_service_wallet-2207457bac4dda0f)

  

running 30 tests

test output_filter::tests::filter_prints ... ok

test output_filter::tests::filter_sr25519_signature_works ... ok

test service_handlers::block_handler::block_service_handler::tests::test_get_block_block_number_not_present_fail ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_create_kitty ... ok

test service_handlers::block_handler::block_service_handler::tests::test_get_block_success ... ok

test service_handlers::block_handler::block_service_handler::tests::test_get_genesis_block_success ... ok

test service_handlers::key_handler::key_service_handler::tests::test_debug_get_keys_success ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_create_kitty_fail_due_unknown_public_key ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_create_kitty_fail_due_inavlid_public_key ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_create_kitty_success ... ok

test service_handlers::key_handler::key_service_handler::tests::test_debug_generate_key_success ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_get_all_kitty_list ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_get_owned_kitty_list ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_get_kitty_by_dna ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_breed_kitty ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_get_txn_and_inpututxolist_for_list_kitty_for_sale_success ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_name_update ... ok

test service_handlers::money_handler::money_servicehandler::tests::test_mint_coin_fail_due_inavlid_public_key ... ok

test service_handlers::money_handler::money_servicehandler::tests::test_mint_coin_fail_due_unknown_public_key ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_list_kitty_for_sale ... ok

test service_handlers::money_handler::money_servicehandler::tests::test_mint_coin_success ... ok

test service_handlers::money_handler::money_servicehandler::tests::test_get_all_coins ... ok

test service_handlers::money_handler::money_servicehandler::tests::test_owned_coins ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_get_all_td_kitty_list ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_get_td_kitty_by_dna ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_get_owned_td_kitty_list ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_delist_kitty_from_sale ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_buy_kitty ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_td_name_update ... ok

test service_handlers::kitty_handler::kitty_service_handler::tests::test_td_price_update ... ok



test result: ok. 30 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 16.85s

Troubleshooting

In case of this error

Failed to init db: Node reports a different genesis block than wallet.

but also in case of generic breeding issues after price inputting, please follow these steps:

cd /tmp/tuxedo-wallet/

rm -rf wallet_database

The issue arises because the web service saves all blocks, including the initial genesis block, in its local storage. Restarting the web service from scratch creates a new genesis block, which then causes a discrepancy. Clearing the local DB solves the issue.

Further wallet interactions via CLI (without web interface)

https://github.com/mlabs-haskell/Tuxedo/tree/main/webservice-wallet#readme