Graph
Last updated
Was this helpful?
Last updated
Was this helpful?
The Graph ADO allows users to construct a customized graphs. The user first specifies the configurations of the graph at instantiation. Then they are able to store coordinates for points on the graph. These saved points can then be fetched by using the ADO's queries.
The graph can be a 3D graph (x,y, and z coordinates) or a 2D graph (x,y coordinates only).
This ADO can also save and fetch points stored in the .
Ado_type: graph
Version: 0.1.0
map_info
Specifies the configurations of the map.
kernel_address
String
owner
Option<String>
Optional address to specify as the owner of the ADO being created. Defaults to the sender if not specified.
map_size
Specifies the size of the map.
allow_negative
bool
Whether negative values can be assigned to points of the map. In case negative is allowed, the width of the axis is divided between the positive and negative halfs. For example if negative is allowed and the x_width
is set as 1000, then the the x coordinate range is between -500 and 500.
map_decimal
u16
The max number of decimal points that can be specified for a point. For example, if the x_coordinate
is set as 4.12345 and the map_decimal
is set as 2, then the x coordinate is taken as 4.12 only.
x_width
u64
The maximum allowed x coordinate for the map.
y_width
u64
The maximum allowed y coordinate for the map.
z_width
Option<u64>
The maximum allowed z coordinate for the map. Can be ommited in case a 2D map is wanted by the user.
Update the map configurations set at instantiation.
Only available to the contract owner.
map_info
Specifies the configurations of the map.
Stores the coordinates of a point on the map.
Only available to the contract owner.
coordinate
The coordinates of the point.
is_timestamp_allowed
bool
Whether to store the timestamp that the point was created. If yes, then it would show along with the coordinates when queried.
x_coordinate
SignedDecimal
The x coordinate for the point.
y_coordinate
SignedDecimal
The y coordinate for the point.
z_coordinate
Option<SignedDecimal>
The z coordinate for the point. Do not specify in case the map is 2D (Only x and y).
If the coordinates of the point ADO are changed, you need to call this message again on that Point ADO to store the new coordinates.
user_location_paths
Vec<AndrAddr>
A vector containing the addresses of the point ADOs.
user
AndrAddr
The Point ADO contract address to remove.
Queries the map configurations set at instantiation.
Queries the total number of points created.
max_point
u128
The total number of points created on the graph.
Queries all the created points, fetching their coordinates and timestamps if enabled.
start
Option<u128>
Optional point to start from. Used for pagination.
limit
Option<u32>
Optional limit on the number of results to return. Used for pagination.
Returns a vector containing the coordinates of each point. Points that had timestamp enabled will have the timestamp returned as well.
Fetches the coordinate saved for the specified Point ADO.
user
AndrAddr
The address of the user who set the coordinates in the point ADO.
Contract address of the to be used for messaging. Kernel contract address can be found in our .
Store the coordinates from the specified addresses.
Deletes the coordinate set for the specified point in the.
The rest of the execute messages can be found in the section.
Returns a struct.
Returns an instance of .
The rest of the query messages can be found in the section.