Profile¶

Class Name	Profile
Extends	Logger
Source	profile.ts
Examples	profile.spec.ts

A users profile is its personal storage for - contacts - encryption keys exchanged with contacts - an own public key for exchanging keys with new contacts - bookmarked ÐAPPs - created contracts

This data is stored as an IPLD Graphs per type and stored in a users profile contract. These graphs are independant from each other and have to be saved separately.

This contract is a DataContract and can be created via the factory at profile.factory.evan and looked up at the global profile index profile.evan. The creation process and landmap looks like this:

Basic Usage¶

// the bookmark we want to store
const sampleDesc = {
  title: 'sampleTest',
  description: 'desc',
  img: 'img',
  primaryColor: '#FFFFFF',
};

// create new profile, set private key and keyexchange partial key
await profile.createProfile(keyExchange.getDiffieHellmanKeys());

// add a bookmark
await profile.addDappBookmark('sample1.test', sampleDesc);

// store tree to contract
await profile.storeForAccount(profile.treeLabels.bookmarkedDapps);

constructor¶

new Profile(options);

Creates a new Profile instance.

Parameters¶

options - ProfileOptions: options for Profile constructor
- accountId - string: account, that is the profile owner
- contractLoader - ContractLoader: ContractLoader instance
- dataContract - DataContract: DataContract instance
- executor - Executor: Executor instance
- ipld - Ipld: Ipld instance
- nameResolver - NameResolver: NameResolver instance
- defaultCryptoAlgo - string (optional): crypto algorith name from CryptoProvider, defaults to aes
- log - Function (optional): function to use for logging: (message, level) => {...}
- logLevel - LogLevel (optional): messages with this level will be logged with log
- logLog - LogLogInterface (optional): container for collecting log messages
- logLogLevel - LogLevel (optional): messages with this level will be pushed to logLog
- trees - object (optional): precached profile data, defaults to {}

Returns¶

Profile instance

Example¶

const profile = new Profile({
  accountId: accounts[0],
  contractLoader,
  dataContract,
  executor,
  ipld,
  nameResolver,
});

createProfile¶

profile.createProfile(keys)

Create new profile, store it to profile index initialize addressBook and publicKey.

Parameters¶

keys - any: diffie hell man keys for account, created by KeyExchange
- privateKey - Buffer: private key for key exchange
- publicKey - Buffer: combination of shared secret and own private key

Returns¶

Promise returns void: resolved when done

Example¶

await profile.createProfile(keyExchange.getDiffieHellmanKeys());

checkCorrectProfileData¶

profile.checkCorrectProfileData();

Check if profile data is correct, according to a specific profile type. Throws, when the data is invalid.

Parameters¶

data - object: profile data (accountDetails, registration, contact, …) (see setProfileProperties for example values)
type - string: profileType (user, company, device)

Returns¶

Promise returns void: true if a contract was registered, false if not

Example¶

console.log(await Profile.checkCorrectProfileData({
  "accountDetails": {
    "accountName": "Test",
    "profileType": "company"
  },
  "registration": {
    "company": "Company Name",
    "court": "register court1",
    "register": "hrb",
    "registerNumber": "Registration Number",
    "salesTaxID": "tax id"
  },
  "contact": {
    "country": "DE",
    "city": "City",
    "postalCode": "12345",
    "streetAndNumber": "street",
    "website": "https://evan.network"
  }
}, 'company'));
// Output:
// true

exists¶

profile.exists();

Check if a profile has been stored for current account.

Parameters¶

options - object: The options used for calling

Returns¶

Promise returns void: true if a contract was registered, false if not

Example¶

console.log(await profile.exists());
// Output:
// true

getContactKnownState¶

profile.getContactKnownState(accountId);

Check, known state for given account.

Parameters¶

accountId - string: account id of a contact

Returns¶

Promise returns void: true if known account

Example¶

  console.log(await profile.getContactKnownState(accountId));
// Output:
// true

getProfileProperty¶

profile.getProfileProperty(property);

Return the saved profile information according to the specified profile type. No type directly uses “user” type.

Parameters¶

property - string: Restrict properties that should be loaded.

Returns¶

Promise returns void: true if known account

Example¶

  console.log(await profile.getProfileProperty('accountDetails'));
// Output:
// {
//    "accountName": "Test",
//    "profileType": "company"
// }

setContactKnownState¶

profile.setContactKnownState(contactAddress, contactKnown);

Store given state for this account.

Parameters¶

contactAddress - string: contact identity or account
contactKnown - boolean: true if known, false if not

Returns¶

Promise returns void: resolved when done

Example¶

// mark contact1 as a known contact
profile.setContactKnownState(contact1, true);

setProfileProperties¶

profile.setProfileProperties(payload);

Takes a set of profile properties and saves them into the profile DataContainer. Throws errors, if not the correct properties are applied for the specified account type.

Parameters¶

payload - any: Object that should saved. Each entry will be saved as seperated entry.

Returns¶

Promise returns void: resolved when done

Example¶

// mark accountId as a known contact
profile.setProfileProperties({
  "accountDetails": {
    "accountName": "Test",
    "profileType": "company"
  },
  "registration": {
    "company": "Company Name",
    "court": "register court1",
    "register": "hrb",
    "registerNumber": "Registration Number",
    "salesTaxID": "tax id"
  },
  "contact": {
    "country": "DE",
    "city": "Cirty",
    "postalCode": "12345",
    "streetAndNumber": "street",
    "website": "https://evan.network"
  }
});

loadForAccount¶

profile.loadForAccount([tree]);

Load profile for given account from global profile contract, if a tree is given, load that tree from ipld as well.

Parameters¶

tree - string (optional): tree to load (‘bookmarkedDapps’, ‘contracts’, …), profile.treeLabels properties can be passed as arguments

Returns¶

Promise returns void: resolved when done

Example¶

await profile.loadForAccount(profile.treeLabels.contracts);

storeForAccount¶

profile.storeForAccount(tree);

Stores profile tree or given hash to global profile contract.

Parameters¶

tree - string: tree to store (‘bookmarkedDapps’, ‘contracts’, …)
ipldHash - string (optional): store this hash instead of the current tree for the profile’s identity or account

Returns¶

Promise returns void: resolved when done

Example¶

await profile.storeForAccount(profile.treeLabels.contracts);

loadFromIpld¶

profile.loadFromIpld(tree, ipldIpfsHash);

Load profile from ipfs via ipld dag via ipfs file hash.

Parameters¶

tree - string: tree to load (‘bookmarkedDapps’, ‘contracts’, …)
ipldIpfsHash - string: ipfs file hash that points to a file with ipld a hash

Returns¶

Promise returns Profile: this profile

Example¶

await profile.loadFromIpld(profile.treeLabels.contracts, ipldIpfsHash);

storeToIpld¶

profile.storeToIpld(tree);

Store profile in ipfs as an ipfs file that points to a ipld dag.

Parameters¶

tree - string: tree to store (‘bookmarkedDapps’, ‘contracts’, …)

Returns¶

Promise returns string: hash of the ipfs file

Example¶

const storedHash = await profile.storeToIpld(profile.treeLabels.contracts);

= addressBook =¶

addContactKey¶

profile.addContactKey(address, context, key);

Add a key for a contact to bookmarks.

Parameters¶

address - string: account key of the contact
context - string: store key for this context, can be a contract, bc, etc.
key - string: communication key to store

Returns¶

Promise returns void: resolved when done

Example¶

await profile.addContactKey(accounts[0], 'context a', 'key 0x01_a');

addProfileKey¶

profile.addProfileKey(address, key, value);

Add a profile value to an account.

Parameters¶

address - string: account key of the contact
key - string: store key for the account like alias, etc.
value - string: value of the profile key

Returns¶

Promise returns void: resolved when done

Example¶

await profile.addProfileKey(accounts[0], 'email', 'sample@example.org');
await profile.addProfileKey(accounts[0], 'alias', 'Sample Example');

setIdentityAccess¶

profile.setIdentityAccess(address, key);

Add identity key to address book, so a getRuntimeForIdentity can be used without specifying the encryptionKey in the keyConfig.

Parameters¶

address - string: identity address
key - string: identity datakey

Returns¶

Promise returns void: resolved when done

Example¶

await profile.setIdentityAccess(identities[0], 'key 0x01_b');

removeIdentityAccess¶

profile.removeIdentityAccess(address);

Remove identity key from address book

Parameters¶

address - string: identity address to be removed

Returns¶

Promise returns void: resolved when done

Example¶

await profile.removeIdentityAccess(identities[0]);

getIdentityAccessList¶

profile.getIdentityAccessList();

Function description

Gets a list of identities, where the profile identity has access to, from address book. Keep in mind address book needs to be loaded beforehand using the loadForAccount API. The result will be an object containing identity addresses mapped to their encryption keys and sha3 addresses mapped to their identity address. Those identity addresses which have an alias will also return the alias.

Parameters¶

(none)

Returns¶

any: identity list from address loaded book

Example¶

// load address book
await profile.loadForAccount(profile.treeLabels.addressBook);
// identities[0] does not have an alias, adding identity to address book
await profile.setIdentityAccess(identities[0], 'key 0x01_a');
// identities[1] has an alias, adding identity to address book
await profile.setIdentityAccess(identities[1], 'key 0x01_b');
// get list of identities
await profile.getIdentityAccessList();

Output:
{
'sha3(identities[1])': { identityAccess: 'key 0x01_b', alias: 'test account' },
'sha3(identities[0])': { identityAccess: 'key 0x01_a' },
'identities[1]': { identityAccess: 'key 0x01_b', alias: 'test account' }
}

getAddressBookAddress¶

profile.getAddressBookAddress(address);

Function description

Parameters¶

address - string: contact address

Returns¶

Promise returns any: bookmark info

Example¶

await profile.getAddressBookAddress(accounts[0]);

getAddressBook¶

profile.getAddressBook();

Get the whole addressBook.

Parameters¶

(none)

Returns¶

any: entire address book

Example¶

await profile.getAddressBook();

getContactKey¶

profile.getContactKey(address, context);

Get a communication key for a contact from bookmarks.

Parameters¶

address - string`: account key of the contact
context - string`: store key for this context, can be a contract, bc, etc.

Returns¶

Promise returns void: matching key

Example¶

await profile.getContactKey(accounts[0], 'exampleContext');

getProfileKey¶

profile.getProfileKey(address, key);

Get a key from an address in the address book.

Parameters¶

address - string: address to look up
key - string: type of key to get

Returns¶

Promise returns any: key

Example¶

const alias = await profile.getProfileKey(accountId, 'alias');

removeContact¶

profile.removeContact(address);

Remove a contact from bookmarkedDapps.

Parameters¶

address - string: identity or account of the contact

Returns¶

Promise returns void: resolved when done

Example¶

await profile.removeContact(address);

= bookmarkedDapps =¶

addDappBookmark¶

profile.addDappBookmark(address, description);

Add a bookmark for a dapp.

Parameters¶

address - string: ENS name or contract address (if no ENS name is set)
description - DappBookmark: description for bookmark

Returns¶

Promise returns void: resolved when done

Example¶

const bookmark = {
  "name": "taskboard",
  "description": "Create todos and manage updates.",
  "i18n": {
    "description": {
      "de": "Erstelle Aufgaben und überwache Änderungen",
      "en": "Create todos and manage updates"
    },
    "name": {
      "de": "Task Board",
      "en": "Task Board"
    }
  },
  "imgSquare": "...",
  "standalone": true,
  "primaryColor": "#e87e23",
  "secondaryColor": "#fffaf5",
};
await profile.addDappBookmark('sampletaskboard.evan', bookmark);

getDappBookmark¶

profile.getDappBookmark(address);

Get a bookmark for a given address if any.

Parameters¶

address - string: ENS name or contract address (if no ENS name is set)

Returns¶

Promise returns any: bookmark info

Example¶

await profile.getDappBookmark('sample1.evan');

getBookmarkDefinition¶

profile.getBookmarkDefinition();

Get all bookmarks for profile.

Parameters¶

(none)

Returns¶

Promise returns any: all bookmarks for profile

Example¶

await profile.getBookmarkDefinitions();

removeDappBookmark¶

profile.removeDappBookmark(address);

Remove a dapp bookmark from the bookmarkedDapps.

Parameters¶

address - string: address of the bookmark to remove

Returns¶

Promise returns void: resolved when done

Example¶

await profile.removeDappBookmark(address);

setDappBookmarks¶

profile.setDappBookmarks(bookmarks);

Set bookmarks with given value.

Parameters¶

bookmarks - any: The options used for calling

Returns¶

Promise returns void: resolved when done

Example¶

const bookmarks = await profile.getBookmarkDefinitions();
// update bookmarks
// ...
await profile.setDappBookmarks(bookmarks);

= contracts =¶

addContract¶

profile.addContract(address, data);

Add a contract to the current profile.

Parameters¶

address - string: contract address
data - any: bookmark metadata

Returns¶

Promise returns void: resolved when done

Example¶

await profile.addContract('0x...', contractDescription);

getContracts¶

profile.getContracts();

Get all contracts for the current profile.

Parameters¶

(none)

Returns¶

Promise returns any: contracts info

Example¶

await profile.getContracts();

getContract¶

profile.getContract(address);

Get a specific contract entry for a given address.

Parameters¶

address - string: contact address

Returns¶

Promise returns any: bookmark info

Example¶

await profile.getContract('testbc.evan');

addBcContract¶

profile.addBcContract(bc, address, data)

Add a contract (task contract etc. ) to a business center scope of the current profile

Parameters¶

bc - string: business center ens address or contract address
address - string: contact address
data - any: bookmark metadata

Returns¶

Promise returns void: resolved when done

Example¶

await profile.addBcContract('testbc.evan', '0x...', contractDescription);

getBcContract¶

profile.getBcContract(bc, address);

Get a specific contract entry for a given address.

Parameters¶

bcc - string: business center ens address or contract address
address - string: contact address

Returns¶

Promise returns any: bookmark info

Example¶

await profile.getBcContract('testbc.evan', '0x...');

getBcContracts¶

profile.getBcContracts(bc, address);

Get all contracts grouped under a business center.

Parameters¶

bcc - string: business center ens address or contract address

Returns¶

Promise returns any: bookmark info

Example¶

await profile.getBcContracts('testbc.evan');

removeContract¶

profile.removeBcContract(address, data);

removes a contract (task contract etc. ) from a business center scope of the current profile

Parameters¶

bc - string: business center ens address or contract address
address - any: contact address

Returns¶

Promise returns void: resolved when done

Example¶

await profile.removeBcContract('testbc.evan', '0x');

= publicKey =¶

addPublicKey¶

profile.addPublicKey(key);

Add a key for a contact to bookmarks.

Parameters¶

key - string: public Diffie Hellman key part to store

Returns¶

Promise returns void: resolved when done

Example¶

await profile.addPublicKey('...');

getPublicKey¶

profile.getPublicKey();

Get public key of profiles.

Parameters¶

(none)

Returns¶

Promise returns any: public key

Example¶

const key = await profile.getPublicKey();

loadActiveVerifications¶

profile.loadActiveVerifications();

Load all verificationss that should be displayed for this profile within the ui.

Parameters¶

(none)

Returns¶

Promise returns string[]: array of topics of verificationss that should be displayed (e.g. [ ‘/company/tuev’, ‘/test/1234’ ] )

Example¶

const topics = await bcc.profile.loadActiveVerifications();

setActiveVerifications¶

profile.setActiveVerifications(bookmarks);

Save an array of active verificationss to the profile.

Parameters¶

bookmarks - string[]: bookmarks to set

Returns¶

Promise returns void: resolved when saving is done

Example¶

await bcc.profile.setActiveVerifications([ '/company/tuev', '/test/1234' ]);

setPlugins¶

profile.setPlugins(plugins);

Save set of plugins to profile.

Parameters¶

plugins - any: entire collections of plugins to store in profile

Returns¶

Promise returns void: resolved when done

Example¶

await profile.setPlugins({ customMetadata: {} });

getPlugins¶

profile.getPlugins();

Get entire set of plugins from profile.

Returns¶

Promise returns any: all plugins from profile

Example¶

const plugins = await profile.getPlugins();