Skip to content

Commit c82c33e

Browse files
Update account doc formatting
1 parent a3119fe commit c82c33e

File tree

3 files changed

+21
-24
lines changed

3 files changed

+21
-24
lines changed

docs/api_reference/sdk-src_account.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@
99
# Class `Account`
1010

1111
Key Management class. Enables the creation of a new Aleo Account, importation of an existing account from
12-
an existing private key or seed, and message signing and verification functionality.
13-
14-
An Aleo Account is generated from a randomly generated seed (number) from which an account private key, view key,
15-
and a public account address are derived. The private key lies at the root of an Aleo account. It is a highly
16-
sensitive secret and should be protected as it allows for creation of Aleo Program executions and arbitrary value
17-
transfers. The View Key allows for decryption of a user's activity on the blockchain. The Address is the public
18-
address to which other users of Aleo can send Aleo credits and other records to. This class should only be used
19-
in environments where the safety of the underlying key material can be assured.
12+
an existing private key or seed, and message signing and verification functionality. An Aleo Account is generated
13+
from a randomly generated seed (number) from which an account private key, view key, and a public account address are
14+
derived. The private key lies at the root of an Aleo account. It is a highly sensitive secret and should be protected
15+
as it allows for creation of Aleo Program executions and arbitrary value transfers. The View Key allows for decryption
16+
of a user's activity on the blockchain. The Address is the public address to which other users of Aleo can send Aleo
17+
credits and other records to. This class should only be used in environments where the safety of the underlying key
18+
material can be assured.
2019

2120
## Examples
2221

docs/api_reference/toc.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44

55
* ![category:other](https://img.shields.io/badge/category-other-blue.svg?style=flat-square)
66
* [src/account](sdk-src_account.md) - _Key Management class. Enables the creation of a new Aleo Account, importation of an existing account from
7-
an existing private key or seed, and message signing and verification functionality.
8-
9-
An Aleo Account is generated from a randomly generated seed (number) from which an account private key, view key,
10-
and a public account address are derived. The private key lies at the root of an Aleo account. It is a highly
11-
sensitive secret and should be protected as it allows for creation of Aleo Program executions and arbitrary value
12-
transfers. The View Key allows for decryption of a user's activity on the blockchain. The Address is the public
13-
address to which other users of Aleo can send Aleo credits and other records to. This class should only be used
14-
in environments where the safety of the underlying key material can be assured._
7+
an existing private key or seed, and message signing and verification functionality. An Aleo Account is generated
8+
from a randomly generated seed (number) from which an account private key, view key, and a public account address are
9+
derived. The private key lies at the root of an Aleo account. It is a highly sensitive secret and should be protected
10+
as it allows for creation of Aleo Program executions and arbitrary value transfers. The View Key allows for decryption
11+
of a user's activity on the blockchain. The Address is the public address to which other users of Aleo can send Aleo
12+
credits and other records to. This class should only be used in environments where the safety of the underlying key
13+
material can be assured._
1514
* [src/function-key-provider](sdk-src_function-key-provider.md) - _AleoKeyProvider class. Implements the KeyProvider interface. Enables the retrieval of Aleo program proving and
1615
verifying keys for the credits.aleo program over http from official Aleo sources and storing and retrieving function
1716
keys from a local memory cache._

sdk/src/account.ts

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,13 @@ interface AccountParam {
1616

1717
/**
1818
* Key Management class. Enables the creation of a new Aleo Account, importation of an existing account from
19-
* an existing private key or seed, and message signing and verification functionality.
20-
*
21-
* An Aleo Account is generated from a randomly generated seed (number) from which an account private key, view key,
22-
* and a public account address are derived. The private key lies at the root of an Aleo account. It is a highly
23-
* sensitive secret and should be protected as it allows for creation of Aleo Program executions and arbitrary value
24-
* transfers. The View Key allows for decryption of a user's activity on the blockchain. The Address is the public
25-
* address to which other users of Aleo can send Aleo credits and other records to. This class should only be used
26-
* in environments where the safety of the underlying key material can be assured.
19+
* an existing private key or seed, and message signing and verification functionality. An Aleo Account is generated
20+
* from a randomly generated seed (number) from which an account private key, view key, and a public account address are
21+
* derived. The private key lies at the root of an Aleo account. It is a highly sensitive secret and should be protected
22+
* as it allows for creation of Aleo Program executions and arbitrary value transfers. The View Key allows for decryption
23+
* of a user's activity on the blockchain. The Address is the public address to which other users of Aleo can send Aleo
24+
* credits and other records to. This class should only be used in environments where the safety of the underlying key
25+
* material can be assured.
2726
*
2827
* @example
2928
* import { Account } from "@provablehq/sdk/testnet.js";

0 commit comments

Comments
 (0)