-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreadme.txt
238 lines (174 loc) · 10.4 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
=== Brand Guard QR ===
Contributors: bakrypt
Donate link: https://bakrypt.io/pool/
Tags: NFT, Cardano, Blockchain, WooCommerce, Supply Chain
Requires at least: 6.0
Tested up to: 6.6.1
Stable tag: 1.3.8
Requires PHP: 7.4
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Brand Guard QR - Enhanced Product Identification
Generate dynamic product identification codes replacing traditional GTIN/UPC usage backed by the Cardano Blockchain.
== On-Demand Product Code Generation: ==
- Enjoy the benefits of a fully decentralized system, ensuring enhanced security and transparency.
- Seamless integration with Bakrypt's API for a user-friendly and quick implementation.
- Generate product codes as needed, eliminating the need for predetermined codes and providing flexibility for various scenarios.
- Significantly lower costs compared to traditional methods, with no annual renewals required.
- Data is stored on a public, immutable, and auditable blockchain, instilling confidence in data integrity.
== Blockchain-Enabled Anti-Counterfeit Certification: ==
- Leverage cutting-edge Blockchain Technology for a failsafe Proof of Authenticity through a Certificate of Origin.
- Ensure the legitimacy of your products by certifying them on the blockchain, safeguarding against counterfeiting.
== Enriched Customer Engagement: ==
- Elevate customer experience by providing additional product information through the generated identification codes.
- Strengthen brand engagement by offering customers a deeper understanding of the product's unique features, benefits, and origin.
== How does it work? ==
With this plugin, you can easily mint your existing or new products into collections of NFTs or Fungible tokens with just a few clicks. The system will automatically pick up metadata from your products, upload images to IPFS and generate a valid JSON structure. Bakrypt’s API will mint the object as a Cardano native token according to your preferences. Once the transaction is confirmed, the fingerprint of the minted NFT is linked to the product in your store. Once the fingerprint is set, you can also create QR codes of the fingerprint! Go to your products list, select your minted products and select “Create QR Codes” from the bulk actions dropdown.
Learn more 🚀 -> [Plugin's Docs](https://bakrypt.readme.io/reference/blockchain-tokenization-extension-for-woocommerce)
== Minting a Single Asset ==
1. Navigate to any product.
2. Locate the "Blockchain" tab within the product's data table.
3. Click on the "Get Started" button to mint the current product.
== Minting Multiple Assets ==
1. Go to the product list.
2. Select the desired products.
3. From the Bulk actions dropdown, choose "Mint as Tokens".
== Generating QR Codes ==
1. Go to the product list.
2. Select the desired products.
3. From the Bulk actions dropdown, choose "Create QR Codes".
== Shortcodes ==
Use the Asset Tracking shortcode anywhere in your website to include a public form that verifies an asset fingerprint with an existing product in your store.
[ bak_asset_tracking ]
== Demo ==
We've created a demo store with custom permissions so that you can try the plugin without having to install a new instance. Managers are allowed to view and edit products. The demo store is available at https://wp.bakrypt.io, and you can log in with the following credentials:
Login:
[https://wp.bakrypt.io/wp-admin](https://wp.bakrypt.io/wp-admin)
Username: manager
Password: manager
== Register with Bakrypt.io ==
We use Bakrypt's API to conveniently interact with the blockchain. Therefore, it's required to create an account in our platform.
* Create an account for mainnet:
- [Mainnet Bakrypt API](https://bakrypt.io/account/login/)
* Create an account for testnet.
- [Testnet Bakrypt API](https://testnet.bakrypt.io/account/login/)
== Github ==
This is an open-source development.
[https://github.com/Wolfy18/bakrypt-wc-extension](https://github.com/Wolfy18/bakrypt-wc-extension)
== Non-Fungible Tokens as a supply chain solution ==
Non-fungible tokens (NFTs) are digital assets that represent ownership of a unique item or concept. They are stored on a blockchain and can be bought, sold, and traded like any other asset.
One potential use case for NFTs within a supply chain is to track the ownership and movement of goods as they pass through various stages of production, distribution, and sale. For example, an NFT could be created for each batch of raw materials that enter a manufacturing facility, and then updated with information about where those materials were used and what products they were used to create. This could help companies track the origin and history of their products, and make it easier to trace them back to their source in the event of a recall or other issue.
NFTs could also be used to verify the authenticity of products, by linking them to a unique digital asset that represents the product's provenance. This could be particularly useful for high-value items such as luxury goods or art, where counterfeiting is a concern.
Overall, the use of NFTs in a supply chain could help companies improve transparency, traceability, and authenticity, which could in turn enhance customer trust and loyalty.
== Cardano Blockchain ==
Cardano is a decentralized public blockchain and cryptocurrency project that is focused on providing a secure and scalable platform for the creation and use of non-fungible tokens (NFTs).
**Bakrypt Docs**
- [Getting started with our API](https://bakrypt.readme.io/reference/getting-started-with-your-api)
- [Swagger Environment](https://bakrypt.io/docs/)
== Installation ==
**WooCommerce is required**
1. In your WordPress dashboard, choose Plugins > Add new.
2. Search for our plugin with the search bar in the top right corner.
3. After finding the plugin in the results, click Install Now. You can also click the plugin name to view more details about it.
4. To use the plugin, you'll need to activate it. When the installation is finished (this usually takes a couple of seconds), click Activate.
**WooCommerce Blockchain Settings**
1. In your WooCommerce Settings, find the "Blockchain" tab to setup your credentials.
2. Set your Token from your Bakrypt's account.
3. Save Changes!
*Testnet Credentials (Optional):*
4. Set your token from your Bakrypt's *testnet* account.
5. Activate the "testnet" checkbox. This will send all requests towards the testnet network.
6. Save Changes!
== Frequently Asked Questions ==
= Is it easy to use? =
Using a WordPress plugin to mint NFTs can make the process of creating and managing NFTs more accessible to users who may not have technical expertise in blockchain or coding.
= Can I integrate it to my existing shop? =
This plugin allows users to mint and manage NFTs within their existing WordPress website, rather than having to set up a separate platform or interface. This can be more convenient for users who already have a presence on WordPress.
= Is this solution scalable? =
WooCommerce is a scalable platform that can handle a large volume of traffic and transactions, making it suitable for stores of all sizes.
== Screenshots ==
1. Blockchain Settings Section.
2. Product List filtered by tokenized products.
3. Product Tokenization Minting process.
4. Product Tokenization Invoice.
5. Product Tokenization Invoice Status.
6. Cart with tokenized product. It includes the asset fingerprint.
7. Order view that includes tokenized products. It includes asset fingerprints for each product.
8. Email view that includes a tokenized product.
9. Tokenized Product View Blockchain Section
10. New Product View Blockchain Section
11. Mint products in bulks from the product list view
12. Bakrypt launchpad view with multiple assets/products
13. Asset Tracking page sample. This page uses the shortcode [bak_asset_tracking]
14. Found asset using the asset tracker
15. Blockchain tab in the product detail page
16. Asset Tracking shortcode in post edit view
== Changelog ==
= 1.3.8 =
* feat: updated wordpress scripts
* feat: changed package manager to pnpm
* fix: fixed javascript library bug
= 1.3.7 =
* feat: upgraded BakBridge to version 0.5.4
* feat: updated readme.txt
* feat: modal height is now dynamic
= 1.3.6 =
* feat: upgraded BakBridge to version 2
* feat: updated banners
* feat: updated readme.txt
= 1.3.5 =
* fix: fixed typo
* fix: upgraded bakrypt launchpad version
* chore: updated readme files
= 1.3.4 =
* fix: Fixed bug related to the woocommerce tabs in the product detail page
* feat: Added Asset Tracking Shortcode
* feat: Added images related to asset tracking
= 1.3.3 =
* feat: QR CODES generator from product fingerprint
* feat: Added product list endpoint
= 1.3.2 =
* feat: added token authentication schema
* feat: updated woocommerce blockchain settings to use Token authentication
= 1.2.2 =
* feat: updated README documentation.
= 1.2.1 =
* chore: shaked tree to removed unused code
* feat: update js file to properly render components with react 18
* feat: added wp global settings that includes the nonce and the root URL API
* fix: removed jQuery related code to fetch data
* feat: added IPFS related endpoints
* feat: added endpoint to fetch access tokens from Bakrypt API
* feat: added functions to get, update and mint products in bulks
* feat: added functions to get and update the product details via REST
* feat: added rest routes, authentication and authorization functionality
= 1.1.6 =
* Fixed bug related to shipping line item
= 1.1.5 =
* Added function that includes fingerprint for variable products
* Added hook to include fingeprint to order metadata
= 1.1.4 =
* Commented out logic that uploads image on every update
* Updated issue when updating product in cron task
= 1.1.3 =
* Added transaction status to the token column if the token hasn't been minted yet
* Fixed logic when prepping data when minting a list of tokens.
* Added logic to save the IPFS value to the attachment once it's uploaded.
* Added function to delete transient when plugin is deactivated.
* Modified query to fix issue with maximum execution time of the cron job.
* Modified the transactionModal to accept config variables as parameters
* Fixed issue authorization issue when submitting a refund.
= 1.1.2 =
* Checks if cron are scheduled before starting a new one.
* Adds cron lock file logic.
= 1.1.1 =
* Fixes product list filter
* Fixes Product List fingerprint column size
* Fixes cron query. Rejected transaction were picked up by the cron task.
= 1.0 =
* Version 1.
= 0.1 =
* Beta version.
== Upgrade Notice ==
= 0.1 =
This is our beta version to start testing the water.