Constructor
new Account()
- Source
Example
\ No newline at end of file
+}
// Create a new account
-let myRandomAccount = new Account();
+ On this pageAccount
Key Management class. Enables the creation of a new Aleo Account, importation of an existing account from an existing private key or seed, and message signing and verification functionality. An Aleo Account is generated from a randomly generated seed (number) from which an account private key, view key, and a public account address are derived. The private key lies at the root of an Aleo account. It is a highly sensitive secret and should be protected as it allows for creation of Aleo Program executions and arbitrary value transfers. The View Key allows for decryption of a user's activity on the blockchain. The Address is the public address to which other users of Aleo can send Aleo credits and other records to. This class should only be used environments where the safety of the underlying key material can be assured.Constructor
new Account()
- Source
Example// Create a new account
+const myRandomAccount = new Account();
// Create an account from a randomly generated seed
-let seed = new Uint8Array([94, 91, 52, 251, 240, 230, 226, 35, 117, 253, 224, 210, 175, 13, 205, 120, 155, 214, 7, 169, 66, 62, 206, 50, 188, 40, 29, 122, 40, 250, 54, 18]);
-let mySeededAccount = new Account({seed: seed});
+const seed = new Uint8Array([94, 91, 52, 251, 240, 230, 226, 35, 117, 253, 224, 210, 175, 13, 205, 120, 155, 214, 7, 169, 66, 62, 206, 50, 188, 40, 29, 122, 40, 250, 54, 18]);
+const mySeededAccount = new Account({seed: seed});
// Create an account from an existing private key
-let myExistingAccount = new Account({privateKey: 'myExistingPrivateKey'})
+const myExistingAccount = new Account({privateKey: 'myExistingPrivateKey'})
// Sign a message
-let hello_world = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
-let signature = myRandomAccount.sign(hello_world)
+const hello_world = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
+const signature = myRandomAccount.sign(hello_world)
// Verify a signature
-myRandomAccount.verify(hello_world, signature)
Classes
Methods
(static) fromCiphertext(ciphertext, password) → {PrivateKey|Error}
Attempts to create an account from a private key ciphertextParameters:Name Type Description ciphertextPrivateKeyCiphertext | string passwordstring
- Source
Returns:- Type:
- PrivateKey |
Error
Examplelet ciphertext = PrivateKey.newEncrypted("password");
-let account = Account.fromCiphertext(ciphertext, "password");
(static) fromCiphertext(ciphertext, password) → {PrivateKey|Error}
Attempts to create an account from a private key ciphertextParameters:Name Type Description ciphertextPrivateKeyCiphertext | string passwordstring
- Source
Returns:- Type:
- PrivateKey |
Error
Examplelet ciphertext = PrivateKey.newEncrypted("password");
-let account = Account.fromCiphertext(ciphertext, "password");
decryptRecord(ciphertext) → {Record}
Decrypts a Record in ciphertext form into plaintextParameters:Name Type Description ciphertextstring
- Source
Returns:- Type:
- Record
Examplelet account = new Account();
-let record = account.decryptRecord("record1ciphertext");
decryptRecord(ciphertext) → {Record}
Decrypts a Record in ciphertext form into plaintextParameters:Name Type Description ciphertextstring
- Source
Returns:- Type:
- Record
Examplelet account = new Account();
-let record = account.decryptRecord("record1ciphertext");
decryptRecords(ciphertexts) → {Array.<Record>}
Decrypts an array of Records in ciphertext form into plaintextParameters:Name Type Description ciphertextsArray.<string>
- Source
Returns:- Type:
- Array.<Record>
Examplelet account = new Account();
-let record = account.decryptRecords(["record1ciphertext", "record2ciphertext"]);
decryptRecords(ciphertexts) → {Array.<Record>}
Decrypts an array of Records in ciphertext form into plaintextParameters:Name Type Description ciphertextsArray.<string>
- Source
Returns:- Type:
- Array.<Record>
Examplelet account = new Account();
-let record = account.decryptRecords(["record1ciphertext", "record2ciphertext"]);
encryptAccount(ciphertext) → {PrivateKeyCiphertext}
Encrypt the account's private key with a passwordParameters:Name Type Description ciphertextstring
- Source
Returns:- Type:
- PrivateKeyCiphertext
Examplelet account = new Account();
-let ciphertext = account.encryptAccount("password");
encryptAccount(ciphertext) → {PrivateKeyCiphertext}
Encrypt the account's private key with a passwordParameters:Name Type Description ciphertextstring
- Source
Returns:- Type:
- PrivateKeyCiphertext
Examplelet account = new Account();
-let ciphertext = account.encryptAccount("password");
ownsRecordCiphertext(ciphertext) → {boolean}
Determines whether the account owns a ciphertext recordParameters:Name Type Description ciphertextRecordCipherText | string
- Source
Returns:- Type:
- boolean
Example// Create a connection to the Aleo network and an account
-let connection = new NodeConnection("vm.aleo.org/api");
-let account = Account.fromCiphertext("ciphertext", "password");
+myRandomAccount.verify(hello_world, signature)
Classes
Methods
(static) fromCiphertext(ciphertext, password) → {PrivateKey}
Attempts to create an account from a private key ciphertextParameters:Name Type Description ciphertextPrivateKeyCiphertext | string passwordstring
- Source
Returns:- Type:
- PrivateKey
Exampleconst ciphertext = PrivateKey.newEncrypted("password");
+const account = Account.fromCiphertext(ciphertext, "password");
(static) fromCiphertext(ciphertext, password) → {PrivateKey}
Attempts to create an account from a private key ciphertextParameters:Name Type Description ciphertextPrivateKeyCiphertext | string passwordstring
- Source
Returns:- Type:
- PrivateKey
Exampleconst ciphertext = PrivateKey.newEncrypted("password");
+const account = Account.fromCiphertext(ciphertext, "password");
decryptRecord(ciphertext) → {Record}
Decrypts a Record in ciphertext form into plaintextParameters:Name Type Description ciphertextstring
- Source
Returns:- Type:
- Record
Exampleconst account = new Account();
+const record = account.decryptRecord("record1ciphertext");
decryptRecord(ciphertext) → {Record}
Decrypts a Record in ciphertext form into plaintextParameters:Name Type Description ciphertextstring
- Source
Returns:- Type:
- Record
Exampleconst account = new Account();
+const record = account.decryptRecord("record1ciphertext");
decryptRecords(ciphertexts) → {Array.<Record>}
Decrypts an array of Records in ciphertext form into plaintextParameters:Name Type Description ciphertextsArray.<string>
- Source
Returns:- Type:
- Array.<Record>
Exampleconst account = new Account();
+const record = account.decryptRecords(["record1ciphertext", "record2ciphertext"]);
decryptRecords(ciphertexts) → {Array.<Record>}
Decrypts an array of Records in ciphertext form into plaintextParameters:Name Type Description ciphertextsArray.<string>
- Source
Returns:- Type:
- Array.<Record>
Exampleconst account = new Account();
+const record = account.decryptRecords(["record1ciphertext", "record2ciphertext"]);
encryptAccount(ciphertext) → {PrivateKeyCiphertext}
Encrypt the account's private key with a passwordParameters:Name Type Description ciphertextstring
- Source
Returns:- Type:
- PrivateKeyCiphertext
Exampleconst account = new Account();
+const ciphertext = account.encryptAccount("password");
encryptAccount(ciphertext) → {PrivateKeyCiphertext}
Encrypt the account's private key with a passwordParameters:Name Type Description ciphertextstring
- Source
Returns:- Type:
- PrivateKeyCiphertext
Exampleconst account = new Account();
+const ciphertext = account.encryptAccount("password");
ownsRecordCiphertext(ciphertext) → {boolean}
Determines whether the account owns a ciphertext recordParameters:Name Type Description ciphertextRecordCipherText | string
- Source
Returns:- Type:
- boolean
Example// Create a connection to the Aleo network and an account
+const connection = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+const account = Account.fromCiphertext("ciphertext", "password");
// Get a record from the network
-let record = connection.getBlock(1234);
-let recordCipherText = record.transactions[0].execution.transitions[0].id;
+const record = connection.getBlock(1234);
+const recordCipherText = record.transactions[0].execution.transitions[0].id;
// Check if the account owns the record
if account.ownsRecord(recordCipherText) {
@@ -38,12 +38,12 @@
// Store the record in a local database
// Etc.
}
ownsRecordCiphertext(ciphertext) → {boolean}
Determines whether the account owns a ciphertext recordParameters:Name Type Description ciphertextRecordCipherText | string
- Source
Returns:- Type:
- boolean
Example// Create a connection to the Aleo network and an account
-let connection = new NodeConnection("vm.aleo.org/api");
-let account = Account.fromCiphertext("ciphertext", "password");
+const connection = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+const account = Account.fromCiphertext("ciphertext", "password");
// Get a record from the network
-let record = connection.getBlock(1234);
-let recordCipherText = record.transactions[0].execution.transitions[0].id;
+const record = connection.getBlock(1234);
+const recordCipherText = record.transactions[0].execution.transitions[0].id;
// Check if the account owns the record
if account.ownsRecord(recordCipherText) {
@@ -51,14 +51,14 @@
// Decrypt the record and check if it's spent
// Store the record in a local database
// Etc.
-}
sign(message) → {Signature}
Signs a message with the account's private key. Returns a Signature.Parameters:Name Type Description messageUint8Array
- Source
Returns:- Type:
- Signature
Examplelet account = new Account();
-let message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
-account.sign(message);
sign(message) → {Signature}
Signs a message with the account's private key. Returns a Signature.Parameters:Name Type Description messageUint8Array
- Source
Returns:- Type:
- Signature
Examplelet account = new Account();
-let message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
-account.sign(message);
verify(message, signature) → {boolean}
Verifies the Signature on a message.Parameters:Name Type Description messageUint8Array signatureSignature
- Source
Returns:- Type:
- boolean
Examplelet account = new Account();
-let message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
-let signature = account.sign(message);
-account.verify(message, signature);
verify(message, signature) → {boolean}
Verifies the Signature on a message.Parameters:Name Type Description messageUint8Array signatureSignature
- Source
Returns:- Type:
- boolean
Examplelet account = new Account();
-let message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
-let signature = account.sign(message);
-account.verify(message, signature);
sign(message) → {Signature}
Signs a message with the account's private key. Returns a Signature.
Parameters:
| Name | Type | Description |
|---|---|---|
message | Uint8Array |
- Source
Returns:
- Type:
- Signature
Example
const account = new Account();
+const message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
+account.sign(message);sign(message) → {Signature}
Signs a message with the account's private key. Returns a Signature.
Parameters:
| Name | Type | Description |
|---|---|---|
message | Uint8Array |
- Source
Returns:
- Type:
- Signature
Example
const account = new Account();
+const message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
+account.sign(message);verify(message, signature) → {boolean}
Verifies the Signature on a message.
Parameters:
| Name | Type | Description |
|---|---|---|
message | Uint8Array | |
signature | Signature |
- Source
Returns:
- Type:
- boolean
Example
const account = new Account();
+const message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
+const signature = account.sign(message);
+account.verify(message, signature);verify(message, signature) → {boolean}
Verifies the Signature on a message.
Parameters:
| Name | Type | Description |
|---|---|---|
message | Uint8Array | |
signature | Signature |
- Source
Returns:
- Type:
- boolean
Example
const account = new Account();
+const message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
+const signature = account.sign(message);
+account.verify(message, signature);