Update params and return types

Author: valzargaming

src/MLS/Commit/CommitInterface.php

@@ -24,7 +24,7 @@ public function getSender(): SenderInterface;
      */
     public function getProposals(): array;
 
-    public function getPath(): ?array;
+    public function getPath(): ?UpdatePathInterface;
 
     public function getSignature(): string;
 }

src/MLS/Commit/UpdatePathInterface.php

@@ -13,12 +13,14 @@
 
 namespace MLS\Commit;
 
+use MLS\Tree\LeafNodeInterface;
+
 interface UpdatePathInterface
 {
     /**
      * The leaf node presented in the path (serialized).
      */
-    public function getLeafNode(): string;
+    public function getLeafNode(): LeafNodeInterface;
 
     /**
      * Array of UpdatePathNodeInterface.

src/MLS/Credentials/CredentialInterface.php

@@ -22,4 +22,9 @@ public function getIdentity(): string;
     public function getPublicKey(): string;
 
     public function verifySignature(string $message, string $signature): bool;
+
+    /**
+     * Provide a string representation suitable for logging or use where a string is required.
+     */
+    public function __toString(): string;
 }

src/MLS/Group/GroupInfoInterface.php

@@ -13,6 +13,7 @@
 
 namespace MLS\Group;
 
+use MLS\Credentials\CredentialInterface;
 use MLS\Tree\TreeInterface;
 
 interface GroupInfoInterface
@@ -30,7 +31,7 @@ public function getConfirmedTranscriptHash(): string;
      */
     public function getExtensions(): array;
 
-    public function getSigner(): string;
+    public function getSigner(): CredentialInterface;
 
     public function verifySignature(string $signature): bool;
 }

src/MLS/Group/GroupInterface.php

@@ -17,6 +17,7 @@
 use MLS\Crypto\CipherSuiteInterface;
 use MLS\Message\MLSMessageInterface;
 use MLS\Proposal\ProposalInterface;
+use MLS\Proposal\ProposalListInterface;
 
 interface GroupInterface
 {
@@ -30,7 +31,7 @@ public function addMember(string $identity): ProposalInterface;
 
     public function removeMember(string $identity): ProposalInterface;
 
-    public function commit(array $proposals): CommitInterface;
+    public function commit(ProposalListInterface $proposals): CommitInterface;
 
     public function applyCommit(CommitInterface $commit): void;
 

src/MLS/Group/GroupMembershipInterface.php

@@ -13,15 +13,17 @@
 
 namespace MLS\Group;
 
+use MLS\Handshake\KeyPackageBundleInterface;
+
 interface GroupMembershipInterface
 {
     /**
-     * Add members to the group. Returns an array of proposal objects or identifiers to be committed.
+     * Add members to the group. Accepts a KeyPackage bundle.
      *
-     * @param  array            $keyPackages Array of KeyPackageInterface or raw key package representations
+     * @param  \MLS\Handshake\KeyPackageBundleInterface $bundle
      * @return array<int,mixed>
      */
-    public function addMembers(array $keyPackages): array;
+    public function addMembers(KeyPackageBundleInterface $bundle): array;
 
     /**
      * Remove members by identity or index. Returns proposals or identifiers.

src/MLS/MLSInterface.php

@@ -18,7 +18,7 @@
 
 interface MLSInterface
 {
-    public function createGroup(string $groupId, CipherSuiteInterface $ciphers): Group\GroupInterface;
+    public function createGroup(string $groupId, CipherSuiteInterface $ciphers): GroupInterface;
 
     public function loadGroup(string $groupId): ?GroupInterface;
 

src/MLS/Tree/TreeInterface.php

@@ -13,6 +13,8 @@
 
 namespace MLS\Tree;
 
+use MLS\Commit\UpdatePathInterface;
+
 interface TreeInterface
 {
     public function getLeafCount(): int;
@@ -29,7 +31,7 @@ public function getParent(int $index): ?ParentNodeInterface;
      * Compute the path for a leaf index.
      *
      * @param int $leafIndex
-     * @return \MLS\Commit\UpdatePathNodeInterface[]
+     * @return \MLS\Commit\UpdatePathInterface
      */
-    public function computePath(int $leafIndex): array;
+    public function computePath(int $leafIndex): UpdatePathInterface;
 }

tests/MLSInterfacesExtendedTest.php

@@ -63,7 +63,7 @@ public function testTreeComputePathDocblock(): void
         $t = new ReflectionClass('MLS\\Tree\\TreeInterface');
         $this->assertTrue($t->hasMethod('computePath'));
         $doc = $t->getMethod('computePath')->getDocComment();
-        $this->assertStringContainsString('UpdatePathNodeInterface', (string) $doc);
+        $this->assertStringContainsString('UpdatePathInterface', (string) $doc);
     }
 
     public function testGroupInfoExtensionsDoc(): void