Implement avatarAddress filter for `agent` field

[Atralupus]

Currently, the Agent query only supports searches by the agent's address. However, users often need to find an agent by checking if a given avatarAddress exists in the AvatarAddresses field.

Desired Query Example:

query {
  agent(hasAvatarAddress: "166d25Df718A73861EEe8DA3495929300FB7DE71") {
    address
    object {
      avatarAddresses
    }
  }
}

Implementation Steps:

1. Update AgentRepository

Add a new method FindByAvatarAddressAsync to check if the given avatarAddress exists within the AvatarAddresses field.

example:

public async Task<AgentDocument> FindByAvatarAddressAsync(Address avatarAddress)
{
    var collectionName = CollectionNames.GetCollectionName<AgentDocument>();
    var collection = dbService.GetCollection<AgentDocument>(collectionName);

    var filter = Builders<AgentDocument>.Filter.Or(
        Builders<AgentDocument>.Filter.Eq("Object.AvatarAddresses.0", avatarAddress),
        Builders<AgentDocument>.Filter.Eq("Object.AvatarAddresses.1", avatarAddress),
        Builders<AgentDocument>.Filter.Eq("Object.AvatarAddresses.2", avatarAddress)
    );

    var document = await collection.Find(filter).FirstOrDefaultAsync();
    if (document is null)
    {
        throw new DocumentNotFoundInMongoCollectionException(
            collection.CollectionNamespace.CollectionName,
            $"'Address' equals to '{avatarAddress.ToHex()}'"
        );
    }

    return document;
}

2. Update Query

Modify the GraphQL Query class to include a parameter hasAvatarAddress and add the logic for searching using this new parameter.

example:

    public async Task<AgentState> GetAgentAsync(
        Address? address,
        Address? hasAvatarAddress,
        [Service] AgentRepository repo
    )
    {
        if (address is not null)
        {
            return (await repo.GetByAddressAsync(address.Value)).Object;
        }
        else if (hasAvatarAddress is not null)
        {
            var agent = await repo.FindByAvatarAddressAsync(hasAvatarAddress.Value);
            if (agent is null)
            {
                throw new ArgumentException($"No agent found with avatarAddress: {hasAvatarAddress}");
            }
            return agent.Object;
        }
        else
        {
            throw new ArgumentException("Either address or hasAvatarAddress must be provided.");
        }
    }

3. Setup Local Database

• Refer to CONTRIBUTING.md: Follow the setup instructions in the repository to initialize a local database for Mimir.

• Populate the Database:

  • Example agent document for testing:

    {
    "_id": "d6fc96D36A65bd2a6e4aA1991E32DF0E844d0d21",
    "Metadata": {
    "SchemaVersion": 1,
    "StoredBlockIndex": 0
    },
    "Object": {
    "AvatarAddresses": {
      "0": "166d25Df718A73861EEe8DA3495929300FB7DE71",
      "1": "123d25Df718A73861EEe8DA3495929300FB7DE72"
    },
    "MonsterCollectionRound": 0,
    "Version": 1,
    "Address": "d6fc96D36A65bd2a6e4aA1991E32DF0E844d0d21"
    }
    }

  • Import this data into the agent

4. Test Cases

• Query by hasAvatarAddress:

  query {
  agent(hasAvatarAddress: "166d25Df718A73861EEe8DA3495929300FB7DE71") {
    address
    object {
      avatarAddresses
    }
  }
  }

• Expected Result:

  {
  "data": {
    "agent": {
      "address": "d6fc96D36A65bd2a6e4aA1991E32DF0E844d0d21",
      "object": {
        "avatarAddresses": {
          "0": "166d25Df718A73861EEe8DA3495929300FB7DE71",
          "1": "123d25Df718A73861EEe8DA3495929300FB7DE72"
        }
      }
    }
  }
  }