Skip to content

Commit 711288f

Browse files
committed
fixup! documentation
Signed-off-by: Angelo De Caro <[email protected]>
1 parent 013f72f commit 711288f

File tree

3 files changed

+6
-37
lines changed

3 files changed

+6
-37
lines changed

docs/core-token.md

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Example core.yaml section
22

3-
The following example provides descriptions for the various keys required for a Fabric Smart Client node that uses the Token SDK.
3+
The following example provides descriptions for the various keys required by the Token SDK.
44

55
```yaml
66
# ------------------- Token SDK Configuration -------------------------
@@ -107,35 +107,4 @@ token:
107107
SW:
108108
Hash: SHA2
109109
Security: 256
110-
# Internal database to keep track of token transactions.
111-
# It is used by auditors and token owners to track history
112-
ttxdb:
113-
persistence:
114-
# type can be one of badger, sql or memory.
115-
type: badger
116-
opts:
117-
# persistence location
118-
path: /some/path
119-
120-
# The sql driver uses golangs database/sql package internally.
121-
# In theory you can use any driver if you import it in your application;
122-
# for instance `import _ "github.com/mattn/go-sqlite3"` for the cgo version of sqlite.
123-
# See https://github.com/golang/go/wiki/SQLDrivers. We only tested with github.com/lib/pq
124-
# and modernc.org/sqlite, and it's likely that other drivers don't work exactly the same.
125-
# To try a new sql driver, add a test here: token/services/ttxdb/db/sql/sql_test.go.
126-
#
127-
# type: sql
128-
# opts:
129-
# createSchema: true # create tables programmatically
130-
# tablePrefix: tsdk # optional
131-
# driver: sqlite # in the application, `import _ "modernc.org/sqlite"`
132-
# dataSource: /some/path/ttxdb.sqlite
133-
# maxOpenConns: 10 # by default this is 0 (unlimited), sets the maximum number of open connections to the database
134-
#
135-
# Alternative (`import _ "github.com/lib/pq"`).
136-
# The 'dataSource' field can be sensitive (contain a password). In that case,
137-
# set it in the TTXDB_DATASOURCE environment variable instead of in this file.
138-
# driver: postgres
139-
# dataSource: host=localhost port=5432 user=postgres password=example dbname=tokendb sslmode=disable
140-
141110
```

docs/services/identity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,6 @@ Both requires the identities to be stored on the filesystem following the Hyperl
8989

9090
High level, these are the steps to follow:
9191
1. Instantiate the roles your driver will support.
92-
2. Instantiate the Wallet Registries for each role.
92+
2. Instantiate the Wallet Registry for each role.
9393

94-
Let see an example taken from the [`fabtoken`](./../../token/core/fabtoken/driver) driver.
94+
See an example taken from the [`fabtoken`](./../../token/core/fabtoken/driver) driver.

docs/services/vault.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ The Token Vault service empowers you with a comprehensive suite of functionaliti
2323
* **ListHistoryIssuedTokens()**: This function delivers a detailed list of all tokens that have been issued within the network.
2424
* **Public Parameters:** The PublicParams() function retrieves the public parameters associated with the token system.
2525
* **Token Information Retrieval:** These functions provide mechanisms to access information about your tokens:
26-
* **GetTokenInfos(ids []*token.ID, callback QueryCallbackFunc)**: This function retrieves information for the provided token IDs. It employs a callback function (`QueryCallbackFunc`) to unmarshal the retrieved token information for efficient processing.
27-
* **GetTokenOutputs(ids []*token.ID, callback QueryCallbackFunc)**: Similar to the previous function, this function retrieves the raw token outputs stored on the ledger for the provided IDs. It utilizes a callback function (`QueryCallbackFunc`) for unmarshalling the retrieved data.
28-
* **GetTokenInfoAndOutputs(ids []*token.ID, callback QueryCallback2Func)**: This function offers a combined approach, retrieving both the token information and their corresponding outputs for the provided IDs. It employs a dedicated callback function (`QueryCallback2Func`) tailored for handling both data types.
26+
* **GetTokenInfos(ids []*token.ID)**: This function retrieves information for the provided token IDs.
27+
* **GetTokenOutputs(ids []*token.ID)**: Similar to the previous function, this function retrieves the raw token outputs stored on the ledger for the provided IDs.
28+
* **GetTokenInfoAndOutputs(ids []*token.ID)**: This function offers a combined approach, retrieving both the token information and their corresponding outputs for the provided IDs.
2929
* **GetTokens:** This function retrieves a list of tokens along with their corresponding vault keys.
3030
* **WhoDeletedTokens:** This function delves into the history of deleted tokens. It provides information about who deleted the specified tokens (if applicable) and returns a boolean array indicating whether each token at a given position has been deleted.
3131

0 commit comments

Comments
 (0)