Skip to content

Commit 7fbfe2e

Browse files
wip
1 parent 642a85f commit 7fbfe2e

9 files changed

Lines changed: 48 additions & 48 deletions

File tree

docs/buyer-side/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ The Boson Protocol dApp is currently deployed to Polygon MATIC network, so you n
2222

2323
Browse available products by clicking the Explore Products link in the navigation bar. You can search for keywords in the listing, filter by seller and sort by price or other conditions.
2424

25-
![Connect](/assets/buyer_1.png)
25+
![Connect](./assets/buyer_1.png)
2626

2727
### Step 1 - Buying an item by committing to it <a href="#step-1---buying-an-item-by-committing-to-it" id="step-1---buying-an-item-by-committing-to-it"></a>
2828

2929
Once you have found the item you want, you can buy it by clicking on the `Commit` button. Remember this is the first step of the buyer's experience - when committing, you pay for the item by transferring the item price into escrow and in turn receive a redeemable NFT (rNFT) that can later be exchanged for the real-world item it represents.
3030

31-
![Commit](/assets/buyer-1commit.png)
31+
![Commit](./assets/buyer-1commit.png)
3232

3333
Next, you will see the confirmation screen and options to either view your item (and immediately redeem it if you want) or discover more items.
3434

@@ -38,7 +38,7 @@ Note that if the item is token-gated, you will need to unlock that gate by ownin
3838

3939
If not done before, now is the time to connect your wallet to the dApp. Read the message when connecting and allow your wallet to switch to the correct Polygon network before proceeding.
4040

41-
![Commit](/assets/buyer_2.jpg)
41+
![Commit](./assets/buyer_2.jpg)
4242

4343
After Commit, you can now simply hold the rNFT and store it as a claim on the physical item, you can transfer it to someone else, perhaps as a gif, or you can trade your rNFT on the secondary market, such as OpenSea.
4444

@@ -48,34 +48,34 @@ The product listing displays a redemption period during which your rNFT is valid
4848

4949
When you are ready to take possession of the physical (or phygital) item, go back to the dApp to redeem your rNFT. The rNFT will be burned in the process.
5050

51-
![Redeem](/assets/buyer-2redeem.png)
51+
![Redeem](./assets/buyer-2redeem.png)
5252

5353
When you click `Redeem`, you will see an overlay detailing the fair exchange policy before you can click `Next` to proceed.
5454

55-
![Initialise XMTP](/assets/buyer_5.png)
55+
![Initialise XMTP](./assets/buyer_5.png)
5656

5757
> Alternatively, you can `Cancel` the purchase, which means that you will receive the refund, deducted by the potential buyer penalty set by the seller. You can also `Contact seller` directly, through the communication channel that seller prepared, e.g. via an encrypted XMTP chat session.
5858
5959
You need to enter your address in order to redeem your purchase. Unlike when you buy something on a Web 2.0 commerce site, your address is not stored in a centralized database. Instead, you are sharing your details only with the seller of the item you have purchased.
6060

61-
![Address confirmation](/assets/buyer_6.png)
61+
![Address confirmation](./assets/buyer_6.png)
6262

6363
In order to facilitate sharing your address with the seller, you need to initialize a chat session with XMTP, which is a Web3 communication tool. Click the Initialize button in the overlay and you will be prompted to sign a transaction in your wallet to indicate that you are happy to communicate via XMTP.
6464

65-
![Address confirmation](/assets/buyer_7.png)
65+
![Address confirmation](./assets/buyer_7.png)
6666

6767
The next screen is a confirmation screen to ensure you are happy with how you have entered your address and to tell you that you have initialized your chat client.
6868

6969
You will again see a warning message that your rNFT will be burned on redemption.
7070

71-
![Redemption warning](/assets/buyer_9.png)
71+
![Redemption warning](./assets/buyer_9.png)
7272

7373
Once you are happy with all of this, confirm the transaction in your wallet and the redemption step is complete.
7474

7575
Finally, you will be shown the confirmation overlay letting you know that your redemption is complete.
7676

77-
![Redemption confirmed](/assets/buyer_10.png)
77+
![Redemption confirmed](./assets/buyer_10.png)
7878

7979
You will notice that the item you have purchased now no longer has the Redeem option available. If you need to contact the seller or raise a dispute, you can do so via the item page, which you will find in My Items, with a 'Redeemed' tag showing.
8080

81-
![Redemption confirmed](/assets/buyer_11.png)
81+
![Redemption confirmed](./assets/buyer_11.png)

docs/seller-side/boson-for-woocommerce.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Then, install the Boson extension like so:
4141
* Go to: `WordPress Admin` > `Plugins` > `Add New` to upload the file you downloaded with `Choose File`.
4242
* Activate the extension.
4343

44-
![Activate the plugin](/assets/woo-redeem-plugin/woo-redeem-plugin-0activate-3c968f20d77473a966b0fc6fb820897b.png)
44+
![Activate the plugin](./assets/woo-redeem-plugin/woo-redeem-plugin-0activate-3c968f20d77473a966b0fc6fb820897b.png)
4545

4646
> Note: If the extension is already installed and you are trying to update it, you will be asked to confirm if you want to replace the installed version with the new one found in the uploaded .zip file. In that case, proceed.
4747
@@ -53,19 +53,19 @@ After activating the plugin, we need to link the account used on Boson Protocol.
5353

5454
(1) Go to: `WooCommerce` > `Boson for WooCommerce`. (2) Select `Connect Account` if you already have a Boson seller profile, otherwise, click on `Create Account` to create one.
5555

56-
![Connect account](/assets/woo-redeem-plugin/woo-redeem-plugin-1connect.png)
56+
![Connect account](./assets/woo-redeem-plugin/woo-redeem-plugin-1connect.png)
5757

5858
(3) Select a Web3 Client and connect your wallet.
5959

60-
![Select Web3 provider](/assets/woo-redeem-plugin/woo-redeem-plugin-2wallet_select.png)
60+
![Select Web3 provider](./assets/woo-redeem-plugin/woo-redeem-plugin-2wallet_select.png)
6161

6262
(4) You'll see the connected wallet address, and the plugin will check the validity of your seller account with Boson Protocol on-chain. Click `Proceed` if the displayed wallet address is as expected, or connect a different wallet and repeat the above step.
6363

64-
![Confirm address](/assets/woo-redeem-plugin/woo-redeem-plugin-3wallet_confirm.png)
64+
![Confirm address](./assets/woo-redeem-plugin/woo-redeem-plugin-3wallet_confirm.png)
6565

6666
(5) Clicking `Proceed` will prompt you to sign a message through your Web3 client. This message will be used to secure the integration of the Boson Redemption Widget to the particular domain of your website.
6767

68-
![Sign origin](/assets/woo-redeem-plugin/woo-redeem-plugin-4wallet_sign.png)
68+
![Sign origin](./assets/woo-redeem-plugin/woo-redeem-plugin-4wallet_sign.png)
6969

7070
(6) Once your connected wallet address is identified as a registered Boson seller, the extension is ready for use!
7171

@@ -77,7 +77,7 @@ The Redemption page is where your customers will be able to redeem their rNFTs t
7777

7878
This is the page that should include the block (or shortcode) offered by the extension for rendering the Boson Redemption Widget. Your customers will be able to connect their wallet and redeem their rNFTs through that page or even raise disputes for their already redeemed rNFTs. The extension offers an option to create a very basic redemption page for you by clicking the `Create Redemption Page` button, which you will be able to customize if you wish to!
7979

80-
![Create redemption page](/assets/woo-redeem-plugin/woo-redeem-plugin-5redeem_page.png)
80+
![Create redemption page](./assets/woo-redeem-plugin/woo-redeem-plugin-5redeem_page.png)
8181

8282
The extension offers two blocks to render the redemption widget:
8383

@@ -104,14 +104,14 @@ Once the Redemption page is created, you will also be able to find it under the
104104

105105
You can specify the shipping method that will be used for all Boson orders. The shipping method, regardless of its registered cost, will be attached to the order at 0 cost for the customer. Third party integration with shipping (if applicable), will be able to pick up the registered shipping method from each Boson order.
106106

107-
![Shipping configuration](/assets/woo-redeem-plugin/woo-redeem-plugin-6shipping.png)
107+
![Shipping configuration](./assets/woo-redeem-plugin/woo-redeem-plugin-6shipping.png)
108108

109109
### Synchronizing data <a href="#synchronizing-data" id="synchronizing-data"></a>
110110

111111
Once the seller's Boson profile is linked to WooCommerce, the data will start synchronizing between Boson Protocol and Boson for WooCommerce plugin.
112112

113113
The data that is synchronized includes products, buyer redemptions and any potential disputes raised. The sync task runs every 30 minutes, but can also be run manually on demand.
114114

115-
![Synchronization](/assets/woo-redeem-plugin/woo-redeem-plugin-7sync.png)
115+
![Synchronization](./assets/woo-redeem-plugin/woo-redeem-plugin-7sync.png)
116116

117117
> Note: If the buyer redeems an rNFT outside the WooCommerce plugin, a warning is displayed that this order should be managed elsewhere, i.e. via the Boson dApp. This is needed because the delivery information and other buyer-seller communication must have happened outsite Boson for WooCommerce plugin, so the plugin has no way of accessing that data.

docs/seller-side/selling-on-the-dapp/creating-a-product.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ nav_order: 4
99

1010
### The first decentralized marketplace built on Boson Protocol allows you to tokenize, trade or transfer any physical item as an NFT <a href="#the-first-decentralized-marketplace-built-on-boson-protocol-allows-you-to-tokenize-trade-or-transfer" id="the-first-decentralized-marketplace-built-on-boson-protocol-allows-you-to-tokenize-trade-or-transfer"></a>
1111

12-
![Sell Physicals](/assets/seller_list1.png)
12+
![Sell Physicals](./assets/seller_list1.png)
1313

1414
In this tutorial you will learn how to create a product and offer it for sale on the Boson decentralized application (dApp).
1515

@@ -23,13 +23,13 @@ By now, you should have already created a seller profile and have the wallet con
2323

2424
To continue, click on the `Create Products` button at the top right.
2525

26-
![Create Products](/assets/seller-create-product/seller-create-product-1button.png)
26+
![Create Products](./assets/seller-create-product/seller-create-product-1button.png)
2727

2828
#### Select the product type <a href="#select-the-product-type" id="select-the-product-type"></a>
2929

3030
You will be presented to choose the type and variants of the product. The column to the right provides explanation of various options and their meaning.
3131

32-
![Product type](/assets/seller-create-product/seller-create-product-2type.png)
32+
![Product type](./assets/seller-create-product/seller-create-product-2type.png)
3333

3434
Click `Next` when you are ready to move on. For simplicity, we'll now asume that we selected a Physical and One item type.
3535

@@ -39,7 +39,7 @@ Describe the product to buyers using the title and description fields.
3939

4040
Tell them about its unique features, or why you are selling it. The goal is to tell them why they might want to buy it. As with selling on any other marketplace, you should aim to provide clear, factual information about the product, for example, the fabric composition or - if you are listing a vintage collectible - the exact condition of the item.
4141

42-
![Product description](/assets/seller-create-product/seller-create-product-3info.png)
42+
![Product description](./assets/seller-create-product/seller-create-product-3info.png)
4343

4444
Categories will be helpful to focus search results, so it’s best to select an existing category if appropriate. If it is truly unique, you can create your own category by filling in the "other" category field. Select a category using the dropdown menu.
4545

@@ -53,7 +53,7 @@ Optionally, you can provide additional information about the product that is com
5353

5454
Larger-scale merchants who have multiple items for sale will find this section invaluable for entering inventory information and other identifiers for products.
5555

56-
![Additional information](/assets/seller-create-product/seller-create-product-4additional.png)
56+
![Additional information](./assets/seller-create-product/seller-create-product-4additional.png)
5757

5858
Click `Next` to proceed.
5959

@@ -65,7 +65,7 @@ You can also add an MP4 video for the extra punch! Animated gifs also work.
6565

6666
When you are happy with your picture selection, click `Next`.
6767

68-
![Product Images](/assets/seller-create-product/seller-create-product-5images.png)
68+
![Product Images](./assets/seller-create-product/seller-create-product-5images.png)
6969

7070
### Core Terms of Sale <a href="#core-terms-of-sale" id="core-terms-of-sale"></a>
7171

@@ -77,7 +77,7 @@ Offer validity period is the interval during which purchasing the product's rNFT
7777

7878
The redemption period is the time during which the buyer can trade their rNFT. Generally, the longer the redemption period, the better, as this means the buyer will be able to benefit from the option to trade it on secondary markets. However, only make this period as long as you are able to deliver the underlying product.
7979

80-
![Core Terms of Sale](/assets/seller-create-product/seller-create-product-6coreterms.png)
80+
![Core Terms of Sale](./assets/seller-create-product/seller-create-product-6coreterms.png)
8181

8282
#### Token gated offers <a href="#token-gated-offers" id="token-gated-offers"></a>
8383

@@ -102,25 +102,25 @@ Dispute resolver is the entity that is chosen for jumping in when the seller and
102102

103103
The dispute period is a minimum of 30 days after redeeming the rNFT.
104104

105-
![Terms of Exchange](/assets/seller-create-product/seller-create-product-8terms-exchange.png)
105+
![Terms of Exchange](./assets/seller-create-product/seller-create-product-8terms-exchange.png)
106106

107107
Click `Next` to proceed.
108108

109109
#### Shipping Info <a href="#shipping-info" id="shipping-info"></a>
110110

111111
On this screen, define the regions you are prepared to ship to, along with the expected delivery time and acceptable return period in days.
112112

113-
![Shipping Info](/assets/seller-create-product/seller-create-product-9shipping.png)
113+
![Shipping Info](./assets/seller-create-product/seller-create-product-9shipping.png)
114114

115115
You may optionally wish to add values for parcel measurements and weight, as well as a url to the redemption point (this is set by default to the Boson dApp).
116116

117-
![Additional information](/assets/seller-create-product/seller-create-product-90additional.png)
117+
![Additional information](./assets/seller-create-product/seller-create-product-90additional.png)
118118

119119
### Confirm Product Details <a href="#confirm-product-details" id="confirm-product-details"></a>
120120

121121
This is where you get the opportunity to review and confirm everything you have entered so far.
122122

123-
![Initializing chat client](/assets/seller-create-product/seller-create-product-91init-chat.png)
123+
![Initializing chat client](./assets/seller-create-product/seller-create-product-91init-chat.png)
124124

125125
Preview your product data and terms of sale. You can move between screens using the breadcrumb menu at the top.
126126

@@ -134,4 +134,4 @@ This is it! You can preview the final page by clicking the `Preview product deta
134134

135135
Once the transaction is processed, a popup will appear notifying you of the created product. You can inspect its details or continue creating more.
136136

137-
![Overview of new product](/assets/seller-create-product/seller-create-product-92finish.png)
137+
![Overview of new product](./assets/seller-create-product/seller-create-product-92finish.png)

docs/seller-side/selling-on-the-dapp/profile-creation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ nav_order: 2
1111

1212
The first thing to be done for selling on the Boson marketplace dApp is creating an account - and if you have a Lens profile, you can use it, too! Simply click on `Sell on Boson` button to get started.
1313

14-
![Creating a Seller profile](/assets/seller-create-profile/seller-create-profile.png)
14+
![Creating a Seller profile](./assets/seller-create-profile/seller-create-profile.png)
1515

1616
#### What is a Lens profile and what are its benefits? <a href="#what-is-a-lens-profile-and-what-are-its-benefits" id="what-is-a-lens-profile-and-what-are-its-benefits"></a>
1717

@@ -39,10 +39,10 @@ You can optionally specify the percentage amount for secondary royalties that yo
3939

4040
Note that royalties percentage cannot be changed later.
4141

42-
![Setting royalties](/assets/seller-create-profile/seller-create-profile-royalties.png)
42+
![Setting royalties](./assets/seller-create-profile/seller-create-profile-royalties.png)
4343

4444
#### Confirm profile creation <a href="#confirm-profile-creation" id="confirm-profile-creation"></a>
4545

4646
As a final step, you have an option to check all the data and finally to confirm it by clicking on `Create Seller Account`. This invokes a signature request in your wallet which you need to confirm to proceed.
4747

48-
![Confirm profile](/assets/seller-create-profile/seller-create-profile-zconfirm.png)
48+
![Confirm profile](./assets/seller-create-profile/seller-create-profile-zconfirm.png)

docs/seller-side/selling-on-the-dapp/storefront-creation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ Setting up a storefront is free, and allows you to display your own products and
1515

1616
Navigate to `Templates & Guides` in the footer of the dApp and click on `Set-up a Web3 commerce store`.
1717

18-
![Quick start templates](/assets/seller-storefront/seller-storefront-1sell.png)
18+
![Quick start templates](./assets/seller-storefront/seller-storefront-1sell.png)
1919

2020
You will see a step-plan of actions. To proceed click on `Get started!` button.
2121

22-
![Creating Store steps](/assets/seller-storefront/seller-storefront-2breadcrumb.png)
22+
![Creating Store steps](./assets/seller-storefront/seller-storefront-2breadcrumb.png)
2323

2424
A two-column screen appears - on the left side you can customize the storefront, on the right side you can see updates in real time.
2525

26-
![Create Custom Store](/assets/seller-storefront/seller-storefront-3creation.png)
26+
![Create Custom Store](./assets/seller-storefront/seller-storefront-3creation.png)
2727

2828
First of all, name your store. The first field should contain the name that is shown in the browser tab when people navigate to your store. This can be the same as, or different from, the Title, which is the headline displayed on your storefront.
2929

@@ -49,7 +49,7 @@ Once you hit `Create`, your very own store is ready!
4949

5050
You will be presented with further options to make it friendlier.
5151

52-
<figure><img src="/assets/seller-storefront/seller-storefront-4url.png" alt=""><figcaption></figcaption></figure>
52+
<figure><img src="./assets/seller-storefront/seller-storefront-4url.png" alt=""><figcaption></figcaption></figure>
5353

5454
You will receive an IPFS link to your storefront (example, “[https://bosonprotocol.infura-ipfs.io/ipfs/QmQcbJVmZSM4MGuBZBexRUVM1TdwBX4hfWzoHJwPFhNK3E](https://bosonprotocol.infura-ipfs.io/ipfs/QmQcbJVmZSM4MGuBZBexRUVM1TdwBX4hfWzoHJwPFhNK3E)…”). We recommend that you have an ENS domain ready to hide that IPFS link behind a friendlier name. You could even create a subdomain from your current ENS (example, store.myname.eth).
5555

docs/seller-side/selling-on-the-dapp/token-gated-commerce.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ ERC721 token type can be used in two ways. You can gate it at contract level to
2626

2727
ERC1155 token type requires an exact **Token ID** to be specified, along with other required fields, as it is a more complex token contract.
2828

29-
![Token gated offer](/assets/seller-create-product/seller-create-product-7gating.png)
29+
![Token gated offer](./assets/seller-create-product/seller-create-product-7gating.png)
3030

3131
### Buying token-gated products <a href="#buying-token-gated-products" id="buying-token-gated-products"></a>
3232

3333
When a product is locked behind a gate, a "lock" icon is displayed over the image, making it easy to see which products are exclusive offers.
3434

35-
![Token gated product](/assets/seller-create-product/seller-create-product-7gating-tile.png)
35+
![Token gated product](./assets/seller-create-product/seller-create-product-7gating-tile.png)
3636

3737
On the product detail page, more information about the gate is presented, such as the amount of tokens needed and the address of the token contract. If the buyer doesn't have the required token balance and/or ID to unlock the product, purchasing is not possible and this is actually enforced on-chain!
3838

39-
![Token gated product details](/assets/seller-create-product/seller-create-product-7gating-details.png)
39+
![Token gated product details](./assets/seller-create-product/seller-create-product-7gating-details.png)

0 commit comments

Comments
 (0)