You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 12, 2024. It is now read-only.
* Upgrade MDX to be compliant with v3
* Checked with npx docusaurus-mdx-checker as in migration guide https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3
* Add .nvmrc and README notes to ensure we have a good node version for Docusaurus 3
* Upgrade to React 18.2.0
* Update ChatGPT feature to be #ask
* Fix bulleted list in MDX
Copy file name to clipboardExpand all lines: site/docs/glossary.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
An agent is software that acts on behalf of a user to manage identity, public or private data, and interactions with other apps in a decentralized network. Agents hold a user's [DIDs](#decentralized-identifier-did), private keys, and a [DWN](#decentralized-web-node-dwn), and are permissioned to use the private keys of DIDs to act on a user's behalf to sign and store messages within a DWN.
6
6
7
-
[<< More on Agents >>](/docs/web5/learn/agents)
7
+
[\<\< More on Agents \>\>](/docs/web5/learn/agents)
8
8
9
9
## Centralized Authority
10
10
@@ -14,19 +14,19 @@ A single entity or organization that has control over the network and its operat
14
14
15
15
A Decentralized Identifier (DID) is a globally unique identifier that enables verifiable, decentralized digital identity, without the need for centralized intermediaries. DIDs are typically implemented using decentralized and distributed ledger technologies, such as blockchain, and provide a way to verify and authenticate digital identities, while ensuring privacy and control over personal data.
16
16
17
-
[<< More on DIDs >>](/docs/web5/learn/decentralized-identifiers/)
17
+
[\<\< More on DIDs \>\>](/docs/web5/learn/decentralized-identifiers/)
18
18
19
19
## Decentralized Web Node (DWN)
20
20
21
21
A Decentralized Web Node is a personal data store in a decentralized network that stores and shares information, serves as a communication channel, and executes transactions in a distributed manner, without relying on a centralized server, thereby enhancing security, privacy, and resilience of the network.
22
22
23
-
[<< More on DWNs >>](/docs/web5/learn/decentralized-web-nodes)
23
+
[\<\< More on DWNs \>\>](/docs/web5/learn/decentralized-web-nodes)
24
24
25
25
## DID Document
26
26
27
27
A JSON document containing details about a DID, including the DID itself, represented by an `id` field, as well as other data related to the verification and authentication methods of the DID.
28
28
29
-
[<< More on DID Documents >>](/docs/web5/learn/did_document)
29
+
[\<\< More on DID Documents \>\>](/docs/web5/learn/did_document)
30
30
31
31
## DID Method
32
32
@@ -67,4 +67,4 @@ SSI refers to a concept where individuals have full control and ownership over t
67
67
68
68
A Verifiable Presentation is a standard data container that serves as an authenticated wrapper around a set of credentials to be verified. They impose no constraints on who can construct them or what may be presented, allowing you to present multiple VCs issued to different DIDs.
69
69
70
-
[<< More on Verifiable Presentation >>](/docs/web5/build/verifiable-credentials/presentation-exchange/#verifiable-presentation)
70
+
[\<\< More on Verifiable Presentation \>\>](/docs/web5/build/verifiable-credentials/presentation-exchange/#verifiable-presentation)
Copy file name to clipboardExpand all lines: site/docs/tbdex/issuer/vc-issuance.mdx
+7-13Lines changed: 7 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,21 +23,15 @@ If you need to create a Credential Issuance app from scratch, continue on with t
23
23
24
24
<LanguageSwitchBlock>
25
25
<divlanguage="Kotlin">
26
-
<p>
27
-
- Create a web server using <ahref="https://www.jetbrains.com/help/idea/ktor.html#run_ktor_app">Ktor</a> that will serve as an API endpoint.
28
-
</p>
26
+
* Create a web server using <ahref="https://www.jetbrains.com/help/idea/ktor.html#run_ktor_app">Ktor</a> that will serve as an API endpoint.
29
27
</div>
30
-
31
28
<divlanguage="JavaScript">
32
-
<p>
33
-
- Create a web server using <ahref="https://expressjs.com/">Express</a> that will serve as an API endpoint.
34
-
</p>
29
+
* Create a web server using <ahref="https://expressjs.com/">Express</a> that will serve as an API endpoint.
35
30
</div>
36
31
</LanguageSwitchBlock>
37
-
38
-
- Design the credential you'd like to offer.
39
-
- Implement an issuance path where you'll accept a request for issuance, perform any necessary checks, and issue the credential.
40
-
- Return the credential to the requester.
32
+
* Design the credential you'd like to offer.
33
+
* Implement an issuance path where you'll accept a request for issuance, perform any necessary checks, and issue the credential.
34
+
* Return the credential to the requester.
41
35
42
36
## Environment Setup
43
37
@@ -259,13 +253,13 @@ Refer to the [Create A DID](/docs/web5/build/decentralized-identifiers/how-to-cr
259
253
<LanguageSwitchBlock>
260
254
<divlanguage="Kotlin">
261
255
<p>
262
-
In order to run this code, create a <code>checkSanctionsLists()</code> function and a <code>sanctionsListResult</code> class in your <code>Application.kt</code> file:
256
+
In order to run this code, create a <code>checkSanctionsLists()</code> function and a <code>sanctionsListResult</code> class in your <code>Application.kt</code> file:
263
257
</p>
264
258
</div>
265
259
266
260
<divlanguage="JavaScript">
267
261
<p>
268
-
In order to run this code, create a <code>checkSanctionsLists()</code> function in your <code>api.js</code> file:
262
+
In order to run this code, create a <code>checkSanctionsLists()</code> function in your <code>api.js</code> file:
Copy file name to clipboardExpand all lines: site/docs/tbdex/pfi/creating-offerings.mdx
+27-39Lines changed: 27 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ sidebar_position: 6
4
4
5
5
# Offerings
6
6
7
-
Offerings describe a currency pair that can be exchanged and specify the requirements, conditions, and constraints needed to fulfill the described transaction.
7
+
Offerings describe a currency pair that can be exchanged and specify the requirements, conditions, and constraints needed to fulfill the described transaction.
8
8
In other words, an Offering is a way of describing a financial product you’re offering as a PFI on a tbDEX network. Any Wallet that has your PFI's DID will be able to query your PFI for all available Offerings, as well as fetch specific Offerings. Wallets will then use that data to make an Request for Quote (RFQ) to your PFI to begin a potential transaction process.
9
9
10
10
## Offering Data Schema
@@ -22,52 +22,40 @@ To define these parameters, you’ll create a JSON object per the [Offering sche
22
22
23
23
<table>
24
24
<tr>
25
-
<td><strong>Offering Trait</strong>
25
+
<td>
26
+
<strong>Offering Trait</strong>
26
27
</td>
27
-
<td><strong>tbDEX Field</strong>
28
+
<td>
29
+
<strong>tbDEX Field</strong>
28
30
</td>
29
-
<td><strong>Data Type</strong>
31
+
<td>
32
+
<strong>Data Type</strong>
30
33
</td>
31
34
</tr>
32
35
<tr>
33
-
<td>Currency Pairing for swap
34
-
</td>
35
-
<td>payinCurrency and payoutCurrency
36
-
</td>
37
-
<td>CurrencyDetails
38
-
</td>
36
+
<td>Currency Pairing for swap</td>
37
+
<td>payinCurrency and payoutCurrency</td>
38
+
<td>CurrencyDetails</td>
39
39
</tr>
40
40
<tr>
41
-
<td>Pay-in Method
42
-
</td>
43
-
<td>payinMethods
44
-
</td>
45
-
<td>PaymentMethod[]
46
-
</td>
41
+
<td>Pay-in Method</td>
42
+
<td>payinMethods</td>
43
+
<td>PaymentMethod[]</td>
47
44
</tr>
48
45
<tr>
49
-
<td>Pay-out Method
50
-
</td>
51
-
<td>payoutMethods
52
-
</td>
53
-
<td>PaymentMethods[]
54
-
</td>
46
+
<td>Pay-out Method</td>
47
+
<td>payoutMethods</td>
48
+
<td>PaymentMethods[]</td>
55
49
</tr>
56
50
<tr>
57
-
<td>Pay-out Conversion
58
-
</td>
59
-
<td>payoutUnitsPerPayinUnit
60
-
</td>
61
-
<td>string
62
-
</td>
51
+
<td>Pay-out Conversion</td>
52
+
<td>payoutUnitsPerPayinUnit</td>
53
+
<td>string</td>
63
54
</tr>
64
55
<tr>
65
-
<td>Required Credentials
66
-
</td>
67
-
<td>requiredClaims
68
-
</td>
69
-
<td>PresentationDefinitionV2
70
-
</td>
56
+
<td>Required Credentials</td>
57
+
<td>requiredClaims</td>
58
+
<td>PresentationDefinitionV2</td>
71
59
</tr>
72
60
</table>
73
61
@@ -118,13 +106,13 @@ Note that while `type` and `description` fields are more intuitive and standard
118
106
119
107
### Required Claims
120
108
121
-
In order to comply with certain financial regulations, you may require information about the customer you are transacting with.
122
-
You can obtain this information via [Verifiable Credentials](/docs/web5/learn/verifiable-credentials).
109
+
In order to comply with certain financial regulations, you may require information about the customer you are transacting with.
110
+
You can obtain this information via [Verifiable Credentials](/docs/web5/learn/verifiable-credentials).
123
111
124
-
To specify the exact credentials you need, you can do so in the `requiredClaims` section of your Offering by following [creating a Presentation Definition](/docs/web5/build/verifiable-credentials/presentation-definition/).
112
+
To specify the exact credentials you need, you can do so in the `requiredClaims` section of your Offering by following [creating a Presentation Definition](/docs/web5/build/verifiable-credentials/presentation-definition/).
125
113
You'll specify all required forms and details of proof, optional selection rules, and define flexibility where possible when different types of input may satisfy the requirements.
126
114
127
-
For a full breakdown of all the available fields and combinations, [see the DIF website](https://identity.foundation/presentation-exchange/#presentation-definition) for details.
115
+
For a full breakdown of all the available fields and combinations, [see the DIF website](https://identity.foundation/presentation-exchange/#presentation-definition) for details.
128
116
Below is a example of how you could request a Wallet provide a VC of type **SanctionsCredential**:
129
117
130
118
```json
@@ -250,4 +238,4 @@ When combining all the data above, you can end up with a full Offering object th
250
238
}
251
239
```
252
240
253
-
Once the Offering has been generated, you can store it in your database using code as shown in the [Exchange API Provider section](/docs/tbdex/pfi/anatomy-of-a-pfi#exchange-api-provider).
241
+
Once the Offering has been generated, you can store it in your database using code as shown in the [Exchange API Provider section](/docs/tbdex/pfi/anatomy-of-a-pfi#exchange-api-provider).
[](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/dinger-starter)
50
50
51
-
<details><summary>Finished Dinger App</summary>
51
+
<details>
52
+
<summary>Finished Dinger App</summary>
52
53
<p>
53
54
54
55
If you’d like to skip ahead and see the finished version of this tutorial, you can check out the running app on CodeSandbox.
@@ -151,7 +152,7 @@ And replace it with the following code snippet:
151
152
});
152
153
```
153
154
### 🧩 Breaking it down
154
-
-**web5.dwn.protocols.configure():** This function installs the protocol. The protocol needs to be installed because it ensures that both the sender's and recipient's applications (or Decentralized Web Nodes - DWNs) are aligned in terms of communication standards and data formats.
155
+
-**web5.dwn.protocols.configure():** This function installs the protocol. The protocol needs to be installed because it ensures that both the sender's and recipient's applications (or Decentralized Web Nodes - DWNs) are aligned in terms of communication standards and data formats.
console.log("Did the protocol install on the remote DWN?", configureRemoteStatus);
197
-
198
+
198
199
} else {
199
200
console.log("Protocol already installed");
200
201
}
201
202
```
202
-
-**configureProtocol()**: This function is responsible for configuring the protocol in both the local and remote DWNs. It first checks if the protocol is already installed locally. If not, it installs the protocol locally and then attempts to install it on the remote DWN associated with the user's DID.
203
+
-**configureProtocol()**: This function is responsible for configuring the protocol in both the local and remote DWNs. It first checks if the protocol is already installed locally. If not, it installs the protocol locally and then attempts to install it on the remote DWN associated with the user's DID.
203
204
204
205
### 📘 Learn more
205
206
- Learn more about [protocols](https://developer.tbd.website/docs/web5/learn/protocols/).
@@ -391,7 +392,8 @@ Time to test the Dinger app by simulating a conversation between two users by us
391
392
392
393
After following these steps, you should see a conversation taking place between the two browser sessions!
393
394
394
-
<details><summary>Not receiving any messages?</summary>
395
+
<details>
396
+
<summary>Not receiving any messages?</summary>
395
397
<ahref="https://developer.tbd.website/docs/web5/learn/sync/">Sync</a> intervals occur every two minutes. If you're eager to see immediate updates for testing purposes, you can adjust the sync settings. Update the line:
[](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/shared-todo-starter)
52
52
53
-
<details><summary>Finished Shared Todo App</summary>
53
+
<details>
54
+
<summary>Finished Shared Todo App</summary>
54
55
<p>
55
56
56
57
If you’d like to skip ahead and see the finished version of this tutorial, you can check out the running app on CodeSandbox.
@@ -571,7 +572,7 @@ async function toggleTodoComplete(todoItem) {
571
572
const { record } =awaitweb5.dwn.records.read({
572
573
message: {
573
574
filter: {
574
-
recordId:toggledTodo.id
575
+
recordId:toggledTodo.id
575
576
}
576
577
}
577
578
});
@@ -593,4 +594,4 @@ async function toggleTodoComplete(todoItem) {
593
594
594
595
Congratulations! We've just built a multi-paged, collaborative and decentralized web app that can be used by multiple users. You can check out the finished version of the app running on CodeSandbox.
595
596
596
-
[](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/shared-todo-completed)
597
+
[](https://codesandbox.io/p/sandbox/github/TBD54566975/developer.tbd.website/tree/main/examples/tutorials/shared-todo-completed)
0 commit comments