1 of 6

Group Avatars

To create a group following the ERC1155 standard, which allows you to utilize personal tokens as a collateral and mint group tokens, you would require to call the following function.

Your wallet should not have been signed up as a different avatar and once connected to SDK would be registered as s a group avatar in Circles v2.

Creation of groups

You need to pass the profile and the address of the mint policy contract when calling the function.


import { GroupProfile, Profile, Profiles } from '@circles-sdk/profiles';

// When on Gnosis Chain use this ..
// const standardMintPolicy = "0x5Ea08c967C69255d82a4d26e36823a720E7D0317";

// When on Chiado use that ..
// const standardMintPolicy = "0xaD49f877021c73d00bE142b135c9AA67f0D8e9c6";

const mintPolicy = '0xYourMintPolicyContractAddress';
const groupProfile: GroupProfile = {
    name: 'Group Namw',
    symbol: 'Group Token Symbol',
    description: '',
    previewImageUrl: '',
    imageUrl: '',
    
    
};
const GroupAvatar = await circlesSDK?.registerGroupV2(mintPolicy, profile);

// Log the newly created group avatar details
console.log('New Group Avatar:', GroupAvatar);

There are some limits from the profile service:

Profile Name Length:

The maximum allowed length for profile names is 36 characters (config.maxNameLength). This is enforced in the validateProfile function, where it checks if the name exceeds this limit.

Profile Description Length:

The maximum allowed length for descriptions is 500 characters (config.descriptionLength), and the validateProfile function checks this.

Image URL Length:

The maximum allowed length for image URLs is 2000 characters (config.imageUrlLength), validated in the same function.

Image Validation:

The code limits image size to 150 KB (config.maxImageSizeKB), and images must be exactly 256x256 pixels (config.imageDimension).
The supported image formats are PNG, JPEG, and GIF.

Circles Profile specs

Incase, you want to check how to manage circles profiles, you can simply checkout this guide :

Setting Circles Profiles

Mint group tokens

This method allows a group to mint new Group Circles using trusted collateral tokens. The group specifies which collateral to use and the corresponding amounts.

groupMint: (
    group: string, 
    collateral: string[], 
    amounts: bigint[], 
    // data: Uint8Array                                         optional
) => Promise<ContractTransactionReceipt>;


const groupAddress = '0xYourGroupAddress'; // The address of the group
const collateralTokens = ['0xToken1', '0xToken2']; 
// Addresses of the collateral tokens
const collateralAmounts = [BigInt(1000), BigInt(2000)]; 
// Corresponding amounts for each token

try {
    const receipt = await circles.groupMint(groupAddress, collateralTokens, collateralAmounts);

    console.log('Minting successful:', receipt);
} catch (error) {
    console.error('Minting failed:', error);

Managing group invites

To invite group members, you need to trust them. Trusting them would simply mean that you are inviting them to join group and would be accepting their personal token as collateral. Now, once invited, a group member will require to trust the group avatar address so that they can mint the group tokens.

Invitation to the group

const trustReceipt = await groupAvatar.trust("AvatarAddress");
console.log(receipt);

Removal of the member from the group

const trustReceipt = await groupAvatar.untrust("AvatarAddress");
console.log(receipt);

Find groups and memberships

You would be requiring to initialize the Circles data property to find groups and get memberships.

const data = sdk.data

Otherwise you can create an instance like this:

const circlesRpc = new CirclesRpc("https://chiado-rpc.aboutcircles.com");
const data = new CirclesData(circlesRpc);

Find Groups

Functionality: This method allows you to fetch a list of groups from the Circles system, with options for pagination and filtering. This is useful for applications that need to display groups or for querying specific groups based on certain criteria.
Parameters:
- pageSize: A number specifying how many groups should be returned in the response.
- params: An optional parameter that can include various filters for the query, such as group types or statuses.

const groupsPageSize = 10; // Define the maximum number of groups to return
const queryParams = { /* Example filter parameters */ };

try {
    const groupsQueryResult = await circles.data.findGroups(groupsPageSize, queryParams);
    console.log('Retrieved groups:', groupsQueryResult);
} catch (error) {
    console.error('Error fetching groups:', error);
}

Get group memberships

This method is designed to fetch all group memberships associated with a specific avatar. This is useful for applications that want to display or manage the groups that a user belongs to.

Parameters:

avatar: A string representing the address of the avatar for which group memberships are being requested.
pageSize: A number that specifies the maximum number of group memberships to return.

const avatarAddress = '0xYourAvatarAddress'; 
// The address of the avatar
const membershipsPageSize = 5; 
// Define the maximum number of memberships to return

try {
    const membershipsQueryResult = await circles.getGroupMemberships(avatarAddress, membershipsPageSize);
    console.log('Retrieved group memberships:', membershipsQueryResult);
} catch (error) {
    console.error('Error fetching group memberships:', error);
}

Getting total supply of group tokens available

This method retrieves the total amount of Circles associated with the avatar, which can be either Personal Circles or Group Circles, depending on the calling context.

getTotalSupply: () => Promise<bigint>;

// Example of calling the getTotalSupply method
try {
    const totalSupply = await circles.getTotalSupply();
    console.log('Total Circles Supply:', totalSupply.toString());
} catch (error) {
    console.error('Error fetching total supply:', error);
}