coordinator.contributor_list.ContributorList Class Reference

Public Member Functions
def	__init__ (self, List[Contributor] contributors)
None	ensure_validity (self)
Optional[int]	get_contributor_index (self, VerificationKey verification_key)
Contributor	__getitem__ (self, int key)
int	__len__ (self)
str	to_json (self)

Static Public Member Functions
ContributorList	from_json (str json_str)

Public Attributes
	contributors

Detailed Description

Model for contributors list file

Definition at line 44 of file contributor_list.py.

Constructor & Destructor Documentation

__init__()

def coordinator.contributor_list.ContributorList.__init__	(		self,
		List[Contributor]	contributors
	)

Definition at line 48 of file contributor_list.py.

    def __init__(self, contributors: List[Contributor]):
        self.contributors = contributors
 

Member Function Documentation

__getitem__()

Contributor coordinator.contributor_list.ContributorList.__getitem__	(		self,
		int	key
	)

Definition at line 77 of file contributor_list.py.

    def __getitem__(self, key: int) -> Contributor:
        return self.contributors[key]
 

__len__()

int coordinator.contributor_list.ContributorList.__len__

(

self

)

Definition at line 80 of file contributor_list.py.

    def __len__(self) -> int:
        return len(self.contributors)
 

ensure_validity()

None coordinator.contributor_list.ContributorList.ensure_validity

(

self

)

Checks the server configuration. If there are any problems, throw an
exception with a message.

Definition at line 51 of file contributor_list.py.

    def ensure_validity(self) -> None:
        """
        Checks the server configuration. If there are any problems, throw an
        exception with a message.
        """
 
        # Evidence is expected to be the signature of
        # KEY_VALIDATION_CHECK_STRING. Check this for all the contributors
        # keys
        for contr in self.contributors:
            if not check_key_evidence(contr.verification_key, contr.key_evidence):
                raise Exception(f"Key for {contr.email} has invalid evidence")
 

Here is the call graph for this function:

from_json()

ContributorList coordinator.contributor_list.ContributorList.from_json ( str  json_str )

static

Definition at line 87 of file contributor_list.py.

    def from_json(json_str: str) -> ContributorList:
        return ContributorList._from_json_dict(json.loads(json_str))
 

get_contributor_index()

Optional[int] coordinator.contributor_list.ContributorList.get_contributor_index	(		self,
		VerificationKey	verification_key
	)

Return the index of the contributor, if present.

Definition at line 64 of file contributor_list.py.

    def get_contributor_index(
            self,
            verification_key: VerificationKey) -> Optional[int]:
        """
        Return the index of the contributor, if present.
        """
        key = export_verification_key(verification_key)
        try:
            return [export_verification_key(c.verification_key)
                    for c in self.contributors].index(key)
        except ValueError:
            return None
 

Here is the call graph for this function:

to_json()

str coordinator.contributor_list.ContributorList.to_json

(

self

)

Definition at line 83 of file contributor_list.py.

    def to_json(self) -> str:
        return json.dumps(self._to_json_dict(), indent=4)
 

Here is the call graph for this function:

Member Data Documentation

contributors

coordinator.contributor_list.ContributorList.contributors

Definition at line 49 of file contributor_list.py.

---

The documentation for this class was generated from the following file:

• /home/runner/work/zeth/zeth/mpc/coordinator/contributor_list.py