Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(torii): retrieve controllers & usernames graphql and grpc #2992

Merged
merged 5 commits into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions crates/torii/graphql/src/constants.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ pub const EVENT_MESSAGE_TABLE: &str = "event_messages";
pub const MODEL_TABLE: &str = "models";
pub const TRANSACTION_TABLE: &str = "transactions";
pub const METADATA_TABLE: &str = "metadata";
pub const CONTROLLER_TABLE: &str = "controllers";

pub const ID_COLUMN: &str = "id";
pub const EVENT_ID_COLUMN: &str = "event_id";
Expand Down Expand Up @@ -64,3 +65,6 @@ pub const TOKEN_TRANSFER_NAME: (&str, &str) = ("", "tokenTransfers");
pub const ORDER_DIR_TYPE_NAME: &str = "OrderDirection";
pub const ORDER_ASC: &str = "ASC";
pub const ORDER_DESC: &str = "DESC";

pub const CONTROLLER_TYPE_NAME: &str = "World__Controller";
pub const CONTROLLER_NAMES: (&str, &str) = ("controller", "controllers");
9 changes: 9 additions & 0 deletions crates/torii/graphql/src/mapping.rs
Original file line number Diff line number Diff line change
Expand Up @@ -177,4 +177,13 @@ lazy_static! {
(Name::new("imagePath"), TypeData::Simple(TypeRef::named_nn(TypeRef::STRING))),
]);

pub static ref CONTROLLER_MAPPING: TypeMapping = IndexMap::from([
(Name::new("id"), TypeData::Simple(TypeRef::named(TypeRef::ID))),
(Name::new("username"), TypeData::Simple(TypeRef::named_nn(TypeRef::STRING))),
(Name::new("address"), TypeData::Simple(TypeRef::named_nn(TypeRef::STRING))),
(
Name::new("deployedAt"),
TypeData::Simple(TypeRef::named_nn(GraphqlType::DateTime.to_string())),
),
]);
}
45 changes: 45 additions & 0 deletions crates/torii/graphql/src/object/controller.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
use async_graphql::dynamic::Field;

use super::{BasicObject, ResolvableObject, TypeMapping};
use crate::constants::{CONTROLLER_NAMES, CONTROLLER_TABLE, CONTROLLER_TYPE_NAME, ID_COLUMN};
use crate::mapping::CONTROLLER_MAPPING;
use crate::object::{resolve_many, resolve_one};

#[derive(Debug)]
pub struct ControllerObject;

impl BasicObject for ControllerObject {
fn name(&self) -> (&str, &str) {
CONTROLLER_NAMES
}

fn type_name(&self) -> &str {
CONTROLLER_TYPE_NAME
}

fn type_mapping(&self) -> &TypeMapping {
&CONTROLLER_MAPPING
}
}

impl ResolvableObject for ControllerObject {
fn resolvers(&self) -> Vec<Field> {
let resolve_one = resolve_one(
CONTROLLER_TABLE,
ID_COLUMN,
self.name().0,
self.type_name(),
self.type_mapping(),
);

let resolve_many = resolve_many(
CONTROLLER_TABLE,
ID_COLUMN,
self.name().1,
self.type_name(),
self.type_mapping(),
);

vec![resolve_one, resolve_many]
}
}
1 change: 1 addition & 0 deletions crates/torii/graphql/src/object/mod.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
pub mod connection;
pub mod controller;
pub mod entity;
pub mod erc;
pub mod event;
Expand Down
2 changes: 2 additions & 0 deletions crates/torii/graphql/src/schema.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ use super::utils;
use crate::constants::{
ERC20_TYPE_NAME, ERC721_TYPE_NAME, QUERY_TYPE_NAME, SUBSCRIPTION_TYPE_NAME, TOKEN_TYPE_NAME,
};
use crate::object::controller::ControllerObject;
use crate::object::erc::erc_token::{Erc20TokenObject, Erc721TokenObject};
use crate::object::erc::token_balance::ErcBalanceObject;
use crate::object::erc::token_transfer::ErcTransferObject;
Expand Down Expand Up @@ -121,6 +122,7 @@ async fn build_objects(pool: &SqlitePool) -> Result<(Vec<ObjectVariant>, Vec<Uni
ObjectVariant::Resolvable(Box::new(TransactionObject)),
ObjectVariant::Resolvable(Box::new(ErcBalanceObject)),
ObjectVariant::Resolvable(Box::new(ErcTransferObject)),
ObjectVariant::Resolvable(Box::new(ControllerObject)),
ObjectVariant::Basic(Box::new(SocialObject)),
ObjectVariant::Basic(Box::new(ContentObject)),
ObjectVariant::Basic(Box::new(PageInfoObject)),
Expand Down
6 changes: 6 additions & 0 deletions crates/torii/grpc/proto/types.proto
Original file line number Diff line number Diff line change
Expand Up @@ -185,4 +185,10 @@ message OrderBy {
enum OrderDirection {
ASC = 0;
DESC = 1;
}

message Controller {
bytes address = 1;
string username = 2;
uint64 deployed_at_timestamp = 3;
}
11 changes: 11 additions & 0 deletions crates/torii/grpc/proto/world.proto
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,17 @@ service World {

// Retrieve token balances
rpc RetrieveTokenBalances (RetrieveTokenBalancesRequest) returns (RetrieveTokenBalancesResponse);

// Retrieve controllers
rpc RetrieveControllers (RetrieveControllersRequest) returns (RetrieveControllersResponse);
}

message RetrieveControllersRequest {
repeated bytes contract_addresses = 1;
}

message RetrieveControllersResponse {
repeated types.Controller controllers = 1;
}

// A request to update a token balance subscription
Expand Down
62 changes: 56 additions & 6 deletions crates/torii/grpc/src/server/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,13 @@
use crate::proto::types::LogicalOperator;
use crate::proto::world::world_server::WorldServer;
use crate::proto::world::{
RetrieveEntitiesStreamingResponse, RetrieveEventMessagesRequest, RetrieveTokenBalancesRequest,
RetrieveTokenBalancesResponse, RetrieveTokensRequest, RetrieveTokensResponse,
SubscribeEntitiesRequest, SubscribeEntityResponse, SubscribeEventMessagesRequest,
SubscribeEventsResponse, SubscribeIndexerRequest, SubscribeIndexerResponse,
SubscribeTokenBalancesResponse, UpdateEventMessagesSubscriptionRequest,
UpdateTokenBalancesSubscriptionRequest, WorldMetadataRequest, WorldMetadataResponse,
RetrieveControllersRequest, RetrieveControllersResponse, RetrieveEntitiesStreamingResponse,
RetrieveEventMessagesRequest, RetrieveTokenBalancesRequest, RetrieveTokenBalancesResponse,
RetrieveTokensRequest, RetrieveTokensResponse, SubscribeEntitiesRequest,
SubscribeEntityResponse, SubscribeEventMessagesRequest, SubscribeEventsResponse,
SubscribeIndexerRequest, SubscribeIndexerResponse, SubscribeTokenBalancesResponse,
UpdateEventMessagesSubscriptionRequest, UpdateTokenBalancesSubscriptionRequest,
WorldMetadataRequest, WorldMetadataResponse,
};
use crate::proto::{self};
use crate::types::schema::SchemaError;
Expand Down Expand Up @@ -1042,6 +1043,38 @@
.add_subscriber(clause.into_iter().map(|keys| keys.into()).collect())
.await
}

async fn retrieve_controllers(
&self,
contract_addresses: Vec<Felt>,
) -> Result<proto::world::RetrieveControllersResponse, Error> {
let query = if contract_addresses.is_empty() {
"SELECT address, username, deployed_at FROM controllers".to_string()

Check warning on line 1052 in crates/torii/grpc/src/server/mod.rs

View check run for this annotation

Codecov / codecov/patch

crates/torii/grpc/src/server/mod.rs#L1047-L1052

Added lines #L1047 - L1052 were not covered by tests
} else {
format!(
"SELECT address, username, deployed_at FROM controllers WHERE address IN ({})",
contract_addresses.iter().map(|_| "?".to_string()).collect::<Vec<_>>().join(", ")
)

Check warning on line 1057 in crates/torii/grpc/src/server/mod.rs

View check run for this annotation

Codecov / codecov/patch

crates/torii/grpc/src/server/mod.rs#L1054-L1057

Added lines #L1054 - L1057 were not covered by tests
};

let mut db_query = sqlx::query_as::<_, (String, String, u64)>(&query);
Larkooo marked this conversation as resolved.
Show resolved Hide resolved
for address in &contract_addresses {
db_query = db_query.bind(format!("{:#x}", address));
}

Check warning on line 1063 in crates/torii/grpc/src/server/mod.rs

View check run for this annotation

Codecov / codecov/patch

crates/torii/grpc/src/server/mod.rs#L1060-L1063

Added lines #L1060 - L1063 were not covered by tests

let rows = db_query.fetch_all(&self.pool).await?;

Check warning on line 1065 in crates/torii/grpc/src/server/mod.rs

View check run for this annotation

Codecov / codecov/patch

crates/torii/grpc/src/server/mod.rs#L1065

Added line #L1065 was not covered by tests

let controllers = rows
.into_iter()
.map(|(address, username, deployed_at)| proto::types::Controller {
address: address.parse::<Felt>().unwrap().to_bytes_be().to_vec(),
username,
deployed_at_timestamp: deployed_at,
Larkooo marked this conversation as resolved.
Show resolved Hide resolved
})
.collect();

Ok(RetrieveControllersResponse { controllers })
}

Check warning on line 1077 in crates/torii/grpc/src/server/mod.rs

View check run for this annotation

Codecov / codecov/patch

crates/torii/grpc/src/server/mod.rs#L1067-L1077

Added lines #L1067 - L1077 were not covered by tests
}

fn process_event_field(data: &str) -> Result<Vec<Vec<u8>>, Error> {
Expand Down Expand Up @@ -1271,6 +1304,23 @@
Ok(Response::new(WorldMetadataResponse { metadata }))
}

async fn retrieve_controllers(
&self,
request: Request<RetrieveControllersRequest>,
) -> Result<Response<RetrieveControllersResponse>, Status> {
let RetrieveControllersRequest { contract_addresses } = request.into_inner();
let contract_addresses = contract_addresses
.iter()
.map(|address| Felt::from_bytes_be_slice(address))
.collect::<Vec<_>>();

Check warning on line 1315 in crates/torii/grpc/src/server/mod.rs

View check run for this annotation

Codecov / codecov/patch

crates/torii/grpc/src/server/mod.rs#L1310-L1315

Added lines #L1310 - L1315 were not covered by tests

let controllers = self
.retrieve_controllers(contract_addresses)
.await
.map_err(|e| Status::internal(e.to_string()))?;
Ok(Response::new(controllers))
}

Check warning on line 1322 in crates/torii/grpc/src/server/mod.rs

View check run for this annotation

Codecov / codecov/patch

crates/torii/grpc/src/server/mod.rs#L1317-L1322

Added lines #L1317 - L1322 were not covered by tests

async fn retrieve_tokens(
&self,
request: Request<RetrieveTokensRequest>,
Expand Down
Loading