Skip to content

Commit

Permalink
📝(style) Update colors and logos
Browse files Browse the repository at this point in the history
  • Loading branch information
Nakasar committed Oct 5, 2023
1 parent e2c9966 commit c51bbcb
Show file tree
Hide file tree
Showing 11 changed files with 96 additions and 9 deletions.
88 changes: 88 additions & 0 deletions docs/suite/identity-registry.md
Original file line number Diff line number Diff line change
@@ -1 +1,89 @@
# Identity Registry

The Identity Registry smart contract is a registry of identities. It is used by the Asset smart contract to verify that
a recipient is associated with a compliant identity.

Each recipient address (that could be a wallet, a smart contract, or even an ONCHAINID) is associated with an ONCHAINID
in the Identity Registry (it maintains a mapping of `address -> ONCHAINID`).

Multiple assets can share the same identity registry and thus the same rules for identities (same configuration of
required claims and trusted issuers). If assets have different rules, they must use different identity registries.

## Methods

### registerIdentity

Register a mapping between an asset owner address and an ONCHAINID. Requires that the user doesn't have an identity
contract already registered. The method also expects a country integer code. This function can only be called by a
wallet set as agent of the smart contract.

```solidity
function registerIdentity(
address userAddress,
address identity,
uint16 country
);
```

### deleteIdentity

Removes a pairing between an asset owner address and an ONCHAINID. This function can only be called by a wallet set as
agent of the smart contract.

```solidity
function deleteIdentity(address userAddress);
```

### updateCountry

Update the country integer code stored for an asset owner address. This function can only be called by a wallet set as
agent of the smart contract.

```solidity
function updateCountry(address userAddress, uint16 country);
```

### updateIdentity

Update the ONCHAINID address stored for an asset owner address. This function can only be called by a wallet set as
agent of the smart contract.

```solidity
function updateIdentity(address userAddress, address identity);
```

### isVerified

A read only method that returns true if a given asset owner address is associated with an ONCHAINID that satisfies the
requirements for claims topics and trusted issuers.

The method first retrieve the paired ONCHAINID address for the asset holder address, and then verified that there is at
least one valid claim (correct signature and not revoked) issuer by a trusted issuer for each required claim topic on
the ONCHAINID contract.

```solidity
function isVerified(address userAddress) public view returns (bool);
```

## Configuration methods

The owner of the Identity Registry can set the trusted issuer registry, the identity registry storage, and the required
claim topics registry.

### setIdentityRegistryStorage

```solidity
function setIdentityRegistryStorage(address identityRegistryStorage);
```

### setClaimTopicsRegistry

```solidity
function setClaimTopicsRegistry(address claimTopicsRegistry);
```

### setTrustedIssuersRegistry

```solidity
function setTrustedIssuersRegistry(address trustedIssuersRegistry);
```
2 changes: 1 addition & 1 deletion docs/suite/suite.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ part of the ERC3643 suite:
- **Compliance Module**: modules implement specific requirements and rules for a compliance. They may require specific
setup.
- **Claim Issuer**: though claim issuers are part of the ONCHAINID standard, ERC3643 assumes claim issuers follow
the standard and implements the required `isClaimValid` method.
the standard and implement the required `isClaimValid` method.

```mermaid
---
Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const config = {
title: 'ERC3643 documentation',
tagline: 'Developer documentation for the ERC3643 regulated token standard',
favicon: 'img/favicon.ico',
favicon: 'img/favicon.png',

// Set the production url of your site here
url: 'https://erc3643.github.io/',
Expand Down Expand Up @@ -71,7 +71,7 @@ const config = {
title: 'ERC3643',
logo: {
alt: 'Logo ERC3643',
src: 'img/logo.svg',
src: 'img/erc3643.png',
},
items: [
{
Expand Down
10 changes: 5 additions & 5 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #2e8555;
--ifm-color-primary-dark: #29784c;
--ifm-color-primary: #9094FBFF;
--ifm-color-primary-dark: #9094FBFF;
--ifm-color-primary-darker: #277148;
--ifm-color-primary-darkest: #205d3b;
--ifm-color-primary-light: #33925d;
Expand All @@ -19,11 +19,11 @@

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #25c2a0;
--ifm-color-primary-dark: #21af90;
--ifm-color-primary: #9094FBFF;
--ifm-color-primary-dark: #9094FBFF;
--ifm-color-primary-darker: #1fa588;
--ifm-color-primary-darkest: #1a8870;
--ifm-color-primary-light: #29d5b0;
--ifm-color-primary-light: #9094FBFF;
--ifm-color-primary-lighter: #32d8b4;
--ifm-color-primary-lightest: #4fddbf;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
Expand Down
Binary file removed static/img/docusaurus-social-card.jpg
Binary file not shown.
Binary file removed static/img/docusaurus.png
Binary file not shown.
Binary file added static/img/erc3643.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/img/favicon.ico
Binary file not shown.
Binary file added static/img/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion static/img/logo.svg

This file was deleted.

Binary file added static/img/social-card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c51bbcb

Please sign in to comment.